AllocatePrivateVirtualInterface

GET /?Action=AllocatePrivateVirtualInterface
Description

Creates a private virtual interface whose owner is another 3DS 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 new virtual interface again.

Body parameter

Required: false
Name: AllocatePrivateVirtualInterfaceRequest

Name Description Required Schema Default Example

connectionId

The ID of the existing DirectLink connection for which you want to create the private virtual interface.

true

string

newPrivateVirtualInterfaceAllocation

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

true

NewPrivateVirtualInterfaceAllocation

ownerAccount

The account ID of the owner of the private virtual interface.

true

string
Responses
HTTP Code 200
HTTP Code Description Schema

200

VirtualInterface

Response 200

Response 200

Name Description Required Schema Default Example

amazonAddress

The IP address on the 3DS OUTSCALE side of the virtual interface.

false

string

asn

The autonomous system number (ASN) for the Border Gateway Protocol (BGP) configuration on the customer side of the virtual interface.

false

integer

authKey

The BGP authentication key.

false

string

connectionId

The ID of the DirectLink connection.

false

string

customerAddress

The IP address on the customer side of the virtual interface.

false

string

location

The datacenter where the virtual interface is located.

false

string

ownerAccount

The account ID of the owner of the virtual interface.

false

string

virtualInterfaceId

The ID of the virtual interface.

false

string

virtualInterfaceName

The name of the virtual interface.

false

string

virtualInterfaceState

The state of the virtual interface (confirming | pending | available | deleting | deleted | rejected | expired).

false

string

virtualInterfaceType

The type of the virtual interface (always private).

false

string

vlan

The VLAN number associated with the virtual interface.

false

integer