• Direct Connect

dc
  1. Help Center
  2. Direct Connect
  3. API Reference
  4. API
  5. Virtual Interface
  6. Description

Description

Object

Used to manage virtual interfaces, including the APIs used to create, delete, query, and update a virtual interface, and the API to query the virtual interface list.

Object Models

Table 1 Virtual interface objects

Parameter

Type

CRUD

Default Value

Constraints

Description

id

String

R

Automatically generated

uuid

Specifies the virtual interface ID.

tenant_id

String

CR

N/A

The value can contain 0 to 255 characters.

Specifies the tenant ID.

name

String

CRU

Left blank

The value can contain 0 to 64 characters.

Only digits, letters, underscores (_), and hyphens (-) are supported.

Specifies the virtual interface name.

description

String

CRU

Left blank

The value can contain 0 to 128 characters.

Provides supplementary information about the virtual interface.

direct_connect_id

String

CR

N/A

uuid

Specifies the connection ID.

vgw_ id

String

CR

N/A

N/A

Specifies the virtual gateway ID.

type

String

CR

Left blank

The value can contain 0 to 255 characters.

Specifies the interface type. The value can be public or private.

service_type

String

CR

Left blank

The value can contain 0 to 255 characters.

Specifies the access service type: vpc, public service, or vpc and public service.

vlan

Integer

CR

N/A

<1,4063>

Specifies the VLAN used by the local gateway to communicate with the remote gateway.

bandwidth

Integer

CRU

N/A

<2,10000>

Specifies the virtual interface bandwidth.

local_gateway_v4_ip

String

CR

N/A

The value can contain 0 to 255 characters.

Specifies the IPv4 address of the local gateway.

remote_gateway_v4_ip

String

CR

N/A

The value can contain 0 to 255 characters.

Specifies the IPv4 address of the remote gateway.

route_mode

String

CR

static

The value can contain 0 to 255 characters.

Specifies the routing mode. The value can be static or bgp.

bgp_asn

Integer

CR

N/A

<1,4294967295>

Specifies the AS number of the BGP peer.

bgp_md5

String

CR

N/A

The value can contain 0 to 255 characters.

Specifies the MD5 password of the BGP peer.

remote_ep_group_id

String

CRU

N/A

uuid

Specifies the ID of the remote endpoint group that records the tenant CIDRs.

service_ep_group_id

String

CRU

N/A

uuid

Specifies the ID of the service endpoint group that records the public service CIDRs.

create_time

String

R

N/A

The value can contain 0 to 255 characters.

Specifies the time when the virtual interface is created.

delete_time

String

R

N/A

The value can contain 0 to 255 characters.

Specifies the time when the virtual interface is deleted.

status

String

R

N/A

N/A

Specifies the operating status. Possible values are: ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, PENDING_DELETE, DELETED, AUTHORIZATION, and REJECTED.

admin_state_up

Boolean

CR

true

Only true is supported.

Specifies the administrative status. The value can be true or false.