Use DiagnoseVpnGateway to diagnose a VPN gateway - VPN Gateway - Alibaba Cloud - VPN Gateway

Calls the DiagnoseVpnGateway operation to perform a one-click diagnosis on a specified VPN gateway instance.

Operation description

Only VPN gateway instances in specific regions support the one-click diagnosis feature. For more information about regions, see Regions that support VPN Gateway features.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DiagnoseVpnGateway

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the VPN gateway instance. You can call the DescribeRegions operation to query the region ID.	cn-qingdao
ResourceId	string	Yes	The ID of the resource to be diagnosed.	vco-uf66xniofskqtuoz1****
ResourceType	string	Yes	The type of the resource to be diagnosed. The value can only be IPsec, which indicates an IPsec-VPN connection.	IPsec
VpnGatewayId	string	Yes	The instance ID of the VPN gateway.	vpn-m5efhj0k1p47ctuhl****
IPsecExtendInfo	string	No	Checks private network connectivity between specified addresses. Valid values: PrivateSourceIp: the source IP address. The source IP address must be an address on the VPC side. PrivateDestinationIp: the destination IP address. The destination IP address must be an address on the on-premises 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 ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	02fb3da4-130e-11e9-8e44-001****

Response elements

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

Examples

Success response

JSON format

{
  "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.
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.
404	InvalidResourceId.NotFound	The specified resource id [%s] does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.