tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for MariaDB
    Documentation
    Download PDF

    CreateAccount

    Last updated: 2024-11-20 12:15:31
    Download PDF

      1. API Description

      Domain name for API request: mariadb.intl.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: 2017-03-12.
      Region Yes String Common Params. For more information, please see the list of regions supported by the product.
      InstanceId Yes String Instance ID, which is in the format of tdsql-ow728lmc and can be obtained through the DescribeDBInstances API.
      UserName Yes String Login username, which can contain 1-32 letters, digits, underscores, and hyphens.
      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 No 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.
      Description No String Account remarks, which can contain 0-256 letters, digits, and common symbols.
      DelayThresh No Integer Determines whether the secondary is unavailable based on the passed-in time
      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, 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 Creating an account for a TencentDB instance

      Input Example

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

{
    "UserName": "testuser1",
    "Description": "Test account",
    "InstanceId": "tdsql-fdpjf5zh",
    "ReadOnly": "0",
    "Host": "172.17.%",
    &Password=1234qweri#
}

      Output Example

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

      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

      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 account list.
      InternalError.InnerSystemError Internal system error.
      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 deleted.
      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.

      Contact Us
      Technical Support

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

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy