Queries the detailed information about a VPN gateway.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vpc:DescribeVpnGateway | get | *VpnGateway acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the VPN gateway. You can call the DescribeRegions operation to query the most recent region list. | cn-zhangjiakou |
| VpnGatewayId | string | Yes | The ID of the VPN gateway. | vpn-bp1r3v1xqkl0w519g**** |
| IncludeReservationData | boolean | No | Specifies whether to include the data about pending orders. Valid values:
| true |
Response parameters
Examples
Sample success responses
JSONformat
{
"VpnType": "Normal",
"Status": "init",
"VpcId": "vpc-bp19m2yx1m5q0avyq****",
"SslMaxConnections": 5,
"Spec": "5",
"InternetIp": "47.22.XX.XX",
"CreateTime": 1495382400000,
"AutoPropagate": true,
"ChargeType": "China site (aliyun.com): Prepay. International site (alibabacloud.com): POSTPAY.",
"VpnGatewayId": "vpn-bp1r3v1xqkl0w519g****",
"Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"forwarding1.3.7\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\"}",
"IpsecVpn": "enable",
"EndTime": 1544666102000,
"VSwitchId": "vsw-bp1dmzugdikc6hdgx****",
"RequestId": "27E4E088-8DE0-4672-BF5C-0A412389DB9E",
"Description": "vpngatewaydescription",
"EnableBgp": true,
"BusinessStatus": "Normal",
"SslVpn": "enable",
"Name": "vpngatewayname",
"ReservationData": {
"Status": "1",
"ReservationOrderType": "TEMP_UPGRADE",
"ReservationIpsec": "enable",
"ReservationSpec": "5",
"ReservationSsl": "enable",
"ReservationMaxConnections": 5,
"ReservationEndTime": "2020-07-20T16:00:00Z"
},
"Tags": {
"Tag": [
{
"Key": "aaa",
"Value": "bbb"
}
]
},
"NetworkType": "public",
"DisasterRecoveryInternetIp": "47.91.XX.XX",
"DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
"SslVpnInternetIp": "47.74.XX.XX",
"ResourceGroupId": "rg-acfmzs372yg****",
"EniInstanceIds": {
"EniInstanceId": [
"eni-7xvcxgmd4y2ypibn****"
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 403 | Forbbiden.SubUser | User not authorized to operate on the specified resource as your account is created by another user. | You are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again. |
| 403 | Forbidden | User not authorized to operate on the specified resource. | You do not have the permissions to manage the specified resource. Apply for the permissions and try again. |
| 404 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id does not exist. | The specified VPN gateway does not exist. Check whether the specified VPN gateway is valid. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-05-06 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-10-19 | API Description Update. The API operation is not deprecated.. The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-06-30 | The Error code has changed. The response structure of the API has changed | View Change Details |