DiagnoseVpnConnections - 诊断IPsec连接_专有网络VPC(VPC)-阿里云帮助中心

调用DiagnoseVpnConnections接口诊断IPsec连接。

接口说明

如果 IPsec 连接为单隧道模式，调用 DiagnoseVpnConnections 接口时，请求参数VpnConnectionIds必填。
如果 IPsec 连接为双隧道模式，调用 DiagnoseVpnConnections 接口时，请求参数TunnelIds必填。
调用 DiagnoseVpnConnections 接口后，如果当前 IPsec-VPN 连接存在问题，接口会返回对应的错误码（即返回参数 FailedReasonCode）和日志信息（即返回参数 SourceLog）。您可以根据错误码和日志信息自主排查问题。排查方法，请参见IPsec-VPN 连接常见错误及排查方法汇总。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DiagnoseVpnConnections	Read	VpnConnection acs:vpc:{#regionId}:{#accountId}:*	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	IPsec 连接所属地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-qingdao
VpnGatewayId	string	否	VPN 网关实例 ID。	vpn-bp10hz6b0mbp39flt****
VpnConnectionIds	array	否	IPsec 连接 ID 列表。
	string	否	IPsec 连接 ID。说明如果 IPsec 连接为单隧道模式，该参数必填。	vco-bp1spxu8hlcvpd7ry****
TunnelIds	array	否	隧道 ID 列表。
	string	否	隧道 ID。说明如果 IPsec 连接为双隧道模式，该参数必填。	tun-64n1sr9dig64k6****
PageNumber	integer	否	列表的页码。默认值：1。	1
PageSize	integer	否	分页查询时每页的条目数。默认值：10。	10

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	B8094E1E-935B-1397-96A8-4F87A5D1BF29
PageNumber	integer	列表的页码。	1
PageSize	integer	分页查询时每页的条目数。	10
TotalCount	integer	列表条目数。	1
VpnConnections	object []	IPsec-VPN 连接的诊断信息列表。
MismatchRemoteParam	string	在 IPsec 连接和对端网关设备配置的参数值不匹配的情况下，本参数表示对端网关设备配置的参数值。	SHA
MismatchLocalParam	string	在 IPsec 连接和对端网关设备配置的参数值不匹配的情况下，本参数表示 IPsec 连接配置的参数值。	SHA256
VpnConnectionId	string	IPsec 连接 ID。	vco-bp1spxu8hlcvpd7ry****
SourceLog	string	当前错误相关的日志信息。	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	错误码。	Phase1NegotiationTimeout
FailedTime	long	IPsec-VPN 连接发生当前错误的时间戳。单位：毫秒。时间戳的格式采用 Unix 时间戳，表示从格林威治时间 1970 年 01 月 01 日 00 时 00 分 00 秒至 IPsec-VPN 连接发生当前错误时的总时长。	1673581161000
FailedReason	string	错误原因。	Phase1 negotiation timeout
Severity	string	当前错误等级。 Critical：严重，请尽快排查处理。 Warn：警告，建议尽快排查处理。 Normal：正常。	Warn
TunnelId	string	隧道 ID。	tun-64n1sr9dig64k6****

示例

正常返回示例

JSON格式

{
  "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****"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The parameter is invalid.	该参数值不合法。
403	Forbidden	User not authorized to operate on the specified resource.	您没有权限操作指定资源，请申请权限后再操作。

访问错误中心查看更多错误码。