查询实例所有数据库账号信息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
}
}
状态码
请参考 状态码
错误码
请参考 错误码