擷取使用者輸入IP地址到指定資料庫執行個體的網路連通性診斷結果。
介面說明
使用該介面需滿足以下前提條件:
使用阿里雲或 DAS 的 SDK 時,建議使用最新版本。
使用 SDK 調用 DAS 服務時,需要將地區指定為 cn-shanghai。
資料庫執行個體已接入 DAS。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
hdm:GetDBInstanceConnectivityDiagnosis |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| InstanceId |
string |
是 |
執行個體 ID。 |
rm-2ze8g2am97624**** |
| SrcIp |
string |
是 |
源 IP 位址。 |
47.100.XX.XX |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回資訊列表。 |
||
| Code |
string |
返回的狀態代碼。 |
200 |
| Message |
string |
請求返回訊息。 說明
請求成功時該參數返回 Successful,請求失敗時會返回請求異常資訊(如錯誤碼等)。 |
Successful |
| Data |
object |
詳細資料列表。 |
|
| instanceId |
string |
執行個體 ID。 |
rm-2ze8g2am97624**** |
| success |
boolean |
是否檢測通過:
|
false |
| failType |
string |
異常類型:
|
0 |
| connCheckErrorCode |
string |
異常檢測項:
|
SRC_IP_NOT_IN_USER_WHITELIST |
| connCheckErrorMessage |
string |
異常檢測詳情資訊。 |
Src ip:47.100.XX.XX not in user whitelist |
| RequestId |
string |
請求 ID。 |
B6D17591-B48B-4D31-9CD6-9B9796B2**** |
| Success |
string |
請求是否執行成功:
|
true |
樣本
正常返回樣本
JSON格式
{
"Code": "200",
"Message": "Successful",
"Data": {
"instanceId": "rm-2ze8g2am97624****",
"success": false,
"failType": "0",
"connCheckErrorCode": "SRC_IP_NOT_IN_USER_WHITELIST",
"connCheckErrorMessage": "Src ip:47.100.XX.XX not in user whitelist"
},
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Success": "true"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. | |
| 403 | NoPermission | You are not authorized to do this action. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。