調(diào)用GetVpnGatewayDiagnoseResult接口查詢VPN網(wǎng)關(guān)實(shí)例的一鍵診斷結(jié)果。
接口說明
調(diào)用 GetVpnGatewayDiagnoseResult 接口時，除必填參數(shù)外，DiagnoseId 和 VpnGatewayId 參數(shù)需至少輸入一個。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
當(dāng)前API暫無授權(quán)信息透出。
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | VPN 網(wǎng)關(guān)實(shí)例所屬的地域 ID。 您可以通過調(diào)用 DescribeRegions 接口獲取地域 ID。 | cn-qingdao |
| DiagnoseId | string | 否 | 診斷 ID。 在您 DiagnoseVpnGateway 調(diào)用接口時，系統(tǒng)會返回對應(yīng)的診斷 ID。 | vpndgn-uf6kuxbe3iv028k3s**** |
| VpnGatewayId | string | 否 | VPN 網(wǎng)關(guān)實(shí)例 ID。 | vpn-uf6fzwp0ck3frwtbk**** |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數(shù)值，確保不同請求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統(tǒng)自動使用 API 請求的 RequestId 作為 ClientToken 標(biāo)識。每次 API 請求的 RequestId 不一樣。
| 02fb3da4-130e-11e9-8e44-001**** |
返回參數(shù)
示例
正常返回示例
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. | 服務(wù)正在配置中，請您稍后再試。 |
| 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. | 您沒有權(quán)限操作指定資源，請申請權(quán)限后再操作。 |
| 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 網(wǎng)關(guān)不存在，請您檢查 VPN 網(wǎng)關(guān)是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|
暫無變更歷史