查詢實例的所有數據庫賬號信息
更新時間 2023-08-29 15:13:50
最近更新時間: 2023-08-29 15:13:50
分享文章
接口功能介紹
調用describeAccounts查詢MongoDB實例的所有數據庫賬號信息。
接口約束
無
URI
GET /v1/accountsOpenApi/describeAccounts
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| prodInstId | 是 | String | 文檔數據庫對外的實例標識 | 60d420bffb394397b4303be871a481e3 |
| pageNow | 否 | Integer | 當前頁 | 1 |
| pageSize | 否 | Integer | 頁面記錄 | 10 |
請求參數
請求頭header參數
無
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 下級對象 | |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 響應碼 取值范圍:800為成功,900為失敗 |
800 | |
| message | 是 | String | 響應信息 | ||
| returnObj | 是 | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| total | 是 | Integer | 賬戶數 | 2 | |
| pages | 是 | Integer | 頁數 | 1 | |
| pageSize | 是 | Integer | 每頁數據量 | 10 | |
| list | 是 | Object[] | 賬戶信息數組 | list | |
| pageNow | 是 | Integer | 當前頁 | 1 |
表list
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| roles | 是 | Object[] | 角色信息數組 | roles | |
| user | 是 | String | 賬戶名 | root | |
| db | 是 | String | 授權數據庫 | admin |
表roles
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| role | 是 | String | 用戶權限 | read | |
| db | 是 | String | 用戶權限所屬的數據庫 | local |
請求示例
請求頭header
無
請求參數query
/v1/accountsOpenApi/describeAccounts?prodInstId=f3687b55b1ce4cb1b781fb567b12ab0b&pageNow=1&pageSize=10
響應示例
{
"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
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求失敗 |
錯誤碼
無