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.

Endpoints

Name Base URL
eu-west-2 (default) https://directlink.eu-west-2.outscale.com
us-east-2 https://directlink.us-east-2.outscale.com
cloudgouv-eu-west-1 https://directlink.cloudgouv-eu-west-1.outscale.com

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.

Request Parameters

OSC CLI Shell

Examples

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"
  }'

Body (CreateConnectionRequest):

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

Response Elements

Examples

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
}

Response 200 (ConnectionResponse):

Response Element 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.

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.

Request Parameters

OSC CLI Shell

Examples

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
  }'

Body (DeleteConnectionRequest):

Body Parameter Type Description
connectionId (required) string The ID of the DirectLink connection you want to delete.
dryRun boolean If true, checks whether you have the required permissions to perform the action.

Response Elements

Examples

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
}

Response 200 (ConnectionResponse):

Response Element 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.

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.

Request Parameters

OSC CLI Shell

Examples

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
  }'

Body (DescribeConnectionsRequest):

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

Response Elements

Examples

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"
}

Response 200 (DescribeConnectionsResponse):

Response Element Type Description
connections [Connection] Information about one or more DirectLink connections.
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.
requestId string The ID of the request.

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.

Request Parameters

OSC CLI Shell

Examples

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
  }'

Body (DescribeLocationsRequest):

Body Parameter Type Description
DryRun boolean If true, checks whether you have the required permissions to perform the action.

Response Elements

Examples

200 Response

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

Response 200 (DescribeLocationsResponse):

Response Element Type Description
locations [Locations] Information about one or more locations.
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.
requestId string The ID of the request.

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.

Request Parameters

OSC CLI Shell

Examples

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"
  }'

Body (AllocatePrivateVirtualInterfaceRequest):

Body Parameter Type Description
connectionId (required) string The ID of the existing DirectLink connection for which you want to create the private virtual interface.
dryRun boolean If true, checks whether you have the required permissions to perform the action.
newPrivateVirtualInterfaceAllocation (required) NewPrivateVirtualInterfaceAllocation Detailed information about the configuration parameters of the private virtual interface.
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 (required) 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 (required) string The name of the virtual interface.
vlan (required) integer The unique VLAN ID for the virtual interface. This number must be unique and be between 2 and 4094.
ownerAccount (required) string The account ID of the owner of the private virtual interface.

Response Elements

Examples

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
}

Response 200 (PrivateVirtualInterfaceResponse):

Response Element 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.
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.
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.
cidr string 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.

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.

Request Parameters

OSC CLI Shell

Examples

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"
  }'

Body (ConfirmPrivateVirtualInterfaceRequest):

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

Response Elements

Examples

200 Response

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

Response 200 (ConfirmPrivateVirtualInterfaceResponse):

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

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.

Request Parameters

OSC CLI Shell

Examples

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
    }
  }'

Body (CreatePrivateVirtualInterfaceRequest):

Body Parameter Type Description
connectionId (required) string The ID of the existing DirectLink connection for which you want to create the private virtual interface.
dryRun boolean If true, checks whether you have the required permissions to perform the action.
newPrivateVirtualInterface (required) NewPrivateVirtualInterface Detailed information about the configuration parameters of the private virtual interface.
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 (required) 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 (required) string The name of the virtual interface.
vlan (required) integer The unique VLAN ID for the virtual interface. This number must be unique and be between 2 and 4094.

Response Elements

Examples

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
}

Response 200 (PrivateVirtualInterfaceResponse):

Response Element 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.
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.
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.
cidr string 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.

DeleteVirtualInterface

POST /DeleteVirtualInterface

Deletes a specified virtual interface.

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

Request Parameters

OSC CLI Shell

Examples

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"
  }'

Body (DeleteVirtualInterfaceRequest):

Body Parameter Type Description
dryRun boolean If true, checks whether you have the required permissions to perform the action.
virtualInterfaceId (required) string The ID of the virtual interface you want to delete.

Response Elements

Examples

200 Response

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

Response 200 (DeleteVirtualInterfaceResponse):

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

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.

Request Parameters

OSC CLI Shell

Examples

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
  }'

Body (DescribeVirtualGatewaysRequest):

Body Parameter Type Description
DryRun boolean If true, checks whether you have the required permissions to perform the action.

Response Elements

Examples

200 Response

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

Response 200 (DescribeVirtualGatewaysResponse):

Response Element Type Description
requestId string The ID of the request.
virtualGateways [VirtualGateways] Information about one or more virtual gateways.
virtualGatewayId string The ID of the virtual gateway.
virtualGatewayState string The state of the virtual gateway (pending | available | deleting | deleted).

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.

Request Parameters

OSC CLI Shell

Examples

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"
  }'

Body (DescribeVirtualInterfacesRequest):

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

Response Elements

Examples

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
    }
  ]
}

Response 200 (DescribeVirtualInterfacesResponse):

Response Element Type Description
requestId string The ID of the request.
virtualInterfaces [VirtualInterface] Information about one or more virtual interfaces.
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] The BGP authentication key.
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.
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.
cidr string 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.

Schemas

AllocatePrivateVirtualInterfaceRequest

Property Type Description
connectionId string The ID of the existing DirectLink connection for which you want to create the private virtual interface.
dryRun boolean If true, checks whether you have the required permissions to perform the action.
newPrivateVirtualInterfaceAllocation NewPrivateVirtualInterfaceAllocation Detailed information about the configuration parameters of the private virtual interface.
ownerAccount string The account ID of the owner of the private virtual interface.

Schema

{
  "connectionId": "string",
  "dryRun": true,
  "newPrivateVirtualInterfaceAllocation": {
    "amazonAddress": "string",
    "asn": 0,
    "authKey": "string",
    "customerAddress": "string",
    "virtualInterfaceName": "string",
    "vlan": 0
  },
  "ownerAccount": "string"
}

BgpPeer

Property 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"
}

ConfirmPrivateVirtualInterfaceRequest

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

Schema

{
  "dryRun": true,
  "virtualGatewayId": "string",
  "virtualInterfaceId": "string"
}

ConfirmPrivateVirtualInterfaceResponse

Property 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:

  • requested: The connection is requested but the request has not been validated yet.
  • pending: The connection request has been validated. It remains in the pending state until you establish the physical link.
  • available: The physical link is established and the connection is ready to use.
  • deleting: The deletion process is in progress.
  • deleted: The connection is deleted.
Property 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

Property 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
}

CreateConnectionRequest

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

Schema

{
  "bandwidth": "1Gbps",
  "connectionName": "string",
  "dryRun": true,
  "location": "string"
}

CreatePrivateVirtualInterfaceRequest

Property Type Description
connectionId string The ID of the existing DirectLink connection for which you want to create the private virtual interface.
dryRun boolean If true, checks whether you have the required permissions to perform the action.
newPrivateVirtualInterface NewPrivateVirtualInterface Detailed information about the configuration parameters of the private virtual interface.

Schema

{
  "connectionId": "string",
  "dryRun": true,
  "newPrivateVirtualInterface": {
    "amazonAddress": "string",
    "asn": 0,
    "authKey": "string",
    "customerAddress": "string",
    "virtualGatewayId": "string",
    "virtualInterfaceName": "string",
    "vlan": 0
  }
}

DeleteConnectionRequest

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

Schema

{
  "connectionId": "string",
  "dryRun": true
}

DeleteVirtualInterfaceRequest

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

Schema

{
  "dryRun": true,
  "virtualInterfaceId": "string"
}

DeleteVirtualInterfaceResponse

Property 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"
}

DescribeConnectionsRequest

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

Schema

{
  "connectionId": "string",
  "dryRun": true
}

DescribeConnectionsResponse

Property 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"
}

DescribeLocationsRequest

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

Schema

{
  "DryRun": true
}

DescribeLocationsResponse

Property 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"
}

DescribeVirtualGatewaysRequest

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

Schema

{
  "DryRun": true
}

DescribeVirtualGatewaysResponse

Property 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"
    }
  ]
}

DescribeVirtualInterfacesRequest

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

Schema

{
  "connectionId": "string",
  "dryRun": true,
  "virtualInterfaceId": "string"
}

DescribeVirtualInterfacesResponse

Property 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

Property 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.

Property 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.

Property 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

Property 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

Property 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.

Property 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

Property 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] The BGP authentication key.
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
}
OSC CLI Shell

AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.