查詢實例所有數據庫賬號信息v2
更新時間 2025-10-22 18:11:58
最近更新時間: 2025-10-22 18:11:58
分享文章
接口功能介紹
查詢文檔數據庫實例的所有數據庫賬號信息
接口約束
無
URI
GET /DDS2/v2/openApi/describeAccounts
路徑參數 無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 文檔數據庫對外的實例標識 | 60d420bffb394************************* | |
| pageNow | 否 | Integer | 當前頁,不傳默認為1 | 1 | |
| pageSize | 否 | Integer | 頁面記錄,不傳默認為10 | 10 |
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 項目id | 0 | |
| regionId | 是 | String | 資源池id | bb9fdb42056f11eda1610242ac110002 |
請求體body參數 無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應碼 取值范圍:800為成功,900為失敗 | 800 | |
| message | String | 響應信息 | 查詢MongoDB實例的所有數據庫賬號信息成功 | |
| returnObj | Object | 返回對象 | returnObj | |
| error | String | 錯誤碼。當接口失敗時才返回具體錯誤編碼,成功不返回或者為空。 | ||
| 表 returnObj |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| total | Integer | 賬戶數 | 2 | |
| pages | Integer | 頁數 | 1 | |
| pageSize | Integer | 每頁數據量 | 10 | |
| pageNow | Integer | 當前頁 | 1 | |
| list | Array of Objects | 賬戶信息數組 | list | |
| 表 list |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| user | String | 賬戶名 | root | |
| db | String | 授權數據庫 | admin | |
| roles | Array of Objects | 角色信息數組 | roles | |
| 表 roles |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| role | String | 用戶權限 | read | |
| db | String | 用戶權限所屬的數據庫 | local |
枚舉參數
無
請求示例
請求url
/v1/accountsOpenApi/describeAccounts?prodInstId=60d420bffb394*************************&pageNow=1&pageSize=10
請求頭header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
請求體body
無
響應示例
{
"statusCode": 800,
"message": "查詢MongoDB實例的所有數據庫賬號信息成功",
"returnObj": {
"total": 2,
"pages": 1,
"pageSize": 10,
"list": [
{
"roles": [
{
"role": "root",
"db": "admin"
}
],
"user": "root",
"db": "admin"
},
{
"roles": [
{
"role": "backup",
"db": "admin"
}
],
"user": "test",
"db": "admin"
}
],
"pageNow": 1
}
}
狀態碼
請參考
錯誤碼
請參考