InitDCDBInstances

Last updated: 2020-04-02 17:51:43

PDF

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.

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: InitDCDBInstances.
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.
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 List of parameters. 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 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 Batch initialize cloud database instances

Input Example

https://dcdb.tencentcloudapi.com/?Action=InitDCDBInstances
&InstanceIds.0=dcdbt-fdpjf5zh
&InstanceIds.1=dcdbt-avw0207d
&Params.0.Param=lower_case_table_names
&Params.0.Value=1
&Params.1.Param=innodb_page_size
&Params.1.Value=16384
&Params.2.Param=character_set_server
&Params.2.Value=utf8
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "d94ef093-ff84-4851-b2e0-a5c5920d618e",
    "InstanceIds": [
      "dcdbt-fdpjf5zh",
      "dcdbt-avw0207d"
    ],
    "FlowIds": [
      3340,
      3341
    ]
  }
}

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
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.
ResourceUnavailable.BadInstanceStatus Incorrect instance status. Unable to initialize.
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.