Call the DiagnoseVpnConnections API to diagnose IPsec-VPN connections - VPN Gateway - Alibaba Cloud - VPN Gateway

Diagnoses IPsec-VPN connections.

Operation description

For single-tunnel mode, the VpnConnectionIds request parameter is required.
For dual-tunnel mode, the TunnelIds request parameter is required.
If the IPsec-VPN connection is faulty, the operation returns an error code (FailedReasonCode) and a log (SourceLog) for troubleshooting. For more information, see Common errors and troubleshooting methods for IPsec-VPN connections.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the IPsec-VPN connection. You can call the DescribeRegions operation to query the most recent region list.	cn-qingdao
VpnGatewayId	string	No	The ID of the VPN gateway.	vpn-bp10hz6b0mbp39flt****
VpnConnectionIds	array	No	The IDs of IPsec-VPN connections.
	string	No	The ID of the IPsec-VPN connection. Note This parameter is required if the IPsec-VPN connection is in single-tunnel mode.	vco-bp1spxu8hlcvpd7ry****
TunnelIds	array	No	The list of tunnel IDs.
	string	No	The tunnel ID. Note This parameter is required if the IPsec-VPN connection is in dual-tunnel mode.	tun-64n1sr9dig64k6****
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	B8094E1E-935B-1397-96A8-4F87A5D1BF29
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The number of entries returned.	1
VpnConnections	array<object>	The diagnostic information.
	object
MismatchRemoteParam	string	The mismatched parameter value on the peer gateway device. Returned when the IPsec-VPN connection and the peer gateway device have different parameter configurations.	SHA
MismatchLocalParam	string	The mismatched parameter value on the IPsec-VPN connection side. Returned when the IPsec-VPN connection and the peer gateway device have different parameter configurations.	SHA256
VpnConnectionId	string	The ID of the IPsec-VPN connection.	vco-bp1spxu8hlcvpd7ry****
SourceLog	string	The error log.	2023-01-13 11:39:21 vco-bp1spxu8hlcvpd7ry**** [PROTO_ERR]: ikev1.c:1433:isakmp_ph1resend(): phase1 negotiation failed due to time up. [{remote id:4}{ph1: 172.16.0.88[500] <=> 192.168.0.206[500], 172.16.0.88 <=> 192.168.0.206}]
FailedReasonCode	string	The error code.	Phase1NegotiationTimeout
FailedTime	integer	The UNIX timestamp, in milliseconds, when the error occurred on the IPsec-VPN connection.	1673581161000
FailedReason	string	The cause of the error.	Phase1 negotiation timeout
Severity	string	The error level. Valid values: Critical Warn Normal	Warn
TunnelId	string	The tunnel ID.	tun-64n1sr9dig64k6****

Examples

Success response

JSON format

{
  "RequestId": "B8094E1E-935B-1397-96A8-4F87A5D1BF29",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "VpnConnections": [
    {
      "MismatchRemoteParam": "SHA",
      "MismatchLocalParam": "SHA256",
      "VpnConnectionId": "vco-bp1spxu8hlcvpd7ry****",
      "SourceLog": "2023-01-13 11:39:21 vco-bp1spxu8hlcvpd7ry**** [PROTO_ERR]: ikev1.c:1433:isakmp_ph1resend(): phase1 negotiation failed due to time up. [{remote id:4}{ph1: 172.16.0.88[500] <=> 192.168.0.206[500], 172.16.0.88 <=> 192.168.0.206}]",
      "FailedReasonCode": "Phase1NegotiationTimeout",
      "FailedTime": 1673581161000,
      "FailedReason": "Phase1 negotiation timeout",
      "Severity": "Warn",
      "TunnelId": "tun-64n1sr9dig64k6****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The parameter 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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.