DescribeVpnGateways
Description
call the DescribeVpnGateways interface to query the created VPN gateway.
Request Method
POST
Request Path
/apsara/route/Vpc/DescribeVpnGateways
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| Status | BODY | string | No | init | status of VPN gateway, value: init : initialization. provisioning: in preparation. active : normal. updating : Updating. deleting : being deleted. |
| VpcId | BODY | string | No | vpc-bp1ub1yt9cvakoelj**** | ID of VPC to which VPN gateway belongs. |
| PageSize | BODY | integer | No | 10 | The number of rows per page during paging query, the maximum value is 50, the default value is 10. |
| VpnGatewayId | BODY | string | No | vpn-bp1q8bgx4xnkm2ogj**** | VPN gateway ID. |
| PageNumber | BODY | integer | No | 1 | page number of the list, the default value is 1. |
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| RegionId | BODY | string | Yes | cn-qingdao-env66-d01 | the region ID where the VPN gateway is located. you can obtain the region by calling DescribeRegions interface ID. |
| BusinessStatus | BODY | string | No | Normal | the payment status of the VPN gateway. Value: Normal : normal. FinancialLocked: overdue lock. |
| version | BODY | string | No | 2016-01-01 | version of api |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| RequestID | string | 1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC | Request id |
Example
Successful Response example
{
"RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}