This API is used to query a virtual gateway.
GET /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
Parameter |
Type |
Mandatory |
Description |
|---|---|---|---|
virtual_gateway_id |
String |
Yes |
Specifies the virtual gateway ID. |
Table 2 lists the request parameter.
Table 3 lists the response parameter.
Parameter |
Type |
Mandatory |
Description |
|---|---|---|---|
virtual_gateway |
Dictionary data structure |
Yes |
Specifies the virtual_gateway object. |
Parameter |
Type |
Mandatory |
Description |
|---|---|---|---|
id |
String |
Yes |
Specifies the virtual gateway ID. |
tenant_id |
String |
Yes |
Specifies the project ID. |
name |
String |
No |
Specifies the virtual gateway name. |
description |
String |
No |
Provides supplementary information about the virtual gateway. |
vpc_id |
String |
Yes |
Specifies the ID of the VPC to be accessed. |
local_ep_group_id |
String |
Yes |
Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets. |
device_id |
String |
No |
Specifies the ID of the physical device used by the virtual gateway. |
redundant_device_id |
String |
No |
Specifies the ID of the redundant physical device used by the virtual gateway. |
type |
String |
No |
Specifies the virtual gateway type. The value can be default or double ipsec. |
ipsec_bandwidth |
Integer |
No |
Specifies the bandwidth provided for IPsec VPN in Mbit/s. |
bgp_asn |
Integer |
No |
Specifies the BGP ASN of the virtual gateway. |
status |
String |
No |
Specifies the virtual gateway status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. |
admin_state_up |
Boolean |
No |
Specifies the administrative status of the virtual gateway. The value can be true or false. |
GET /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
{
"virtual_gateway" : {
"id" : "7ec892f3-ca64-46c7-863f-a2eb1b9e8389",
"tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
"name" : "virtual gateway1",
"description" : "",
"vpc_id" : "908d9cf3-da64-4acb-393f-e5eb6b9e838a",
"local_ep_group_id" : "f8834cf1-5468-87c7-223d-56e78b9699ab",
"device_id" : "aaa_01"
}
}
For details, see section Common Returned Values.