Last updated: 2018-10-12 16:08:52


1. API Description

Domain name for API request:

This API (InitDBInstances) is used to initialize a database instance, including its 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. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example:

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, such as: cdb-c1nl9rpv. It is identical to the instance ID displayed in the database console page and can be obtained via API Query Instance List. Its value equals the InstanceId field value in the output parameters.
NewPassword Yes String New password for the instance, which should be a combination of 8-64 characters comprised of at least two of the following types: letters, numbers, and special characters (!, @, #, $, %, ^, *, ()).
Parameters.N Yes Array of ParamInfo List of instance parameters. Parameters "character_set_server" and "lower_case_table_names" can be set. Available values for "character_set_server" are ["utf8", "latin1", "gbk", "utf8mb4"], and for "lower_case_table_names" are ["0", "1"].
Vport No Integer Port of the instance

3. Output Parameters

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

4. Error Codes

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.

5. Example

Example 1 Initialize a new instance

Input example
&<Common request parameters>

Output example

  "Response": {
    "AsyncRequestIds": [
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"

6. Other Resources

Cloud API 3.0 comes with the following development tools to make it easier to call the API.