查看實例列表
更新時間 2023-08-29 15:13:49
最近更新時間: 2023-08-29 15:13:49
分享文章
接口功能介紹
查詢文檔數據庫服務的實例列表。
接口約束
無
URI
GET /v1/openApi/getAllInstances
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 響應碼 取值范圍:800為成功,900為失敗 |
800 | |
| message | 是 | String | 響應信息 | 查詢XXX信息成功 | |
| returnObj | 是 | Object[] | 返回對象數組 | returnObj |
表returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| subnet | 是 | String | 子網 | ||
| expireTime | 是 | String | 到期時間 | 2022-07-22 10:54:13.0 | |
| createTime | 是 | String | 實例的創建時間 | 2022-07-22 10:54:13.0 | |
| prodDbEngin | 是 | String | dds數據庫產品的版本 | 4.0 | |
| prodRunningStatus | 是 | Integer | 實例的運行狀態 | 0 | |
| netName | 是 | String | 專有網絡 | ||
| prodInstId | 是 | String | 示例id | a649077e15f349cb8b4cde6f7285a568 | |
| machineSpec | 是 | String | CPU內存規格 | 64C500G |
請求示例
請求頭header
無
請求參數query
/v1/openApi/getAllInstances
響應示例
{
"statusCode": 800,
"message": "查詢文檔數據庫服務的實例列表成功",
"returnObj": [
{
"subnet": "",
"expireTime": "2022-07-22 10:54:13.0",
"prodInstName": "mongodb001",
"createTime": "2022-07-22 10:55:03.0",
"prodDbEngine": "4.0",
"prodRunningStatus": 0,
"netName": "",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"machineSpec": "64C500G"
}
]
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求失敗 |
錯誤碼
無