Domain name for API request: mongodb.intl.tencentcloudapi.com.
This API is used to obtain the list of accounts.
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: DescribeInstanceUsers. |
| 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 | Instance ID. |
| UserName | No | String | userName. If left empty, query all users |
| Database | No | String | Database name. If left empty, query all database accounts. |
| OrderBy | No | String | Sorting field, available values: UserName; by default, sort by UserName if not passed. |
| OrderType | No | String | Sorting method. Value range: asc (in ascending order), desc (in descending order). Default: asc. |
| Offset | No | Integer | Pagination offset, defaults to 0 |
| Limit | No | Integer | Number of items per page, defaults to 20, maximum 100. |
| Parameter Name | Type | Description |
|---|---|---|
| Users | Array of InstanceUserInfo | Account list |
| Total | Integer | Total. |
| 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. |
POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceUsers
<Common request parameters>
{
"InstanceId": "cmgo-********"
}{
"Response": {
"Total": 1,
"Users": [
{
"ConsolePassUpdateTime": "2026-04-14 17:43:04",
"CreateTime": "2026-04-10 15:08:23",
"Database": "admin",
"Description": "For testing"
"EnablePasswordRotation": 0,
"Roles": [
{
"Database": "admin",
"RoleName": "backup"
}
],
"UpdateTime": "2026-04-14 17:43:41",
"UserName": "mongouser"
}
],
"RequestId": "6a80448e-130a-401f-94b4-ec8a74549416"
}
}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. |
| InvalidParameter | Parameter error |
| InvalidParameterValue.NotFoundInstance | The instance was not found. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan