查詢一個或多個MongoDB實例的概覽信息
更新時間 2023-08-29 15:13:50
最近更新時間: 2023-08-29 15:13:50
分享文章
接口功能介紹
調用describeDBInstancesOverview查詢一個或多個MongoDB實例的概覽信息。
接口約束
無
URI
GET /v1/openApi/describeDBInstancesOverview
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| prodInstIds | 是 | String | 產品ID | 555b89493b1a40e1b97ea05e50dd8170 |
請求參數
請求頭header參數
無
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 是 | String | 返回碼 取值范圍：800 成功 |
800 | |
| message | 是 | String | 返回消息 | ||
| returnObj | 是 | Object[] | 返回對象數組 | returnObj |
表 returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| prodInstName | 是 | String | 實例名稱 | mongodb001 | |
| userId | 是 | Integer | 用戶id | 124 | |
| enableSSL | 是 | Integer | 'enableSSL表示是否開啟ssl連接，1表示開啟，0表示未開啟' | 1 | |
| diskSize | 是 | Integer | 磁盤空間 | 300 | |
| createTime | 是 | Integer | 創建時間 | 1658458503000 | |
| port | 是 | String | 主機端口 | 8350 | |
| diskRate | 是 | String | 查詢磁盤使用率 | 32% | nodeInfoVOS |
nodeInfoVOS
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| node | 是 | String | 子節點名稱 | mongodb001 | |
| role | 是 | String | 角色 | master | |
| vpcIpv6 | 是 | Integer | vpc內部的ipv6地址 | ||
| port | 是 | String | 主機端口 | 8832 | |
| host | 是 | String | 主機地址 | 172.27.176.109 | |
| prodInstId | 是 | String | 實例id | ||
| resId | 是 | Integer | 唯一標志該mongodb |
請求示例
請求頭header
無
請求參數query
/v1/openApi/describeDBInstancesOverview?prodInstIds=555b89493b1a40e1b97ea05e50dd8170
響應示例
{
"statusCode": 800,
"message": "查詢MongoDB實例概覽信息成功",
"returnObj": [
{
"prodInstName": "mongodb001",
"prodType": null,
"userId": 149,
"enableSSL": 0,
"diskSize": 3072,
"createTime": 1658458503000,
"port": "8350",
"prodRunningStatus": 0,
"diskRate": "14%",
"nodeInfoVOS": [
{
"elasticIp": "",
"node": "set_1098350_1",
"role": "master",
"alive": 1,
"vpcIpv6": "",
"port": "8350",
"host": "172.27.176.109",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"type": null,
"resId": 67
}
],
"host": "172.27.176.109",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"machineSpec": "64C500G"
}
]
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功。 |
| 900 | 請求響應失敗，失敗原因見message |
錯誤碼
請參考錯誤碼說明。
