Overview¶
Object Introduction¶
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.
Note
Virtual gateway APIs do not support IPv6 addresses.
Object Model¶
Parameter | 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. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. | Specifies the virtual gateway name. |
description | String | CRU | None | The value can contain 0 to 128 characters. Angle brackets (<>) are not allowed. | 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 used by the virtual gateway. |
redundant_device_id | String | CR | None | The value can contain 0 to 255 characters. | Specifies the ID of the redundant physical device used by the virtual gateway. |
type | String | CR | default | The value can contain 0 to 255 characters. | Specifies the virtual gateway type. The value can only be default. |
ipsec_bandwidth | Integer | CR | 1 | Bandwidth range: 1 Mbit/s to 300 Mbit/s | This field is discarded. |
status | String | R | NA | N/A | Specifies the operating status of the virtual gateway. 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 gateway. The value can be true or false. |
bgp_asn | Integer | CR | 64512 | N/A | Specifies the BGP ASN of the virtual gateway. This is a reserved field, which is not used currently. |
region_id | String | CRU | None | N/A | This is a reserved field, which is not used currently. |
local_ep_group_ipv6_id | String | CR | None | UUID | Specifies the ID of the local endpoint group that records CIDR blocks of the IPv6 VPC subnets. Note This is a reserved field. It can only be viewed in APIs and cannot be configured or used. |