調用DiagnoseVpnGateway介面一鍵診斷指定的VPN網關執行個體。
介面說明
僅部分地區下的 VPN 閘道執行個體支援一鍵診斷功能。關於地區的更多資訊，請參見 VPN 閘道功能支援的地區。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| 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**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| DiagnoseId |
string |
診斷 ID。 當前介面返回診斷 ID 後，您可以調用 GetVpnGatewayDiagnoseResult 介面查詢診斷報告。 |
vpndgn-uf6kuxbe3iv028k3s**** |
| RequestId |
string |
請求 ID。 |
0ED8D006-F706-4D23-88ED-E11ED28DCAC0 |
樣本
正常返回樣本
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. | |
| 404 | InvalidResourceId.NotFound | The specified resource id [%s] does not exist. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。