tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

InitDBInstances

Last updated: 2022-01-27 10:36:37

1. API Description

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

This API is used to initialize TencentDB 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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

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-12.
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 tdsql-ow728lmc and can be obtained through the DescribeDBInstances 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
FlowId 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 Initializing TencentDB instances in batches

Input Example

https://mariadb.tencentcloudapi.com/?Action=InitDBInstances
&InstanceIds.0=tdsql-fdpjf5zh
&InstanceIds.1=tdsql-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": [
      "tdsql-fdpjf5zh",
      "tdsql-avw0207d"
    ],
    "FlowId": 3340
  }
}

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
InternalError.CamAuthFailed CAM authentication request failed.
InternalError.DbOperationFailed Failed to query the database.
InternalError.InnerSystemError Internal system error.
InternalError.OperateDatabaseFailed Database operation failed.
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.
ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy