Diagnoses a VPN gateway.
Operation description
Only VPN gateways in specific regions support the quick diagnostics feature. For more information about the supported regions, see Supported regions.
Debugging
Authorization information
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-qingdao |
| ResourceId | string | Yes | The ID of the resource to be diagnosed. | vco-uf66xniofskqtuoz1**** |
| ResourceType | string | Yes | The type of the resource. Set the value to Ipsec, which specifies an IPsec-VPN connection. | IPsec |
| VpnGatewayId | string | Yes | The ID of the VPN gateway. | vpn-m5efhj0k1p47ctuhl**** |
| IPsecExtendInfo | string | No | The configuration when you check the connectivity of the IPsec-VPN connection. Valid values:
| {"PrivateSourceIp":"192.168.1.1","PrivateDestinationIp":"192.168.0.1"} |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
| 02fb3da4-130e-11e9-8e44-001**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"DiagnoseId": "vpndgn-uf6kuxbe3iv028k3s****",
"RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | IdempotentParameterMismatch | The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. | - |
| 400 | VpnGateway.Configuring | The specified service is configuring. | The service is being configured. Try again later. |
| 400 | OperationUnsupported.DiagnoseVpn | Current version of the VPN does not support diagnose. | - |
| 400 | IllegalParam.ResourceType | The specified resource type [%s] is invalid. | - |
| 400 | OperationFailed.VpnGatewayDiagnosing | The VPN gateway is diagnosing. | - |
| 400 | OperationFailed.StartDiagnose | Start VPN gateway diagnose failed. | - |
| 400 | IllegalParam.PrivateSourceIp | The specified private source IP [%s] is invalid. | - |
| 400 | IllegalParam.PrivateDestinationIp | The specified private destination IP [%s] is invalid. | - |
| 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. |
| 404 | InvalidResourceId.NotFound | The specified resource id [%s] does not exist. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|