CreateAccountUser

下载PDF

最后更新时间：2025-12-03 10:42:19

CreateAccountUser

最后更新时间： 2025-12-03 10:42:19

下载PDF

1. API Description

Domain name for API request: mongodb.intl.tencentcloudapi.com.

This API is used to customize an account to access the instance.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: CreateAccountUser.
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. For example, cmgo-p8vn****. Log in to the TencentDB for MongoDB console, and copy the instance ID from the instance list.
UserName	Yes	String	New account name. The format requirements are as follows: - The value range for the character length is [1, 64]. - Allowed characters include uppercase letters, lowercase letters, digits (1–9), underscores (_), and hyphens (-).
Password	Yes	String	New account password. The password complexity requirements are as follows: - The value range for the character length is [8, 32]. - It should include at least two of the following: letters, digits, and special characters (the exclamation mark (!), at sign (@), number sign (#), percent sign (%), caret (^), asterisk (*), parentheses (), and underscore (_)).
MongoUserPassword	No	String	Password corresponding to the mongouser account. mongouser is the default account of the system; it indicates the password set during instance creation.
UserDesc	No	String	Account remarks.
AuthRole.N	No	Array of Auth	Read/Write permission information of the account.

3. Output Parameters

Parameter Name	Type	Description
FlowId	Integer	Creates a task ID.
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.

4. Example

Example1 Customizing an Account

This example shows you how to customize an instance account.

Input Example

POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAccountUser
<Common request parameters>

{
    "InstanceId": "cmgo-9d0p****",
    "UserName": "test_user",
    "Password": "Abc@123...",
    "MongoUserPassword": "Abc@123...",
    "UserDesc": "Test user",
    "AuthRole": [
        {
            "Mask": 0,
            "NameSpace": "collection"
        }
    ]
}

Output Example

{
    "Response": {
        "FlowId": 1680767468,
        "RequestId": "1df930fb-eb7e-4e3f-bcab-15a1aa5fede0"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.
InternalError.PasswordError	The password is different from the previously recorded one.
InvalidParameter	Parameter error
InvalidParameterValue.CheckAppIdFailed	`appId` verification failed.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud