查詢實例詳情
更新時間 2023-08-29 15:13:49
最近更新時間: 2023-08-29 15:13:49
分享文章
接口功能介紹
調用describeDBInstanceAttribute查詢實例詳情。
接口約束
無
URI
GET /v1/openApi/describeDBInstanceAttribute
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| prodInstId | *必填 | String | 文檔數據庫對外的實例標識 | a649077e15f349cb8b4cde6f7285a568 |
請求參數
請求頭header參數
無
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 響應碼 取值范圍：800為成功，900為失敗 |
800 | |
| message | 是 | String | 響應信息 | 查詢XXX信息成功 | |
| returnObj | 是 | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| prodInstName | 是 | String | 實例名稱 | test001 | |
| prodType | 是 | Integer | 實例類型 0: 單實例, 1:一主一從, 2:一主兩從, 3:一主三從 | 0 | |
| userId | 是 | Integer | 用戶id | 111 | |
| enableSSL | 是 | Integer | enableSSL表示是否開啟ssl連接，1表示開啟，0表示未開啟 | 0 | |
| diskSize | 是 | Integer | 存儲空間大小/G | 100 | |
| createTime | 是 | String | 實例創建時間 | 2022-10-10 00:00:00 | |
| port | 是 | String | 訪問該mongodb的端口 | 8888 | |
| prodRunningStatus | 是 | Integer | 實例的運行狀態 | 0 | |
| diskRate | 是 | String | 磁盤使用率 | 10% | |
| host | 是 | String | 主節點host | 67 | |
| prodInstId | 是 | String | 實例id | a649077e15f349cb8b4cde6f7285a568 | |
| machineSpec | 是 | String | 實例規格 | 64C500G | |
| nodeInfoVOS | 是 | Object[] | 節點信息 | nodeInfoVOS |
表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 | |
| prodInstId | 是 | String | 實例id | 649077e15f349cb8b4cde6f7285a568 | |
| resId | 是 | Integer | 唯一標志該mongodb | 67 |
請求示例
請求頭header
無
請求參數query
/v1/openApi/describeDBInstanceAttribute?prodInstId=a649077e15f349cb8b4cde6f7285a568
響應示例
{
"statusCode": 800,
"message": "查詢MongoDB實例概覽信息成功",
"returnObj": {
"prodInstName": "test-lcy",
"prodType": null,
"userId": 149,
"enableSSL": 0,
"diskSize": 3072,
"createTime": 1658458503000,
"port": "8350",
"prodRunningStatus": 0,
"diskRate": "12%",
"nodeInfoVOS": [
{
"elasticIp": "",
"node": "set_1098350_1",
"role": "master",
"alive": 1,
"vpcIpv6": "",
"port": "8350",
"host": "172.27.176.109",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"resId": 67
}
],
"host": "172.27.176.109",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"machineSpec": "64C500G"
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求失敗 |
錯誤碼
無
