接口功能介绍
调用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 | 表示请求失败 |
错误码
无
