API Introduction
Call describeAccounts to query all database account information of the MongoDB instance.
API Restrictions
None
URI
GET /v1/accountsOpenApi/describeAccounts
Path Parameter
None
Query Parameter
Parameter | Required or Not | Parameter Type | Description | Example |
prodInstId | Yes | String | External instance ID of the document database | 60d420bffb394397b4303be871a481e3 |
pageNow | No | Integer | Current page | 1 |
pageSize | No | Integer | Page record | 10 |
Request Parameters
Request Header Parameter
None
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Lower-level Object | |
statusCode | Yes | Integer | Response Code Value range: 800 indicates success, 900 indicates failure | 800 | |
message | Yes | String | Response information | ||
returnObj | Yes | Object | Return object. | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
total | Yes | Integer | Number of accounts | 2 | |
pages | Yes | Integer | Number of pages | 1 | |
pageSize | Yes | Integer | Data volume per page | 10 | |
list | Yes | Object[] | Account information array | list | |
pageNow | Yes | Integer | Current page | 1 |
Table list
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
roles | Yes | Object[] | Role information array | roles | |
user | Yes | String | Account Name | root | |
db | Yes | String | Authorization database | admin |
Table roles
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
role | Yes | String | User Permission | read | |
db | Yes | String | Database to which user rights belong | local |
Sample Request
Request Header
None
Request parameter query
/v1/accountsOpenApi/describeAccounts?prodInstId=f3687b55b1ce4cb1b781fb567b12ab0b&pageNow=1&pageSize=10
Response Example
{
"statusCode": 800,
"message": "all database account information of the MongoDB instance is queried successfully",
"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
}
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None