All Products
Document Center

Virtual Private Cloud:DiagnoseVpnGateway

Last Updated:Dec 02, 2023

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.


You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.


Authorization information

There is currently no authorization information disclosed in the API.

Request parameters


The region ID of the VPN gateway.

You can call the DescribeRegions operation to query the most recent region list.


The ID of the resource to be diagnosed.


The type of the resource.

Set the value to Ipsec, which specifies an IPsec-VPN connection.


The ID of the VPN gateway.


The configuration when you check the connectivity of the IPsec-VPN connection. Valid values:

  • PrivateSourceIp: the source IP address used when you check the connectivity of the IPsec-VPN connection. The source IP address must be on the VPC side.
  • PrivateDestinationIp: the destination IP address used when you check the connectivity of the IPsec-VPN connection. The destination IP address must be on the data center side.

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.

Response parameters


The returned data.


The ID of the diagnostic.


The request ID.



Sample success responses


  "DiagnoseId": "vpndgn-uf6kuxbe3iv028k3s****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"

Error codes

HTTP status codeError codeError messageDescription
400IdempotentParameterMismatchThe 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.-
400VpnGateway.ConfiguringThe specified service is configuring.The service is being configured. Try again later.
400OperationUnsupported.DiagnoseVpnCurrent version of the VPN does not support diagnose.-
400IllegalParam.ResourceTypeThe specified resource type [%s] is invalid.-
400OperationFailed.VpnGatewayDiagnosingThe VPN gateway is diagnosing.-
400OperationFailed.StartDiagnoseStart VPN gateway diagnose failed.-
400IllegalParam.PrivateSourceIpThe specified private source IP [%s] is invalid.-
400IllegalParam.PrivateDestinationIpThe specified private destination IP [%s] is invalid.-
403ForbiddenUser 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.
404InvalidVpnGatewayInstanceId.NotFoundThe specified vpn gateway instance id does not exist.The specified VPN gateway does not exist. Check whether the specified VPN gateway is valid.
404InvalidResourceId.NotFoundThe specified resource id [%s] does not exist.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history