調用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. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史