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.
Authentication: About Signatures of API Requests
Throttling: If you exceed the number of identical requests allowed for a configured time period, a Throttling
error message is returned.
Base URLs:
- https://directlink.{region}.outscale.com
- region
- eu-west-2 (default)
- us-east-2
- cloudgouv-eu-west-1
- region
Terms of service Email: Support License: BSD 3 Clause
Authentication
- API Key (ApiKeyAuth)
- Parameter Name: Authorization, in: header. With this authentication scheme, you must use an access key to sign your API requests. For more information, see About Signatures of API Requests.
In addition to your access key, you can configure API access rules with Certificate Authorities (CAs), requiring you to provide a certificate to perform actions. In that case, you can bypass systematically providing a certificate by activating a trusted session. For more information, see the UpdateApiAccessPolicy OUTSCALE API method and About Your API Access Policy.
- Parameter Name: Authorization, in: header. With this authentication scheme, you must use an access key to sign your API requests. For more information, see About Signatures of API Requests.
Connections
CreateConnection
POST /CreateConnection
Creates a DirectLink connection between a customer network and a specified DirectLink location.
Code samples
osc-cli directlink CreateConnection --profile "default" \
--bandwidth "string" \
--connectionName "string" \
--location "string"
# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl
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": "string",
"connectionName": "string",
"location": "string"
}'
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
bandwidth | string | true | The bandwidth of the connection (1Gbps | 10Gbps ). |
connectionName | string | true | The name of the connection. |
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). | CreateConnectionResponse |
Example responses
200 Response
{
"bandwidth": "string",
"connectionId": "string",
"connectionName": "string",
"connectionState": "string",
"location": "string",
"ownerAccount": "string",
"region": "string"
}
DeleteConnection
POST /DeleteConnection
Deletes a specified DirectLink connection.
Before deleting a connection, ensure that all your virtual interfaces related to this connection are deleted.
Code samples
osc-cli directlink DeleteConnection --profile "default" \
--connectionId "string"
# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl
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"
}'
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
connectionId | string | true | The ID of the DirectLink connection you want to delete. |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | DeleteConnectionResponse |
Example responses
200 Response
{
"bandwidth": "string",
"connectionId": "string",
"connectionName": "string",
"connectionState": "string",
"location": "string",
"ownerAccount": "string",
"region": "string"
}
DescribeConnections
POST /DescribeConnections
Describes all DirectLink connections in the Region.
You can use the ConnectionId
parameter to only describe a specified connection.
Code samples
osc-cli directlink DescribeConnections --profile "default" \
--connectionId "string"
# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl
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"
}'
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
connectionId | string | false | The ID of a DirectLink connection. |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | DescribeConnectionsResponse |
Example responses
200 Response
{
"connections": [
{
"bandwidth": "string",
"connectionId": "string",
"connectionName": "string",
"connectionState": "string",
"location": "string",
"ownerAccount": "string",
"region": "string"
}
]
}
Sites
DescribeLocations
POST /DescribeLocations
Describes the locations, corresponding to datacenters, where you can set up a DirectLink connection.
Code samples
osc-cli directlink DescribeLocations --profile "default"
# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl
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 '{}'
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | DescribeLocationsResponse |
Example responses
200 Response
{
"locations": [
{
"locationCode": "string",
"locationName": "string"
}
]
}
Virtual Interfaces
AllocatePrivateVirtualInterface
POST /AllocatePrivateVirtualInterface
Creates a private virtual interface whose owner is another OUTSCALE user.
The other user 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.
Code samples
osc-cli directlink AllocatePrivateVirtualInterface --profile "default" \
--connectionId "string" \
--newPrivateVirtualInterfaceAllocation '{ \
"amazonAddress": "string", \
"asn": 0, \
"authKey": "string", \
"customerAddress": "string", \
"virtualInterfaceName": "string", \
"vlan": 0 \
}' \
--ownerAccount "string"
# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl
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",
"newPrivateVirtualInterfaceAllocation": {
"amazonAddress": "string",
"asn": 0,
"authKey": "string",
"customerAddress": "string",
"virtualInterfaceName": "string",
"vlan": 0
},
"ownerAccount": "string"
}'
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
connectionId | string | true | The ID of the existing DirectLink connection for which you want to create the private virtual interface. |
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 | false | 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 | false | The name of the virtual interface. |
» vlan | integer | false | The unique VLAN ID for the virtual interface. |
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). | AllocatePrivateVirtualInterfaceResponse |
Example responses
200 Response
{
"amazonAddress": "string",
"asn": 0,
"authKey": "string",
"connectionId": "string",
"customerAddress": "string",
"location": "string",
"ownerAccount": "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.
Code samples
osc-cli directlink ConfirmPrivateVirtualInterface --profile "default" \
--virtualGatewayId "string" \
--virtualInterfaceId "string"
# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl
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 '{
"virtualGatewayId": "string",
"virtualInterfaceId": "string"
}'
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
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
{
"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.
Code samples
osc-cli directlink CreatePrivateVirtualInterface --profile "default" \
--connectionId "string" \
--newPrivateVirtualInterface '{ \
"amazonAddress": "string", \
"asn": 0, \
"authKey": "string", \
"customerAddress": "string", \
"virtualGatewayId": "string", \
"virtualInterfaceName": "string", \
"vlan": 0 \
}'
# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl
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",
"newPrivateVirtualInterface": {
"amazonAddress": "string",
"asn": 0,
"authKey": "string",
"customerAddress": "string",
"virtualGatewayId": "string",
"virtualInterfaceName": "string",
"vlan": 0
}
}'
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
connectionId | string | true | The ID of the existing DirectLink connection for which you want to create the private virtual interface. |
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 | false | 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 | false | The name of the virtual interface. |
» vlan | integer | false | The unique VLAN ID for the virtual interface. |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | CreatePrivateVirtualInterfaceResponse |
Example responses
200 Response
{
"amazonAddress": "string",
"asn": 0,
"authKey": "string",
"connectionId": "string",
"customerAddress": "string",
"location": "string",
"ownerAccount": "string",
"virtualGatewayId": "string",
"virtualInterfaceId": "string",
"virtualInterfaceName": "string",
"virtualInterfaceState": "string",
"virtualInterfaceType": "string",
"vlan": 0
}
DeleteVirtualInterface
POST /DeleteVirtualInterface
Deletes a specified virtual interface.
Code samples
osc-cli directlink DeleteVirtualInterface --profile "default" \
--virtualInterfaceId "string"
# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl
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 '{
"virtualInterfaceId": "string"
}'
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
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
{
"virtualInterfaceState": "string"
}
DescribeVirtualGateways
POST /DescribeVirtualGateways
Returns a list of your virtual gateways that can be used as a target by a private virtual interface.
Code samples
osc-cli directlink DescribeVirtualGateways --profile "default"
# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl
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 '{}'
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The HTTP 200 response (OK). | DescribeVirtualGatewaysResponse |
Example responses
200 Response
{
"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.
Code samples
osc-cli directlink DescribeVirtualInterfaces --profile "default" \
--connectionId "string" \
--virtualInterfaceId "string"
# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl
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",
"virtualInterfaceId": "string"
}'
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
connectionId | string | false | The ID of a DirectLink connection. |
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
{
"virtualInterfaces": [
{
"amazonAddress": "string",
"asn": 0,
"authKey": "string",
"connectionId": "string",
"customerAddress": "string",
"location": "string",
"ownerAccount": "string",
"virtualGatewayId": "string",
"virtualInterfaceId": "string",
"virtualInterfaceName": "string",
"virtualInterfaceState": "string",
"virtualInterfaceType": "string",
"vlan": 0
}
]
}
Schemas
AllocatePrivateVirtualInterfaceResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amazonAddress | string | false | none | The IP on the OUTSCALE side of the virtual interface. |
asn | integer | false | none | The autonomous system number (ASN) for the Border Gateway Protocol (BGP) configuration on the customer side of the virtual interface. |
authKey | string | false | none | The BGP authentication key. |
connectionId | string | false | none | The ID of the DirectLink connection. |
customerAddress | string | false | none | The IP on the customer side of the virtual interface. |
location | string | false | none | The datacenter where the virtual interface is located. |
ownerAccount | string | false | none | The account ID of the owner of the virtual interface. |
virtualInterfaceId | string | false | none | The ID of the virtual interface. |
virtualInterfaceName | string | false | none | The name of the virtual interface. |
virtualInterfaceState | string | false | none | The state of the virtual interface (confirming | pending | available | deleting | deleted | rejected | expired ). |
virtualInterfaceType | string | false | none | The type of the virtual interface (always private ). |
vlan | integer | false | none | The VLAN number associated with the virtual interface. |
Schema
{
"amazonAddress": "string",
"asn": 0,
"authKey": "string",
"connectionId": "string",
"customerAddress": "string",
"location": "string",
"ownerAccount": "string",
"virtualInterfaceId": "string",
"virtualInterfaceName": "string",
"virtualInterfaceState": "string",
"virtualInterfaceType": "string",
"vlan": 0
}
ConfirmPrivateVirtualInterfaceResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
virtualInterfaceState | string | false | none | The state of the virtual interface (always pending ). |
Schema
{
"virtualInterfaceState": "string"
}
CreateConnectionResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bandwidth | string | false | none | The physical link bandwidth (either 1Gbps or 10Gbps ). |
connectionId | string | false | none | The ID of the connection (for example, dxcon-xxxxxxxx ). |
connectionName | string | false | none | The name of the connection. |
connectionState | string | false | none | The state of the connection. |
location | string | false | none | The datacenter where the connection is located. |
ownerAccount | string | false | none | The account ID of the owner of the connection. |
region | string | false | none | The Region in which the connection has been created. |
Schema
{
"bandwidth": "string",
"connectionId": "string",
"connectionName": "string",
"connectionState": "string",
"location": "string",
"ownerAccount": "string",
"region": "string"
}
CreatePrivateVirtualInterfaceResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amazonAddress | string | false | none | The IP on the OUTSCALE side of the virtual interface. |
asn | integer | false | none | The autonomous system number (ASN) for the Border Gateway Protocol (BGP) configuration on the customer side of the virtual interface. |
authKey | string | false | none | The BGP authentication key. |
connectionId | string | false | none | The ID of the DirectLink connection. |
customerAddress | string | false | none | The IP on the customer side of the virtual interface. |
location | string | false | none | The datacenter where the virtual interface is located. |
ownerAccount | string | false | none | The account ID of the owner of the virtual interface. |
virtualGatewayId | string | false | none | The ID of the target virtual private gateway. |
virtualInterfaceId | string | false | none | The ID of the virtual interface. |
virtualInterfaceName | string | false | none | The name of the virtual interface. |
virtualInterfaceState | string | false | none | The state of the virtual interface (confirming | pending | available | deleting | deleted | rejected | expired ). |
virtualInterfaceType | string | false | none | The type of the virtual interface (always private ). |
vlan | integer | false | none | The VLAN number associated with the virtual interface. |
Schema
{
"amazonAddress": "string",
"asn": 0,
"authKey": "string",
"connectionId": "string",
"customerAddress": "string",
"location": "string",
"ownerAccount": "string",
"virtualGatewayId": "string",
"virtualInterfaceId": "string",
"virtualInterfaceName": "string",
"virtualInterfaceState": "string",
"virtualInterfaceType": "string",
"vlan": 0
}
DeleteConnectionResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bandwidth | string | false | none | The physical link bandwidth (either 1Gbps or 10Gbps ). |
connectionId | string | false | none | The ID of the connection (for example, dxcon-xxxxxxxx ). |
connectionName | string | false | none | The name of the connection. |
connectionState | string | false | none | The state of the connection. |
location | string | false | none | The datacenter where the connection is located. |
ownerAccount | string | false | none | The account ID of the owner of the connection. |
region | string | false | none | The Region in which the connection has been created. |
Schema
{
"bandwidth": "string",
"connectionId": "string",
"connectionName": "string",
"connectionState": "string",
"location": "string",
"ownerAccount": "string",
"region": "string"
}
DeleteVirtualInterfaceResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
virtualInterfaceState | string | false | none | The updated state of the virtual interface (always deleting ). |
Schema
{
"virtualInterfaceState": "string"
}
DescribeConnectionsResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
connections | [connections] | false | none | Information about one or more DirectLink connections. |
Schema
{
"connections": [
{
"bandwidth": "string",
"connectionId": "string",
"connectionName": "string",
"connectionState": "string",
"location": "string",
"ownerAccount": "string",
"region": "string"
}
]
}
DescribeLocationsResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
locations | [locations] | false | none | Information about one or more locations. |
Schema
{
"locations": [
{
"locationCode": "string",
"locationName": "string"
}
]
}
DescribeVirtualGatewaysResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
virtualGateways | [virtualGateways] | false | none | Information about one or more virtual gateways. |
Schema
{
"virtualGateways": [
{
"virtualGatewayId": "string",
"virtualGatewayState": "string"
}
]
}
DescribeVirtualInterfacesResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
virtualInterfaces | [virtualInterfaces] | false | none | Information about one or more virtual interfaces. |
Schema
{
"virtualInterfaces": [
{
"amazonAddress": "string",
"asn": 0,
"authKey": "string",
"connectionId": "string",
"customerAddress": "string",
"location": "string",
"ownerAccount": "string",
"virtualGatewayId": "string",
"virtualInterfaceId": "string",
"virtualInterfaceName": "string",
"virtualInterfaceState": "string",
"virtualInterfaceType": "string",
"vlan": 0
}
]
}
connections
*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 thepending
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.*
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bandwidth | string | false | none | The physical link bandwidth (either 1Gbps or 10Gbps ). |
connectionId | string | false | none | The ID of the connection (for example, dxcon-xxxxxxxx ). |
connectionName | string | false | none | The name of the connection. |
connectionState | string | false | none | The state of the connection. |
location | string | false | none | The datacenter where the connection is located. |
ownerAccount | string | false | none | The account ID of the owner of the connection. |
region | string | false | none | The Region in which the connection has been created. |
Schema
{
"bandwidth": "string",
"connectionId": "string",
"connectionName": "string",
"connectionState": "string",
"location": "string",
"ownerAccount": "string",
"region": "string"
}
locations
Information about a DirectLink location.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
locationCode | string | false | none | The location code, to be set as the location parameter of the CreateConnection method when creating a connection. |
locationName | string | false | none | 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 | Required | Restrictions | Description |
---|---|---|---|---|
amazonAddress | string | false | none | 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 | false | none | 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 | none | The BGP authentication key. |
customerAddress | string | false | none | 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 | none | The target virtual private gateway. |
virtualInterfaceName | string | false | none | The name of the virtual interface. |
vlan | integer | false | none | The unique VLAN ID for the virtual interface. |
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 | Required | Restrictions | Description |
---|---|---|---|---|
amazonAddress | string | false | none | 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 | false | none | The autonomous system (AS) number for the Border Gateway Protocol (BGP) configuration on the customer side of the virtual interface. |
authKey | string | false | none | The BGP authentication key. |
customerAddress | string | false | none | 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 | false | none | The name of the virtual interface. |
vlan | integer | false | none | The unique VLAN ID for the virtual interface. |
Schema
{
"amazonAddress": "string",
"asn": 0,
"authKey": "string",
"customerAddress": "string",
"virtualInterfaceName": "string",
"vlan": 0
}
virtualGateways
Information about one or more virtual gateways.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
virtualGatewayId | string | false | none | The ID of the virtual gateway. |
virtualGatewayState | string | false | none | The state of the virtual gateway (pending | available | deleting | deleted ). |
Schema
{
"virtualGatewayId": "string",
"virtualGatewayState": "string"
}
virtualInterfaces
Detailed information about a virtual interface.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amazonAddress | string | false | none | The IP on the OUTSCALE side of the virtual interface. |
asn | integer | false | none | The autonomous system number (ASN) for the Border Gateway Protocol (BGP) configuration on the customer side of the virtual interface. |
authKey | string | false | none | The BGP authentication key. |
connectionId | string | false | none | The ID of the DirectLink connection. |
customerAddress | string | false | none | The IP on the customer side of the virtual interface. |
location | string | false | none | The datacenter where the virtual interface is located. |
ownerAccount | string | false | none | The account ID of the owner of the virtual interface. |
virtualGatewayId | string | false | none | The ID of the target virtual private gateway. |
virtualInterfaceId | string | false | none | The ID of the virtual interface. |
virtualInterfaceName | string | false | none | The name of the virtual interface. |
virtualInterfaceState | string | false | none | The state of the virtual interface (confirming | pending | available | deleting | deleted | rejected | expired ). |
virtualInterfaceType | string | false | none | The type of the virtual interface (always private ). |
vlan | integer | false | none | The VLAN number associated with the virtual interface. |
Schema
{
"amazonAddress": "string",
"asn": 0,
"authKey": "string",
"connectionId": "string",
"customerAddress": "string",
"location": "string",
"ownerAccount": "string",
"virtualGatewayId": "string",
"virtualInterfaceId": "string",
"virtualInterfaceName": "string",
"virtualInterfaceState": "string",
"virtualInterfaceType": "string",
"vlan": 0
}
Copyright © 2023 Outscale SAS. All rights reserved.