调用GetVpnGatewayDiagnoseResult接口查询VPN网关实例的一键诊断结果。
接口说明
调用 GetVpnGatewayDiagnoseResult 接口时,除必填参数外,DiagnoseId 和 VpnGatewayId 参数需至少输入一个。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
vpc:GetVpnGatewayDiagnoseResult |
get |
*VpnGateway
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| 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**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| BeginTime |
string |
诊断开始的时间。 时间按照 ISO8601 标准表示,并使用 UTC 时间。格式为: |
2022-12-15T05:28:57Z |
| DiagnoseId |
string |
诊断 ID。 |
vpndgn-uf6sgneym02lxyuv4**** |
| DiagnoseResult |
array<object> |
诊断项信息列表。 |
|
|
object |
诊断项信息。 |
||
| DiagnoseName |
string |
诊断项。
关于每个诊断项的说明信息,请参见一键诊断背景信息。 |
RouteEntryConflict |
| DiagnoseResultDescription |
string |
诊断项的诊断结果。 针对每个诊断项,接口会返回不同的信息,说明如下:
|
{\"targetIp\":\"192.168.0.1\",\"srcIp\":\"192.168.1.1\",\"rtt\":-1.0,\"lossRate\":100.0} |
| DiagnoseResultLevel |
string |
诊断项的诊断结果级别。
关于每个诊断项对应的每个诊断结果级别的说明,请参见一键诊断背景信息。 |
normal |
| FinishTime |
string |
诊断结束的时间。 时间按照 ISO8601 标准表示,并使用 UTC 时间。格式为: |
2022-12-15T05:29:08Z |
| FinishedCount |
integer |
已完成诊断的诊断项数量。 |
7 |
| RequestId |
string |
请求 ID。 |
312C4D5A-6563-5FC6-8C6E-A43A5A316FEB |
| ResourceInstanceId |
string |
诊断的资源 ID。 |
vco-uf6huqsu63azl7mdp**** |
| ResourceType |
string |
诊断的资源类型。 取值:IPsec,表示 IPsec 连接。 |
IPsec |
| TotalCount |
integer |
诊断项总数。 |
7 |
| VpnGatewayId |
string |
VPN 网关实例 ID。 |
vpn-uf6fzwp0ck3frwtbk**** |
示例
正常返回示例
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. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。