PrevNext
search by keyword

Recent Pages

Documentation
TencentDB for MySQL
    Documentation
    Download PDF

    InitDBInstances

    Last updated: 2020-12-02 12:54:02
    Download PDF

    1. API Description

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

    This API (InitDBInstances) is used to initialize instances, including their password, default character set, and instance port number.

    A maximum of 100 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: cdb.ap-shanghai-fsi.tencentcloudapi.com

    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 parameter. The value used for this API: InitDBInstances.
    Version Yes String Common parameter. The value used for this API: 2017-03-20.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    InstanceIds.N Yes Array of String Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. You can use the instance list querying API to query the ID, whose value is the InstanceId value in output parameters.
    NewPassword Yes String New password of the instance. Rule: It can only contain 8-64 characters and must contain at least two of the following types of characters: letters, digits, and special characters (!@#$%^*()).
    Parameters.N Yes Array of ParamInfo List of instance parameters. Currently, "character_set_server" and "lower_case_table_names" are supported, whose value ranges are ["utf8","latin1","gbk","utf8mb4"] and ["0","1"], respectively.
    Vport No Integer Instance port. Value range: [1024, 65535].

    3. Output Parameters

    Parameter Name Type Description
    AsyncRequestIds Array of String Array of async task request IDs, which can be used to query the execution results of async tasks.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Initializing a new instance

    Input Example

    https://cdb.tencentcloudapi.com/?Action=InitDBInstances
&InstanceIds.0=cdb-f35wr6wj
&NewPassword=Gx18ux23F^X
&Parameters.0.name=lower_case_table_names
&Parameters.0.value=1
&Parameters.1.name=character_set_server
&Parameters.1.value=utf8
&<Common request parameters>

    Output Example

    {
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    "AsyncRequestIds": [
      "8cd119d4-61ba-11e7-aeff-018cfa1f5560"
    ]
  }
}

    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
    InvalidParameter Parameter error.
    InvalidParameter.InstanceNotFound The instance does not exist.
    OperationDenied Operation denied.
    OperationDenied.WrongPassword Incorrect password or verification failed.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy