查詢實例角色信息v2
更新時間 2025-10-22 18:12:24
最近更新時間: 2025-10-22 18:12:24
分享文章
接口功能介紹
查詢文檔數據庫實例的角色信息
接口約束
無
URI
GET /DDS2/v2/openApi/describeInstanceRole
路徑參數 無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 文檔數據庫對外的實例標識 | 60d420bffb394************************* |
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 項目id | 0 | |
| regionId | 是 | String | 資源池id | bb9fdb42056f11eda1610242ac110002 |
請求體body參數 無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應碼 取值范圍：800為成功，900為失敗 | 800 | |
| message | String | 響應信息 | 查詢文檔數據庫服務的實例角色信息成功 | |
| returnObj | Object | 返回對象數組 | returnObj | |
| error | String | 錯誤碼。當接口失敗時才返回具體錯誤編碼，成功不返回或者為空。 | ||
| 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/describeInstanceRole?prodInstId=60d420bffb394*************************
請求頭header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
請求體body
無
響應示例
{
"statusCode": 800,
"message": "查詢文檔數據庫服務的實例角色信息成功",
"returnObj": [
{
"elasticIp": "",
"node": "set_1098350_1",
"role": "master",
"alive": 1,
"vpcIpv6": "",
"port": "8350",
"host": "172.27.***.***",
"prodInstId": "60d420bffb394*************************",
"type": null,
"resId": 67
}
]
}
狀態碼
請參考
錯誤碼
請參考
