This section describes the APIs for managing and operating the virtual interfaces, including the APIs used to create, query, update, and delete a virtual interface, and the API to query the virtual interface list.
Attribute |
Type |
CRUD |
Default Value |
Constraint |
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 |
None |
The value can contain 0 to 64 characters. The name can contain only digits, letters, underscores (_), and hyphens (-). |
Specifies the virtual interface name. |
description |
String |
CRU |
None |
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 |
None |
The value can contain 0 to 255 characters. |
Specifies the interface type: public or private. |
service_type |
String |
CR |
None |
The value can contain 0 to 255 characters. |
Specifies the access service type. The value can be vpc, public service, or vpc and public service. |
vlan |
Integer |
CR |
N/A |
VLAN: 1 to 4063 |
Specifies the VLAN used by the local gateway to communicate with the remote gateway. |
bandwidth |
Integer |
CRU |
N/A |
Bandwidth: 2 Mbit/s to 10,000 Mbit/s |
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 |
ASN: 1 to 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 message digest algorithm 5 (MD5) key 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 CIDR blocks. |
service_ep_group_id |
String |
CRU |
N/A |
uuid |
Specifies the ID of the service endpoint group that records the public service CIDR blocks. |
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 virtual interface status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, PENDING_DELETE, DELETED, AUTHORIZATION, or REJECTED. |
admin_state_up |
Boolean |
CR |
true |
The value can only be true. |
Specifies the administrative status of the virtual interface. The value can be true or false. |