DescribeVirtualInterfaces

GET /?Action=DescribeVirtualInterfaces
Description

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.

Note

If you exceed the number of identical requests allowed for a configured time period, the Throttling error message is returned.
Body parameter

Required: false
Name: DescribeVirtualInterfacesRequest

Name Description Required Schema Default Example

connectionId

The ID of a DirectLink connection.

false

string

virtualInterfaceId

The ID of a virtual interface.

false

string
Responses
HTTP Code 200
HTTP Code Description Schema

200

VirtualInterfaces

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

virtualGatewayId

The ID of the target virtual private gateway.

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