tencent cloud



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

1. API Description

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

This API is used to initialize instances, including setting the default character set and table name case sensitivity.

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: InitDCDBInstances.
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.
InstanceIds.N Yes Array of String List of IDs of instances to be initialized. The ID is in the format of dcdbt-ow728lmc and can be obtained through the DescribeDCDBInstances API.
Params.N Yes Array of DBParamValue Parameter list. Valid values: character_set_server (character set; required); lower_case_table_names (table name case sensitivity; required; 0: case-sensitive, 1: case-insensitive); innodb_page_size (InnoDB data page; default size: 16 KB); sync_mode (sync mode; 0: async; 1: strong sync; 2: downgradable strong sync; default value: strong sync).

3. Output Parameters

Parameter Name Type Description
FlowIds Array of Integer Async task ID. The task status can be queried through the DescribeFlow API.
InstanceIds Array of String Passed through from input parameters.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Initializing TencentDB instances in batches

Input Example

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

    "Params": [
            "Value": "16384",
            "Param": "innodb_page_size"
            "Value": "1",
            "Param": "lower_case_table_names"
            "Value": "utf8",
            "Param": "character_set_server"
    "InstanceIds": [

Output Example

    "Response": {
        "RequestId": "d94ef093-ff84-4851-b2e0-a5c5920d618e",
        "InstanceIds": [
        "FlowIds": [

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
InternalError.CamAuthFailed CAM authentication request failed.
InternalError.DbOperationFailed Failed to query the database.
InternalError.InnerSystemError Internal system error.
InvalidParameter.GenericParameterError An error occurred while verifying parameter validity.
InvalidParameterValue.IllegalInitParam An error occurred while initializing database instance parameters.
InvalidParameterValue.SyncModeNotAllowed The deployment mode does not support setting the sync mode.
ResourceUnavailable.BadInstanceStatus Incorrect instance status. Unable to initialize.
ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
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