Domain name for API request: mongodb.intl.tencentcloudapi.com.
This API is used to obtain all accounts of the current instance.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeAccountUsers. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-25. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Specifies the ID of the instance for obtaining accounts. For example, cmgo-p8vn****. Log in to the TencentDB for MongoDB console and copy the instance ID from the instance list. |
| Parameter Name | Type | Description |
|---|---|---|
| Users | Array of UserInfo | |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query the information on all accounts of the current instance.
POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccountUsers
<Common request parameters>
{
"InstanceId": "cmgo-9d0p****"
}
{
"Response": {
"Users": [
{
"UserName": "test_user",
"AuthRole": [
{
"Mask": 0,
"NameSpace": "collection"
}
],
"CreateTime": "2022-03-04 19:00:00",
"UpdateTime": "2022-03-04 19:00:00",
"UserDesc": "Test account"
}
],
"RequestId": "1df930fb-eb7e-4e3f-bcab-15a1aa5fede0"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error |
| InternalError.CheckAppIdFailed | appId verification failed. |
| InvalidParameter.PermissionDenied | The current sub-account has no permission to perform this operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback