Diagnoses a VPN gateway.
Description
Only VPN gateways in specific regions support the quick diagnostics feature. For more information about the supported regions, see Supported regions.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DiagnoseVpnGateway | The operation that you want to perform. Set the value to DiagnoseVpnGateway. |
RegionId | String | Yes | cn-qingdao | The region ID of the VPN gateway. You can call the DescribeRegions operation to query the most recent region list. |
ResourceId | String | Yes | vco-uf66xniofskqtuoz1**** | The ID of the resource to be diagnosed. |
ResourceType | String | Yes | IPsec | The type of the resource. Set the value to Ipsec, which specifies an IPsec-VPN connection. |
VpnGatewayId | String | Yes | vpn-m5efhj0k1p47ctuhl**** | The ID of the VPN gateway. |
IPsecExtendInfo | String | No | {"PrivateSourceIp":"192.168.1.1","PrivateDestinationIp":"192.168.0.1"} | The configuration when you check the connectivity of the IPsec-VPN connection. Valid values:
|
ClientToken | String | No | 02fb3da4-130e-11e9-8e44-001**** | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. ClientToken can contain only ASCII characters.
Note If you do not set this parameter, ClientToken is set to the value of RequestId. The ID of each request may be different.
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
DiagnoseId | String | vpndgn-uf6kuxbe3iv028k3s**** | The ID of the diagnostic operation. |
RequestId | String | 0ED8D006-F706-4D23-88ED-E11ED28DCAC0 | The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DiagnoseVpnGateway
&RegionId=cn-qingdao
&ResourceId=vco-uf66xniofskqtuoz1****
&ResourceType=IPsec
&VpnGatewayId=vpn-m5efhj0k1p47ctuhl****
&IPsecExtendInfo={"PrivateSourceIp":"192.168.1.1","PrivateDestinationIp":"192.168.0.1"}
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DiagnoseVpnGatewayResponse>
<DiagnoseId>vpndgn-uf6kuxbe3iv028k3s****</DiagnoseId>
<RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
</DiagnoseVpnGatewayResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"DiagnoseId" : "vpndgn-uf6kuxbe3iv028k3s****",
"RequestId" : "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | VpnGateway.Configuring | The specified service is configuring. | The error message returned because the operation is not allowed when the specified service is being configured. Try again later. |
403 | Forbidden | User not authorized to operate on the specified resource. | The error message returned because you are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again. |
404 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id does not exist. | The error message returned because the specified VPN gateway does not exist. Check whether the specified VPN gateway is valid. |
For a list of error codes, see Service error codes.