NAV Navigation
OSC CLI Shell

DirectLink API 2012-10-25

The DirectLink API enables you to connect your infrastructure to the OUTSCALE Cloud through a physical, dedicated network link.
It is compliant with the Direct Connect API of Amazon Web Services (AWS). See the AWS Compatibility Matrix.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

Base URLs:

Terms of service. Email: support@outscale.com. License: BSD 3 Clause.

Authentication Schemes

Access Key/Secret Key

The main way to authenticate your requests to this API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in Signature of API Requests.

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.

For example, if you use OSC CLI:

  1. You need to create an ~/.osc/config.json file to specify your access key, secret key, and the Region of your account.
  2. You then specify the --profile option when executing OSC CLI commands.

For more information, see Installing and Configuring OSC CLI.

See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see About Access Keys.

Other Security Mechanisms

In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see Managing Your API Accesses.

Connection

CreateConnection

POST /CreateConnection

Creates a DirectLink connection between a customer network and a specified DirectLink location.

For more information, see About DirectLink.
This AWS-compliant method corresponds to CreateDirectLink in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli directlink CreateConnection --profile "default" \
  --bandwidth "1Gbps" \
  --connectionName "string" \
  --dryRun False \
  --location "string"


# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://directlink.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: OvertureService.CreateConnection' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "bandwidth": "1Gbps",
    "connectionName": "string",
    "dryRun": false,
    "location": "string"
  }'

Available Parameters

Name Type Required Description
bandwidth string true The bandwidth of the connection (1Gbps | 10Gbps).
connectionName string true The name of the connection.
dryRun boolean false If true, checks whether you have the required permissions to perform the action.
location string true The code of the requested location for the connection, returned by the DescribeLocations method.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ConnectionResponse

Example responses

200 Response

{
  "awsDevice": "string",
  "bandwidth": "string",
  "connectionId": "string",
  "connectionName": "string",
  "connectionState": "string",
  "lagId": "string",
  "loaIssueTime": "string",
  "location": "string",
  "ownerAccount": "string",
  "partnerName": "string",
  "region": "string",
  "requestId": "string",
  "vlan": 0
}

DeleteConnection

POST /DeleteConnection

Deletes a specified DirectLink connection.
Before deleting a connection, ensure that all your virtual interfaces related to this connection are deleted.

This AWS-compliant method corresponds to DeleteDirectLink in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli directlink DeleteConnection --profile "default" \
  --connectionId "string" \
  --dryRun False


# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://directlink.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: OvertureService.DeleteConnection' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "connectionId": "string",
    "dryRun": false
  }'

Available Parameters

Name Type Required Description
connectionId string true The ID of the DirectLink connection you want to delete.
dryRun boolean false If true, checks whether you have the required permissions to perform the action.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ConnectionResponse

Example responses

200 Response

{
  "awsDevice": "string",
  "bandwidth": "string",
  "connectionId": "string",
  "connectionName": "string",
  "connectionState": "string",
  "lagId": "string",
  "loaIssueTime": "string",
  "location": "string",
  "ownerAccount": "string",
  "partnerName": "string",
  "region": "string",
  "requestId": "string",
  "vlan": 0
}

DescribeConnections

POST /DescribeConnections

Describes all DirectLink connections in the Region.
You can use the ConnectionId parameter to only describe a specified connection.

This AWS-compliant method corresponds to ReadDirectLinks in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli directlink DescribeConnections --profile "default" \
  --connectionId "string" \
  --dryRun False


# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://directlink.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: OvertureService.DescribeConnections' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "connectionId": "string",
    "dryRun": false
  }'

Available Parameters

Name Type Required Description
connectionId string false The ID of a DirectLink connection.
dryRun boolean false If true, checks whether you have the required permissions to perform the action.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeConnectionsResponse

Example responses

200 Response

{
  "connections": [
    {
      "awsDevice": "string",
      "bandwidth": "string",
      "connectionId": "string",
      "connectionName": "string",
      "connectionState": "string",
      "lagId": "string",
      "loaIssueTime": "string",
      "location": "string",
      "ownerAccount": "string",
      "partnerName": "string",
      "region": "string",
      "vlan": 0
    }
  ],
  "requestId": "string"
}

Site

DescribeLocations

POST /DescribeLocations

Describes the locations, corresponding to datacenters, where you can set up a DirectLink connection.

For more information, see About DirectLink.
This AWS-compliant method corresponds to ReadLocations in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli directlink DescribeLocations --profile "default" \
  --DryRun False


# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://directlink.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: OvertureService.DescribeLocations' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "DryRun": false
  }'

Available Parameters

Name Type Required Description
DryRun boolean false If true, checks whether you have the required permissions to perform the action.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeLocationsResponse

Example responses

200 Response

{
  "locations": [
    {
      "locationCode": "string",
      "locationName": "string"
    }
  ],
  "requestId": "string"
}

VirtualInterfaces

AllocatePrivateVirtualInterface

POST /AllocatePrivateVirtualInterface

Creates a private virtual interface whose owner is another account.
The other account then needs to confirm the virtual interface using the ConfirmPrivateVirtualInterface method.
Until this confirmation, the virtual interface remains in the confirming state and cannot handle traffic.
Otherwise, if the other user does not confirm it within 7 days, the state of the virtual interface becomes expired, and you need to create a virtual interface again.

This AWS-compliant method corresponds to CreateDirectLinkInterface in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli directlink AllocatePrivateVirtualInterface --profile "default" \
  --connectionId "string" \
  --dryRun False \
  --newPrivateVirtualInterfaceAllocation '{
      "amazonAddress": "string",
      "asn": "0",
      "authKey": "string",
      "customerAddress": "string",
      "virtualInterfaceName": "string",
      "vlan": 0,
    }' \
  --ownerAccount "string"


# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://directlink.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: OvertureService.AllocatePrivateVirtualInterface' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "connectionId": "string",
    "dryRun": false,
    "newPrivateVirtualInterfaceAllocation": {
      "amazonAddress": "string",
      "asn": "0",
      "authKey": "string",
      "customerAddress": "string",
      "virtualInterfaceName": "string",
      "vlan": 0
    },
    "ownerAccount": "string"
  }'

Available Parameters

Name Type Required Description
connectionId string true The ID of the existing DirectLink connection for which you want to create the private virtual interface.
dryRun boolean false If true, checks whether you have the required permissions to perform the action.
newPrivateVirtualInterfaceAllocation NewPrivateVirtualInterfaceAllocation true Detailed information about the configuration parameters of the private virtual interface.
» amazonAddress string false If provided, the IP to set on the OUTSCALE side of the virtual interface. This IP must include a network prefix (for example, 172.16.0.1/30).
» asn integer true The autonomous system (AS) number for the Border Gateway Protocol (BGP) configuration on the customer side of the virtual interface.
» authKey string false The BGP authentication key.
» customerAddress string false The IP on the customer side of the virtual interface. This IP must be provided if the amazonAddress parameter is provided, and be in the same network subnet.
» virtualInterfaceName string true The name of the virtual interface.
» vlan integer true The unique VLAN ID for the virtual interface. This number must be unique and be between 2 and 4094.
ownerAccount string true The account ID of the owner of the private virtual interface.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). PrivateVirtualInterfaceResponse

Example responses

200 Response

{
  "addressFamily": "string",
  "amazonAddress": "string",
  "amazonSideAsn": 0,
  "asn": 0,
  "authKey": "string",
  "bgpPeers": [
    {
      "addressFamily": "string",
      "amazonAddress": "string",
      "asn": 0,
      "authKey": "string",
      "bgpPeerState": "string",
      "bgpStatus": "string",
      "customerAddress": "string"
    }
  ],
  "connectionId": "string",
  "customerAddress": "string",
  "customerRouterConfig": "string",
  "directConnectGatewayId": "string",
  "location": "string",
  "ownerAccount": "string",
  "requestId": "string",
  "routeFilterPrefixes": [
    {
      "cidr": "string"
    }
  ],
  "virtualGatewayId": "string",
  "virtualInterfaceId": "string",
  "virtualInterfaceName": "string",
  "virtualInterfaceState": "string",
  "virtualInterfaceType": "string",
  "vlan": 0
}

ConfirmPrivateVirtualInterface

POST /ConfirmPrivateVirtualInterface

Accepts another user's request to create a private virtual interface in your account.
Once you use this method to confirm the request, the virtual interface is created, attached to the specified virtual private gateway, and available for handling traffic.

OSC CLI Shell

Code samples

osc-cli directlink ConfirmPrivateVirtualInterface --profile "default" \
  --dryRun False \
  --virtualGatewayId "string" \
  --virtualInterfaceId "string"


# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://directlink.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: OvertureService.ConfirmPrivateVirtualInterface' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "dryRun": false,
    "virtualGatewayId": "string",
    "virtualInterfaceId": "string"
  }'

Available Parameters

Name Type Required Description
dryRun boolean false If true, checks whether you have the required permissions to perform the action.
virtualGatewayId string true The ID of the target virtual private gateway.
virtualInterfaceId string true The ID of the virtual interface.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ConfirmPrivateVirtualInterfaceResponse

Example responses

200 Response

{
  "requestId": "string",
  "virtualInterfaceState": "string"
}

CreatePrivateVirtualInterface

POST /CreatePrivateVirtualInterface

Creates a private virtual interface.
Private virtual interfaces enable you to reach one of your Virtual Private Clouds (VPCs) through a virtual private gateway.

For more information, see About DirectLink.
This AWS-compliant method corresponds to CreateDirectLinkInterface in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli directlink CreatePrivateVirtualInterface --profile "default" \
  --connectionId "string" \
  --dryRun False \
  --newPrivateVirtualInterface '{
      "amazonAddress": "string",
      "asn": "0",
      "authKey": "string",
      "customerAddress": "string",
      "virtualGatewayId": "string",
      "virtualInterfaceName": "string",
      "vlan": 0,
    }'


# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://directlink.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: OvertureService.CreatePrivateVirtualInterface' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "connectionId": "string",
    "dryRun": false,
    "newPrivateVirtualInterface": {
      "amazonAddress": "string",
      "asn": "0",
      "authKey": "string",
      "customerAddress": "string",
      "virtualGatewayId": "string",
      "virtualInterfaceName": "string",
      "vlan": 0
    }
  }'

Available Parameters

Name Type Required Description
connectionId string true The ID of the existing DirectLink connection for which you want to create the private virtual interface.
dryRun boolean false If true, checks whether you have the required permissions to perform the action.
newPrivateVirtualInterface NewPrivateVirtualInterface true Detailed information about the configuration parameters of the private virtual interface.
» amazonAddress string false If provided, the IP to set on the OUTSCALE side of the virtual interface. This IP must include a network prefix (for example 172.16.0.1/30).
» asn integer true The autonomous system number (ASN) for the Border Gateway Protocol (BGP) configuration on the customer side of the virtual interface. This number must be between 64512 and 65534.
» authKey string false The BGP authentication key.
» customerAddress string false The IP on the customer side of the virtual interface. This IP must be provided if the amazonAddress parameter is provided, and be in the same network subnet.
» virtualGatewayId string false The target virtual private gateway.
» virtualInterfaceName string true The name of the virtual interface.
» vlan integer true The unique VLAN ID for the virtual interface. This number must be unique and be between 2 and 4094.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). PrivateVirtualInterfaceResponse

Example responses

200 Response

{
  "addressFamily": "string",
  "amazonAddress": "string",
  "amazonSideAsn": 0,
  "asn": 0,
  "authKey": "string",
  "bgpPeers": [
    {
      "addressFamily": "string",
      "amazonAddress": "string",
      "asn": 0,
      "authKey": "string",
      "bgpPeerState": "string",
      "bgpStatus": "string",
      "customerAddress": "string"
    }
  ],
  "connectionId": "string",
  "customerAddress": "string",
  "customerRouterConfig": "string",
  "directConnectGatewayId": "string",
  "location": "string",
  "ownerAccount": "string",
  "requestId": "string",
  "routeFilterPrefixes": [
    {
      "cidr": "string"
    }
  ],
  "virtualGatewayId": "string",
  "virtualInterfaceId": "string",
  "virtualInterfaceName": "string",
  "virtualInterfaceState": "string",
  "virtualInterfaceType": "string",
  "vlan": 0
}

DeleteVirtualInterface

POST /DeleteVirtualInterface

Deletes a specified virtual interface.

This AWS-compliant method corresponds to DeleteDirectLinkInterface in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli directlink DeleteVirtualInterface --profile "default" \
  --dryRun False \
  --virtualInterfaceId "string"


# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://directlink.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: OvertureService.DeleteVirtualInterface' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "dryRun": false,
    "virtualInterfaceId": "string"
  }'

Available Parameters

Name Type Required Description
dryRun boolean false If true, checks whether you have the required permissions to perform the action.
virtualInterfaceId string true The ID of the virtual interface you want to delete.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteVirtualInterfaceResponse

Example responses

200 Response

{
  "requestId": "string",
  "virtualInterfaceState": "string"
}

DescribeVirtualGateways

POST /DescribeVirtualGateways

Returns a list of your virtual gateways that can be used as a target by a private virtual interface.

This AWS-compliant method corresponds to ReadVirtualGateways in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli directlink DescribeVirtualGateways --profile "default" \
  --DryRun False


# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://directlink.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: OvertureService.DescribeVirtualGateways' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "DryRun": false
  }'

Available Parameters

Name Type Required Description
DryRun boolean false If true, checks whether you have the required permissions to perform the action.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeVirtualGatewaysResponse

Example responses

200 Response

{
  "requestId": "string",
  "virtualGateways": [
    {
      "virtualGatewayId": "string",
      "virtualGatewayState": "string"
    }
  ]
}

DescribeVirtualInterfaces

POST /DescribeVirtualInterfaces

Describes one or more of your virtual interfaces.
You can use the connectionId parameter to describe virtual interfaces associated with a specified connection, or the VirtualInterfaceId parameter to describe a specified virtual interface.

This AWS-compliant method corresponds to ReadDirectLinkInterfaces in the OUTSCALE API.

OSC CLI Shell

Code samples

osc-cli directlink DescribeVirtualInterfaces --profile "default" \
  --connectionId "string" \
  --dryRun False \
  --virtualInterfaceId "string"


# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://directlink.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --header 'x-amz-target: OvertureService.DescribeVirtualInterfaces' \
  --header 'Content-Type: application/x-amz-json-1.1' \
  --data '{
    "connectionId": "string",
    "dryRun": false,
    "virtualInterfaceId": "string"
  }'

Available Parameters

Name Type Required Description
connectionId string false The ID of a DirectLink connection.
dryRun boolean false If true, checks whether you have the required permissions to perform the action.
virtualInterfaceId string false The ID of a virtual interface.

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DescribeVirtualInterfacesResponse

Example responses

200 Response

{
  "requestId": "string",
  "virtualInterfaces": [
    {
      "addressFamily": "string",
      "amazonAddress": "string",
      "amazonSideAsn": 0,
      "asn": 0,
      "authKey": "string",
      "bgpPeers": [
        {
          "addressFamily": "string",
          "amazonAddress": "string",
          "asn": 0,
          "authKey": "string",
          "bgpPeerState": "string",
          "bgpStatus": "string",
          "customerAddress": "string"
        }
      ],
      "connectionId": "string",
      "customerAddress": "string",
      "customerRouterConfig": "string",
      "directConnectGatewayId": "string",
      "location": "string",
      "ownerAccount": "string",
      "routeFilterPrefixes": [
        {
          "cidr": "string"
        }
      ],
      "virtualGatewayId": "string",
      "virtualInterfaceId": "string",
      "virtualInterfaceName": "string",
      "virtualInterfaceState": "string",
      "virtualInterfaceType": "string",
      "vlan": 0
    }
  ]
}

Schemas

BgpPeer

This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.

Properties

Name Type Description
addressFamily string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
amazonAddress string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
asn integer This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
authKey string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
bgpPeerState string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
bgpStatus string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
customerAddress string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.

Schema

{
  "addressFamily": "string",
  "amazonAddress": "string",
  "asn": 0,
  "authKey": "string",
  "bgpPeerState": "string",
  "bgpStatus": "string",
  "customerAddress": "string"
}

ConfirmPrivateVirtualInterfaceResponse

Properties

Name Type Description
requestId string The ID of the request.
virtualInterfaceState string The state of the virtual interface (always pending).

Schema

{
  "requestId": "string",
  "virtualInterfaceState": "string"
}

Connection

Information about a DirectLink connection.
Connection states are:

Properties

Name Type Description
awsDevice string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
bandwidth string The physical link bandwidth (either 1Gbps or 10Gbps).
connectionId string The ID of the connection (for example, dxcon-xxxxxxxx).
connectionName string The name of the connection.
connectionState string The state of the connection.
lagId string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
loaIssueTime string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
location string The datacenter where the connection is located.
ownerAccount string The account ID of the owner of the connection.
partnerName string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
region string The Region in which the connection has been created.
vlan integer This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.

Schema

{
  "awsDevice": "string",
  "bandwidth": "string",
  "connectionId": "string",
  "connectionName": "string",
  "connectionState": "string",
  "lagId": "string",
  "loaIssueTime": "string",
  "location": "string",
  "ownerAccount": "string",
  "partnerName": "string",
  "region": "string",
  "vlan": 0
}

ConnectionResponse

Properties

Name Type Description
awsDevice string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
bandwidth string The physical link bandwidth (either 1Gbps or 10Gbps).
connectionId string The ID of the connection (for example, dxcon-xxxxxxxx).
connectionName string The name of the connection.
connectionState string The state of the connection.
lagId string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
loaIssueTime string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
location string The datacenter where the connection is located.
ownerAccount string The account ID of the owner of the connection.
partnerName string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
region string The Region in which the connection has been created.
requestId string The ID of the request.
vlan integer This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.

Schema

{
  "awsDevice": "string",
  "bandwidth": "string",
  "connectionId": "string",
  "connectionName": "string",
  "connectionState": "string",
  "lagId": "string",
  "loaIssueTime": "string",
  "location": "string",
  "ownerAccount": "string",
  "partnerName": "string",
  "region": "string",
  "requestId": "string",
  "vlan": 0
}

DeleteVirtualInterfaceResponse

Properties

Name Type Description
requestId string The ID of the request.
virtualInterfaceState string The updated state of the virtual interface (always deleting).

Schema

{
  "requestId": "string",
  "virtualInterfaceState": "string"
}

DescribeConnectionsResponse

Properties

Name Type Description
connections [Connection] Information about one or more DirectLink connections.
requestId string The ID of the request.

Schema

{
  "connections": [
    {
      "awsDevice": "string",
      "bandwidth": "string",
      "connectionId": "string",
      "connectionName": "string",
      "connectionState": "string",
      "lagId": "string",
      "loaIssueTime": "string",
      "location": "string",
      "ownerAccount": "string",
      "partnerName": "string",
      "region": "string",
      "vlan": 0
    }
  ],
  "requestId": "string"
}

DescribeLocationsResponse

Properties

Name Type Description
locations [Locations] Information about one or more locations.
requestId string The ID of the request.

Schema

{
  "locations": [
    {
      "locationCode": "string",
      "locationName": "string"
    }
  ],
  "requestId": "string"
}

DescribeVirtualGatewaysResponse

Properties

Name Type Description
requestId string The ID of the request.
virtualGateways [VirtualGateways] Information about one or more virtual gateways.

Schema

{
  "requestId": "string",
  "virtualGateways": [
    {
      "virtualGatewayId": "string",
      "virtualGatewayState": "string"
    }
  ]
}

DescribeVirtualInterfacesResponse

Properties

Name Type Description
requestId string The ID of the request.
virtualInterfaces [VirtualInterface] Information about one or more virtual interfaces.

Schema

{
  "requestId": "string",
  "virtualInterfaces": [
    {
      "addressFamily": "string",
      "amazonAddress": "string",
      "amazonSideAsn": 0,
      "asn": 0,
      "authKey": "string",
      "bgpPeers": [
        {
          "addressFamily": "string",
          "amazonAddress": "string",
          "asn": 0,
          "authKey": "string",
          "bgpPeerState": "string",
          "bgpStatus": "string",
          "customerAddress": "string"
        }
      ],
      "connectionId": "string",
      "customerAddress": "string",
      "customerRouterConfig": "string",
      "directConnectGatewayId": "string",
      "location": "string",
      "ownerAccount": "string",
      "routeFilterPrefixes": [
        {
          "cidr": "string"
        }
      ],
      "virtualGatewayId": "string",
      "virtualInterfaceId": "string",
      "virtualInterfaceName": "string",
      "virtualInterfaceState": "string",
      "virtualInterfaceType": "string",
      "vlan": 0
    }
  ]
}

Locations

Information about a DirectLink location.

Properties

Name Type Description
locationCode string The location code, to be set as the location parameter of the CreateConnection method when creating a connection.
locationName string The name and description of the location, corresponding to a datacenter.

Schema

{
  "locationCode": "string",
  "locationName": "string"
}

NewPrivateVirtualInterface

Detailed information about the configuration parameters of the private virtual interface.

Properties

Name Type Description
amazonAddress string If provided, the IP to set on the OUTSCALE side of the virtual interface. This IP must include a network prefix (for example 172.16.0.1/30).
asn integer The autonomous system number (ASN) for the Border Gateway Protocol (BGP) configuration on the customer side of the virtual interface. This number must be between 64512 and 65534.
authKey string The BGP authentication key.
customerAddress string The IP on the customer side of the virtual interface. This IP must be provided if the amazonAddress parameter is provided, and be in the same network subnet.
virtualGatewayId string The target virtual private gateway.
virtualInterfaceName string The name of the virtual interface.
vlan integer The unique VLAN ID for the virtual interface. This number must be unique and be between 2 and 4094.

Schema

{
  "amazonAddress": "string",
  "asn": "0",
  "authKey": "string",
  "customerAddress": "string",
  "virtualGatewayId": "string",
  "virtualInterfaceName": "string",
  "vlan": 0
}

NewPrivateVirtualInterfaceAllocation

Detailed information about the configuration parameters of the private virtual interface.

Properties

Name Type Description
amazonAddress string If provided, the IP to set on the OUTSCALE side of the virtual interface. This IP must include a network prefix (for example, 172.16.0.1/30).
asn integer The autonomous system (AS) number for the Border Gateway Protocol (BGP) configuration on the customer side of the virtual interface.
authKey string The BGP authentication key.
customerAddress string The IP on the customer side of the virtual interface. This IP must be provided if the amazonAddress parameter is provided, and be in the same network subnet.
virtualInterfaceName string The name of the virtual interface.
vlan integer The unique VLAN ID for the virtual interface. This number must be unique and be between 2 and 4094.

Schema

{
  "amazonAddress": "string",
  "asn": "0",
  "authKey": "string",
  "customerAddress": "string",
  "virtualInterfaceName": "string",
  "vlan": 0
}

PrivateVirtualInterfaceResponse

Properties

Name Type Description
addressFamily string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
amazonAddress string The IP on the OUTSCALE side of the virtual interface.
amazonSideAsn integer (int64) This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
asn integer The autonomous system number (ASN) for the Border Gateway Protocol (BGP) configuration on the customer side of the virtual interface.
authKey string The BGP authentication key.
bgpPeers [BgpPeer] This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
connectionId string The ID of the DirectLink connection.
customerAddress string The IP on the customer side of the virtual interface.
customerRouterConfig string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
directConnectGatewayId string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
location string The datacenter where the virtual interface is located.
ownerAccount string The account ID of the owner of the virtual interface.
requestId string The ID of the request.
routeFilterPrefixes [RouteFilterPrefix] This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
virtualGatewayId string The ID of the target virtual private gateway.
virtualInterfaceId string The ID of the virtual interface.
virtualInterfaceName string The name of the virtual interface.
virtualInterfaceState string The state of the virtual interface (confirming | pending | available | deleting | deleted | rejected | expired).
virtualInterfaceType string The type of the virtual interface (always private).
vlan integer The VLAN number associated with the virtual interface.

Schema

{
  "addressFamily": "string",
  "amazonAddress": "string",
  "amazonSideAsn": 0,
  "asn": 0,
  "authKey": "string",
  "bgpPeers": [
    {
      "addressFamily": "string",
      "amazonAddress": "string",
      "asn": 0,
      "authKey": "string",
      "bgpPeerState": "string",
      "bgpStatus": "string",
      "customerAddress": "string"
    }
  ],
  "connectionId": "string",
  "customerAddress": "string",
  "customerRouterConfig": "string",
  "directConnectGatewayId": "string",
  "location": "string",
  "ownerAccount": "string",
  "requestId": "string",
  "routeFilterPrefixes": [
    {
      "cidr": "string"
    }
  ],
  "virtualGatewayId": "string",
  "virtualInterfaceId": "string",
  "virtualInterfaceName": "string",
  "virtualInterfaceState": "string",
  "virtualInterfaceType": "string",
  "vlan": 0
}

RouteFilterPrefix

This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.

Properties

Name Type Description
cidr string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.

Schema

{
  "cidr": "string"
}

VirtualGateways

Information about one or more virtual gateways.

Properties

Name Type Description
virtualGatewayId string The ID of the virtual gateway.
virtualGatewayState string The state of the virtual gateway (pending | available | deleting | deleted).

Schema

{
  "virtualGatewayId": "string",
  "virtualGatewayState": "string"
}

VirtualInterface

Detailed information about a virtual interface.

Properties

Name Type Description
addressFamily string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
amazonAddress string The IP on the OUTSCALE side of the virtual interface.
amazonSideAsn integer (int64) This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
asn integer The autonomous system number (ASN) for the Border Gateway Protocol (BGP) configuration on the customer side of the virtual interface.
authKey string The BGP authentication key.
bgpPeers [BgpPeer] This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
connectionId string The ID of the DirectLink connection.
customerAddress string The IP on the customer side of the virtual interface.
customerRouterConfig string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
directConnectGatewayId string This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
location string The datacenter where the virtual interface is located.
ownerAccount string The account ID of the owner of the virtual interface.
routeFilterPrefixes [RouteFilterPrefix] This parameter is not supported (always null). It is returned only for the sake of compatibility with AWS.
virtualGatewayId string The ID of the target virtual private gateway.
virtualInterfaceId string The ID of the virtual interface.
virtualInterfaceName string The name of the virtual interface.
virtualInterfaceState string The state of the virtual interface (confirming | pending | available | deleting | deleted | rejected | expired).
virtualInterfaceType string The type of the virtual interface (always private).
vlan integer The VLAN number associated with the virtual interface.

Schema

{
  "addressFamily": "string",
  "amazonAddress": "string",
  "amazonSideAsn": 0,
  "asn": 0,
  "authKey": "string",
  "bgpPeers": [
    {
      "addressFamily": "string",
      "amazonAddress": "string",
      "asn": 0,
      "authKey": "string",
      "bgpPeerState": "string",
      "bgpStatus": "string",
      "customerAddress": "string"
    }
  ],
  "connectionId": "string",
  "customerAddress": "string",
  "customerRouterConfig": "string",
  "directConnectGatewayId": "string",
  "location": "string",
  "ownerAccount": "string",
  "routeFilterPrefixes": [
    {
      "cidr": "string"
    }
  ],
  "virtualGatewayId": "string",
  "virtualInterfaceId": "string",
  "virtualInterfaceName": "string",
  "virtualInterfaceState": "string",
  "virtualInterfaceType": "string",
  "vlan": 0
}

Copyright © 2024 Outscale SAS. All rights reserved.

OSC CLI Shell