GetVpnGatewayDiagnoseResult - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries the diagnostic result of a VPN gateway.

Operation description

When you call the GetVpnGatewayDiagnoseResult operation, you must specify one of DiagnoseId and VpnGatewayId.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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
DiagnoseId	string	No	The ID of the diagnostic operation. When you call the DiagnoseVpnGateway operation, the system returns a corresponding ID.	vpndgn-uf6kuxbe3iv028k3s****
VpnGatewayId	string	No	The ID of the VPN gateway.	vpn-uf6fzwp0ck3frwtbk****
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. Description** 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 returned data.
BeginTime	string	The time when the diagnostic started. The time follows the ISO8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2022-12-15T05:28:57Z
DiagnoseId	string	The ID of the diagnostic.	vpndgn-uf6sgneym02lxyuv4****
DiagnoseResult	object []	The information about the diagnostic items.
DiagnoseName	string	The diagnostic item. RouteEntryConflict: route conflicts. VpnRouteQuota: the quota of destination-based routes for the VPN gateway. VpnIPsecQuota: the quota of IPsec-VPN connections for the VPN gateway. VpnPbrRouteQuota: the quota of policy-based routes for the VPN gateway. VcoConfigConsistency: the consistency of the IPsec-VPN connection. VcoUserInternetIpConnectivity: Internet connectivity of the customer gateway. VcoPrivateConnectivity: private network connectivity. For more information about the diagnostic items, see Background information about quick diagnostics.	RouteEntryConflict
DiagnoseResultDescription	string	The diagnostic result. The system returns different results for each diagnostic item. RouteEntryConflict: information about route conflicts. VpnRouteQuota: quotaName: the quota ID of destination-based routes. quantity: the quota of destination-based routes for the VPN gateway. used: the number of destination-based routes created for the VPN gateway. VpnIPsecQuota: quotaName: the quota ID of IPsec-VPN connections. quantity: the quota of IPsec-VPN connections for the VPN gateway. used: the number of IPsec-VPN connections created for the VPN gateway. VpnPbrRouteQuota: quotaName: the quota ID of policy-based routes. quantity: the quota of policy-based routes for the VPN gateway. used: the number of policy-based routes created for the VPN gateway. VcoConfigConsistency: vcoLackConf: The system cannot obtain the configuration of the peer of the IPsec-VPN connection. vcoRunningConf: the configurations that have been added to the peer of the IPsec-VPN connection. vcoDiffConf: the configurations that are inconsistent between the local end and the peer. vcoConf: the configurations that have been added to the local end. VcoUserInternetIpConnectivity: targetIp: the public IP address of the customer gateway. rtt: the latency when the system accesses the public IP address of the customer gateway. Unit: milliseconds. lossRate: the packet loss when the system accesses the public IP address of the customer gateway. VcoPrivateConnectivity: targetIp: the source IP address. srcIp: the destination IP address. rtt: the latency when the source IP address accesses the destination IP address. Unit: milliseconds. lossRate: the packet loss when the source IP address accesses the destination IP address.	{\"targetIp\":\"192.168.0.1\",\"srcIp\":\"192.168.1.1\",\"rtt\":-1.0,\"lossRate\":100.0}
DiagnoseResultLevel	string	The diagnostic result level. normal warning error For more information, see Background information about quick diagnostics.	normal
FinishTime	string	The timestamp when the system finishes diagnosing the item. The time follows the ISO8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2022-12-15T05:29:08Z
FinishedCount	integer	The number of diagnostic items that have been diagnosed.	7
RequestId	string	The request ID.	312C4D5A-6563-5FC6-8C6E-A43A5A316FEB
ResourceInstanceId	string	The ID of the resource that is diagnosed.	vco-uf6huqsu63azl7mdp****
ResourceType	string	The type of the resource. The value is set to IPsec, which indicates an IPsec-VPN connection.	IPsec
TotalCount	integer	The total number of diagnostic items.	7
VpnGatewayId	string	The ID of the VPN gateway.	vpn-uf6fzwp0ck3frwtbk****

Examples

Sample success responses

JSONformat

{
  "BeginTime": "2022-12-15T05:28:57Z",
  "DiagnoseId": "vpndgn-uf6sgneym02lxyuv4****",
  "DiagnoseResult": [
    {
      "DiagnoseName": "RouteEntryConflict",
      "DiagnoseResultDescription": "{\\\"targetIp\\\":\\\"192.168.0.1\\\",\\\"srcIp\\\":\\\"192.168.1.1\\\",\\\"rtt\\\":-1.0,\\\"lossRate\\\":100.0}",
      "DiagnoseResultLevel": "normal"
    }
  ],
  "FinishTime": "2022-12-15T05:29:08Z",
  "FinishedCount": 7,
  "RequestId": "312C4D5A-6563-5FC6-8C6E-A43A5A316FEB",
  "ResourceInstanceId": "vco-uf6huqsu63azl7mdp****",
  "ResourceType": "IPsec",
  "TotalCount": 7,
  "VpnGatewayId": "vpn-uf6fzwp0ck3frwtbk****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	param_error	The param is must be in ...	-
400	MissingParam.DiagnoseInfo	The VPN gateway ID and diagnose ID cannot be empty at the same time.	-
400	VpnGateway.Configuring	The specified service is configuring.	The service is being configured. Try again later.
400	IncorrectStatus.DiagnoseTimeout	Diagnose failed because of timeout.	-
400	IncorrectStatus.VpnConnectionDeleted	Diagnose failed because the VPN connection has been deleted.	-
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	InvalidDiagnoseId.NotFound	The specified diagnose ID [%s] does not exist.	-
404	InvalidVpnGatewayId.NotFound	The specified VPN gateway [%s] does not have any diagnoses.	-
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.

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

Change history

Change time	Summary of changes	Operation

No change history