DiagnoseVpnGateway - VPN Gateway - Alibaba Cloud Documentation Center

Diagnoses a VPN gateway.

Debugging

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is 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:DiagnoseVpnGateway	get	All Resources ``	none	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-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	Check the connectivity of the destination address. Valid values: PrivateSourceIp: the source IP address. The source IP address must be on the VPC side. PrivateDestinationIp: the destination IP address. The destination IP address must be on the data center side.	{"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

Parameter	Type	Description	Example
	object	The response parameters.
DiagnoseId	string	The diagnostic ID. After a diagnostic ID is returned, you can call GetVpnGatewayDiagnoseResult to query the diagnostic report.	vpndgn-uf6kuxbe3iv028k3s****
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0

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
2025-05-23	The Error code has changed	View Change Details