Qin Ying, Fan
62ab8a5fe2
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com> Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
44 KiB
Overview
Object Introduction
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.
Virtual interface APIs do not support IPv6 addresses.
Object Model
Parameter |
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. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. |
Specifies the virtual interface name. |
description |
String |
CRU |
None |
The value can contain 0 to 128 characters. Angle brackets (<>) are not allowed. |
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 virtual interface type. The value can only be private. |
service_type |
String |
CR |
None |
The value can contain 0 to 255 characters. |
Specifies what is to be accessed over the connection. The value can only be vpc. |
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 CIDR blocks used by the on-premises network. |
service_ep_group_id |
String |
CRU |
N/A |
UUID |
Specifies the ID of the service endpoint group that records the public service CIDR blocks. This is a reserved field, which is not used currently. |
create_time |
String |
R |
N/A |
The value can contain 0 to 255 characters. |
Specifies the time when the virtual interface is created. The UTC time format YYYY-MM-DDTHH:MM:SSZ is used. |
status |
String |
R |
N/A |
N/A |
Specifies the operating status of the virtual interface. The value can be ACTIVE, ERROR, PENDING_CREATE, or PENDING_UPDATE.
|
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. |
address_family |
String |
CR |
"ipv4" |
N/A |
Specifies the IP address family of the virtual interface peer. The value can be ipv4 or ipv6. IPv6 is not supported in the virtual interface APIs. |
enable_bfd |
Boolean |
CRU |
false |
N/A |
Specifies whether the BFD function is enabled. The value can be true or false. NOTE:
Bidirectional Forwarding Detection (BFD) is a network protocol that is used to detect faults between two routers or switches connected by a link. |
health_check_source_ip |
String |
CRU |
N/A |
UUID |
This is a reserved field, which is not used currently. |
rate_limit |
Boolean |
CRU |
false |
N/A |
This is a reserved field, which is not used currently. |
route_limit |
Integer |
CRU |
50 |
N/A |
This is a reserved field, which is not used currently. |
region_id |
String |
CR |
N/A |
N/A |
This is a reserved field, which is not used currently. |
enable_nqa |
Boolean |
CRU |
false |
N/A |
This is a reserved field, which is not used currently. |
enable_gre |
Boolean |
CRU |
false |
N/A |
This is a reserved field, which is not used currently. |
local_gateway_v6_ip |
String |
CR |
N/A |
N/A |
This is a reserved field, which is not used currently. |
remote_gateway_v6_ip |
String |
CR |
N/A |
N/A |
This is a reserved field, which is not used currently. |
local_gre_tunnel_ip |
String |
CR |
N/A |
N/A |
This is a reserved field, which is not used currently. |
remote_gre_tunnel_ip |
String |
CR |
N/A |
N/A |
This is a reserved field, which is not used currently. |
lag_id |
String |
CR |
N/A |
UUID |
This is a reserved field, which is not used currently. |