查詢實例概覽信息v2
更新時間 2025-10-23 16:57:34
最近更新時間: 2025-10-23 16:57:34
分享文章
接口功能介紹
查詢一個或多個文檔數據庫實例的概覽信息
接口約束
無
URI
GET /DDS2/v2/openApi/describeDBInstancesOverview
路徑參數 無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| prodInstIds | 是 | String | 產品ID | 60d420bffb394************************* |
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 項目id | 0 | |
| regionId | 是 | String | 資源池id | bb9fdb42056f11eda1610242ac110002 |
請求體body參數 無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | String | 返回碼 取值范圍：800 成功 | 800 | |
| message | String | 返回消息 | 查詢MongoDB實例概覽信息成功 | |
| returnObj | Array of Objects | 返回對象數組 | returnObj | |
| error | String | 錯誤碼。當接口失敗時才返回具體錯誤編碼，成功不返回或者為空。 | ||
| 表 returnObj |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| subnet | String | 子網信息 | subnet-test | |
| backup | Object | 備份節點信息 | backup | |
| vpcName | String | vpc名稱 | vpc-001-test | |
| vpcId | String | vpcid | vpc-brgeuyks6f | |
| prodInstName | String | 實例名稱 | test001 | |
| prodType | Integer | 0:單機 2:副本集(三節點) 4:副本集(五節點) 6:副本集(七節點) 10:分片集群 | 0 | |
| userId | Integer | 用戶id | 111 | |
| enableSSL | Integer | enableSSL表示是否開啟ssl連接，1表示開啟，0表示未開啟 | 0 | |
| securityGroupId | String | 安全組id | sg-0sfcsg | |
| diskSize | Integer | 存儲空間大小/G | 100 | |
| createTime | String | 實例創建時間 | 2022-10-10 00:00:00 | |
| port | String | 數據庫端口 | ||
| prodRunningStatus | Integer | 實例的運行狀態: 0:運行正常 1:重啟中 2:備份操作中 3:恢復操作中 4:轉換 SSL 6:修改參數組中 7:已凍結 8:已注銷 9:施工中 11:擴容中 12:主備切換中 | 0 | |
| diskRate | String | 磁盤使用率 | 10% | |
| host | String | 主節點host | 67 | |
| prodInstId | String | 實例id | 60d420bffb394************************* | |
| machineSpec | String | 實例規格 | 64C500G | |
| cpuType | Integer | cpu類型，10-Kunpeng，20-Haiguang，30-Intel，40-AMD，50-Feiteng，60-Longxin，70-Zhaoxin | 30 | |
| hostSeries | String | 性能類型，S系列-通用型，C系列-計算增強型，M系列-內存優化型 | S7 | |
| diskType | String | 磁盤類型 | SAS | |
| nodeInfoVOS | Array of Objects | 節點信息 | nodeInfoVOS | |
| 表 backup |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| usepercent | String | 磁盤空間使用率 | 10% | |
| size | String | 磁盤空間大小 | 100G | |
| used | String | 磁盤空間使用大小 | 10G | |
| 表 nodeInfoVOS |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| elasticIp | String | 彈性ip | 127.0.0.1 | |
| node | String | 該mongodb的標簽，規定為“set_ + 三個尾部ip + 端口號” | set_1098350_1 | |
| role | String | 角色 | master | |
| alive | Integer | 取自mongodb中的ok屬性 | 0 | |
| vpcIpv6 | String | vpc內部的ipv6地址 | ||
| port | String | 訪問該mongodb的端口 | 888 | |
| resId | Integer | 唯一標志該mongodb | 67 | |
| outerElasticIpId | String | eipId | eip-qa0lwiyqe7 | |
| allowBeMaster | Boolean | 允許切換成為備用節點 | true | |
| memory | Integer | 內存 | 12 | |
| usedSpace | String | 已使用空間 | null | |
| type | String | 組件類型 | null | |
| azDisplayName | String | 可用區展示名 | az1 | |
| azId | String | 可用區id | ||
| ipv6Bind | Byte | 綁定ipv6帶寬標記位, 0表示未綁定, 1表示綁定 | ||
| uuid | String | 機器uuid | ||
| diskSize | String | 存儲空間 | ||
| host | String | 機器節點的vpc ip地址 | ||
| prodInstSetName | String | 實例set名稱 | ||
| cpuCount | Integer | cpu核數 | ||
| realIp | String | 實際管理ip | ||
| ipv6Cidrs | String | ipv6 網段 | ||
| prodType | Byte | 節點類型（分片集群才有該值） | ||
| regionId | String | 資源池id | ||
| prodInstId | String | 實例id |
枚舉參數
無
請求示例
請求url
/v1/openApi/describeDBInstancesOverview?prodInstIds=60d420bffb394*************************
請求頭header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
請求體body
無
響應示例
{
"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.***.***",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"type": null,
"resId": 67
}
],
"host": "172.27.***.***",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"machineSpec": "64C500G"
}
]
}
狀態碼
請參考
錯誤碼
請參考
