Help & DocumentationAPIsTencentDB for TDSQLTencent Distributed SQL (TDSQL)CreateAccount

CreateAccount

Last updated: 2020-04-02 17:55:16

Contents：

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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dcdb.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: CreateAccount.
Version Yes String Common parameter. The value used for this API: 2018-04-11.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
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, which can contain 6–32 letters, digits, and common symbols but not semicolons, single quotation marks, and double quotation marks.
ReadOnly No Integer Whether to create a read-only account. 0: no; 1: for the account's SQL requests, the slave will be used first, and if it is unavailable, the master will be used; 2: the slave will be used first, and if it is unavailable, the operation will fail; 3: only the slave will be read from.
Description No String Account remarks, which can contain 0–256 letters, digits, and common symbols.
DelayThresh No Integer If the slave delay exceeds the set value of this parameter, the slave 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.

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 Create an Access account for a cloud database instance

Input Example

https://dcdb.tencentcloudapi.com/?Action=CreateAccount
&InstanceId=dcdbt-fdpjf5zh
&UserName=testuser1
&Host=172.17.%
&Password=1234qweri#
&Description=Test account
&<common request parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

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.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.