调用DiagnoseVpnGateway接口一键诊断指定的VPN网关实例。

使用说明

仅部分地域下的VPN网关实例支持一键诊断功能。关于地域的更多信息，请参见VPN网关功能支持的地域。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DiagnoseVpnGateway

系统规定参数。取值：DiagnoseVpnGateway。

RegionId String 是 cn-qingdao

VPN网关实例所属的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

ResourceId String 是 vco-uf66xniofskqtuoz1****

待诊断的资源ID。
ResourceType String 是 IPsec

待诊断的资源类型。

仅取值：IPsec，表示IPsec连接。

VpnGatewayId String 是 vpn-m5efhj0k1p47ctuhl****

VPN网关实例ID。
IPsecExtendInfo String 否 {"PrivateSourceIp":"192.168.1.1","PrivateDestinationIp":"192.168.0.1"}

检查IPsec连接私网连通性时的配置信息。取值：

  • PrivateSourceIp：检查IPsec连接私网连通性时使用的源IP地址，源IP地址需为VPC侧的地址。
  • PrivateDestinationIp：检查IPsec连接私网连通性时使用的目的IP地址，目的IP地址需为本地数据中心侧的地址。
ClientToken String 否 02fb3da4-130e-11e9-8e44-001****

客户端Token，用于保证请求的幂等性。

从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。

返回数据

名称 类型 示例值 描述
DiagnoseId String vpndgn-uf6kuxbe3iv028k3s****

诊断ID。
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DiagnoseVpnGateway
&RegionId=cn-qingdao
&ResourceId=vco-uf66xniofskqtuoz1****
&ResourceType=IPsec
&VpnGatewayId=vpn-m5efhj0k1p47ctuhl****
&IPsecExtendInfo={"PrivateSourceIp":"192.168.1.1","PrivateDestinationIp":"192.168.0.1"}
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DiagnoseVpnGatewayResponse>
    <DiagnoseId>vpndgn-uf6kuxbe3iv028k3s****</DiagnoseId>
    <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
</DiagnoseVpnGatewayResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DiagnoseId" : "vpndgn-uf6kuxbe3iv028k3s****",
  "RequestId" : "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

错误码

HttpCode 错误码 错误信息 描述
400 VpnGateway.Configuring The specified service is configuring. 服务正在配置中，请您稍后再试。
403 Forbidden User not authorized to operate on the specified resource. 您没有权限操作指定资源，请申请权限后再操作。
404 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist. 指定的 VPN 网关不存在，请您检查 VPN 网关是否正确。

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