文档

DiagnoseVpnGateway - 一键诊断指定的VPN网关实例

更新时间:

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

接口说明

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

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

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

cn-qingdao
ResourceIdstring

待诊断的资源 ID。

vco-uf66xniofskqtuoz1****
ResourceTypestring

待诊断的资源类型。

仅取值:IPsec,表示 IPsec 连接。

IPsec
VpnGatewayIdstring

VPN 网关实例 ID。

vpn-m5efhj0k1p47ctuhl****
IPsecExtendInfostring

检查指定地址间的私网连通性。取值:

  • PrivateSourceIp:源 IP 地址。源 IP 地址需为 VPC 侧的地址。
  • PrivateDestinationIp:目的 IP 地址。目的 IP 地址需为本地数据中心侧的地址。
{"PrivateSourceIp":"192.168.1.1","PrivateDestinationIp":"192.168.0.1"}
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
02fb3da4-130e-11e9-8e44-001****

返回参数

名称类型描述示例值
object

返回结果。

DiagnoseIdstring

诊断 ID。

当前接口返回诊断 ID 后,您可以调用 GetVpnGatewayDiagnoseResult 接口查询诊断报告。

vpndgn-uf6kuxbe3iv028k3s****
RequestIdstring

请求 ID。

0ED8D006-F706-4D23-88ED-E11ED28DCAC0

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400IdempotentParameterMismatchThe 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.-
400VpnGateway.ConfiguringThe specified service is configuring.服务正在配置中,请您稍后再试。
400OperationUnsupported.DiagnoseVpnCurrent version of the VPN does not support diagnose.-
400IllegalParam.ResourceTypeThe specified resource type [%s] is invalid.-
400OperationFailed.VpnGatewayDiagnosingThe VPN gateway is diagnosing.-
400OperationFailed.StartDiagnoseStart VPN gateway diagnose failed.-
400IllegalParam.PrivateSourceIpThe specified private source IP [%s] is invalid.-
400IllegalParam.PrivateDestinationIpThe specified private destination IP [%s] is invalid.-
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。
404InvalidVpnGatewayInstanceId.NotFoundThe specified vpn gateway instance id does not exist.指定的 VPN 网关不存在,请您检查 VPN 网关是否正确。
404InvalidResourceId.NotFoundThe specified resource id [%s] does not exist.-

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)