调用GetVpnGatewayDiagnoseResult接口查询VPN网关实例的一键诊断结果。
接口说明
调用 GetVpnGatewayDiagnoseResult 接口时,除必填参数外,DiagnoseId 和 VpnGatewayId 参数需至少输入一个。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | VPN 网关实例所属的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-qingdao |
DiagnoseId | string | 否 | 诊断 ID。 在您 DiagnoseVpnGateway 调用接口时,系统会返回对应的诊断 ID。 | vpndgn-uf6kuxbe3iv028k3s**** |
VpnGatewayId | string | 否 | VPN 网关实例 ID。 | vpn-uf6fzwp0ck3frwtbk**** |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 02fb3da4-130e-11e9-8e44-001**** |
返回参数
示例
正常返回示例
JSON
格式
{
"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****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 服务正在配置中,请您稍后再试。 |
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. | 您没有权限操作指定资源,请申请权限后再操作。 |
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. | 指定的 VPN 网关不存在,请您检查 VPN 网关是否正确。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史