调用DiagnoseVpnGateway接口一键诊断指定的VPN网关实例。
接口说明
仅部分地域下的 VPN 网关实例支持一键诊断功能。关于地域的更多信息，请参见 VPN 网关功能支持的地域。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | VPN 网关实例所属的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-qingdao |
| ResourceId | string | 是 | 待诊断的资源 ID。 | vco-uf66xniofskqtuoz1**** |
| ResourceType | string | 是 | 待诊断的资源类型。 仅取值：IPsec，表示 IPsec 连接。 | IPsec |
| VpnGatewayId | string | 是 | VPN 网关实例 ID。 | vpn-m5efhj0k1p47ctuhl**** |
| IPsecExtendInfo | string | 否 | 检查指定地址间的私网连通性。取值：
| {"PrivateSourceIp":"192.168.1.1","PrivateDestinationIp":"192.168.0.1"} |
| ClientToken | string | 否 | 客户端 Token，用于保证请求的幂等性。 从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 02fb3da4-130e-11e9-8e44-001**** |
返回参数
示例
正常返回示例
JSON格式
{
"DiagnoseId": "vpndgn-uf6kuxbe3iv028k3s****",
"RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | IdempotentParameterMismatch | The 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. | - |
| 400 | VpnGateway.Configuring | The specified service is configuring. | 服务正在配置中，请您稍后再试。 |
| 400 | OperationUnsupported.DiagnoseVpn | Current version of the VPN does not support diagnose. | - |
| 400 | IllegalParam.ResourceType | The specified resource type [%s] is invalid. | - |
| 400 | OperationFailed.VpnGatewayDiagnosing | The VPN gateway is diagnosing. | - |
| 400 | OperationFailed.StartDiagnose | Start VPN gateway diagnose failed. | - |
| 400 | IllegalParam.PrivateSourceIp | The specified private source IP [%s] is invalid. | - |
| 400 | IllegalParam.PrivateDestinationIp | The specified private destination IP [%s] is invalid. | - |
| 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 网关是否正确。 |
| 404 | InvalidResourceId.NotFound | The specified resource id [%s] does not exist. | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史