This section describes the APIs for managing and operating the virtual gateway, including the APIs used to create, query, update, and delete a virtual gateway, and the API used to query the virtual gateway list.
Attribute |
Type |
CRUD |
Default Value |
Constraint |
Description |
|---|---|---|---|---|---|
id |
String |
R |
Automatically generated |
uuid |
Specifies the virtual gateway 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 gateway name. |
description |
String |
CRU |
None |
The value can contain 0 to 128 characters. |
Provides supplementary information about the virtual gateway. |
vpc_id |
String |
CR |
N/A |
uuid |
Specifies the ID of the VPC to be accessed. |
local_ep_group_id |
String |
CRU |
N/A |
uuid |
Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets. |
device_id |
String |
CR |
None |
The value can contain 0 to 255 characters. |
Specifies the ID of the physical device. |
redundant_device_id |
String |
CR |
None |
The value can contain 0 to 255 characters. |
Specifies the ID of the redundant device. |
type |
String |
CR |
default |
The value can contain 0 to 255 characters. |
Specifies the virtual gateway type. The value can be default or double ipsec. |
ipsec_bandwidth |
Integer |
CR |
N/A |
Bandwidth range: 1 Mbit/s to 300 Mbit/s |
Specifies the bandwidth provided for Internet Protocol security virtual private network (IPsec VPN) in Mbit/s. |
status |
String |
R |
NA |
N/A |
Specifies the virtual gateway status. Valid values are: ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, and PENDING_DELETE. |
admin_state_up |
Boolean |
CR |
true |
The value can only be true. |
Specifies the administrative status of the virtual gateway. The value can be true or false. |