tencent cloud



Last updated: 2023-06-26 15:13:09

1. API Description

Domain name for API request: dcdb.tencentcloudapi.com.

This API is used to create a TencentDB account. Multiple accounts can be created for one instance. Accounts with the same username but different hosts are different accounts.

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: CreateAccount.
Version Yes String Common Params. The value used for this API: 2018-04-11.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Instance ID in the format of dcdbt-ow728lmc, which can be obtained through the DescribeDCDBInstances API.
UserName Yes String AccountName
Host Yes String Host that can be logged in to, which is in the same format as the host of the MySQL account and supports wildcards, such as %, 10.%, and 10.20.%.
Password Yes String Account password. It must contain 8-32 characters in all of the following four types: lowercase letters, uppercase letters, digits, and symbols (()~!@#$%^&*-+=_|{}[]:<>,.?/), and cannot start with a slash (/).
ReadOnly No Integer Whether to create a read-only account. 0: no; 1: for the account's SQL requests, the secondary will be used first, and if it is unavailable, the primary will be used; 2: the secondary will be used first, and if it is unavailable, the operation will fail; 3: only the secondary will be read from.
Description No String Account remarks, which can contain 0-256 letters, digits, and common symbols.
DelayThresh No Integer If the secondary delay exceeds the set value of this parameter, the secondary will be deemed to have failed.
It is recommended that this parameter be set to a value greater than 10. This parameter takes effect when ReadOnly is 1 or 2.
SlaveConst No Integer Whether to specify a replica server for read-only account. Valid values: 0 (No replica server is specified, which means that the proxy will select another available replica server to keep connection with the client if the current replica server doesn’t meet the requirement). 1 (The replica server is specified, which means that the connection will be disconnected if the specified replica server doesn’t meet the requirement.)
MaxUserConnections No Integer Maximum number of connections. If left empty or 0 is passed in, the connections will be unlimited. This parameter configuration is not supported for kernel version 10.1.

3. Output Parameters

Parameter Name Type Description
InstanceId String Instance ID, which is passed through from the input parameters.
UserName String Username, which is passed through from the input parameters.
Host String Host allowed for access, which is passed through from the input parameters.
ReadOnly Integer Passed through from the input parameters.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating an account for a TencentDB instance

Input Example

Host: dcdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAccount
<Common request parameters>

    "InstanceId": "dcdbt-fdpjf5zh",
    "UserName": "testuser1",
    "Host": "172.17.%",
    "Password": "1234qweri#",
    "Description": "Test account"

Output Example

    "Response": {
        "RequestId": "2cc4e4dc-c3e9-4858-ab80-03e3526cf24d",
        "InstanceId": "dcdbt-fdpjf5zh",
        "UserName": "testuser1",
        "Host": "172.17.%",
        "ReadOnly": 0

5. Developer Resources


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

Command Line Interface

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
FailedOperation.CreateUserFailed Failed to create the account.
FailedOperation.OssOperationFailed Failed to request the backend API.
InternalError.CamAuthFailed CAM authentication request failed.
InternalError.DbOperationFailed Failed to query the database.
InternalError.GetUserListFailed Failed to get the list of accounts.
InvalidParameter Parameter error.
InvalidParameter.CharacterError The password contains invalid characters.
InvalidParameter.GenericParameterError An error occurred while verifying parameter validity.
InvalidParameterValue.AccountAlreadyExists The account to be created already exists.
InvalidParameterValue.SuperUserForbidden Operations by a system user are not allowed.
ResourceUnavailable.InstanceAlreadyDeleted The database instance has been dropped.
ResourceUnavailable.InstanceHasBeenLocked The database instance has been locked. Operations are not allowed.
ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
UnsupportedOperation.OldProxyVersion The proxy program is too old. Please contact customer service for upgrade and try again.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support