1. API Description

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

This API is used to create a cloud database instance with an annual/monthly subscription, including primary instance, disaster recovery instance, and read-only instance. You can create a cloud database instance by importing instance specification, MySQL version number, purchase period, and quantity information.

This API is an asynchronous API. You can also use the query instance list API (https://www.tencentcloud.com/document/api/236/15872?from_cn_redirect=1) to query the instance details. When the Status of the instance is 1 and TaskStatus is 0, it means the instance has been delivered successfully.

1. First, please use the API for the query (https://www.tencentcloud.com/document/api/236/17229?from_cn_redirect=1) to obtain the purchasable specifications of cloud databases, then please use the API for the query (https://www.tencentcloud.com/document/api/236/18566?from_cn_redirect=1) to query database price.
2. You can create up to 100 instances at a time, with a maximum instance duration of 36 months.
3. Support creating MySQL 5.5, MySQL 5.6, MySQL 5.7, and MySQL 8.0 versions.
4. Support creating primary instance, read-only instance, disaster recovery instance.
5. When ParamTemplateId or AlarmPolicyList is specified in the input parameters, you need to upgrade the SDK to the latest version to support it.

A maximum of 20 requests can be initiated per second for this API.

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.

3. Output Parameters

4. Example

Example1 Purchasing a Primary Instance

Input Example

POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBInstance
<Common request parameters>

{
    "Memory": 1000,
    "Volume": 200,
    "Period": 12,
    "GoodsNum": 1,
    "Zone": "ap-guangzhou-ziyan3",
    "UniqVpcId": "vpc-grpykq9v",
    "UniqSubnetId": "subnet-aq06sf6a",
    "Port": 3306,
    "InstanceRole": "master",
    "Password": "190228bh",
    "ProtectMode": 1,
    "DeployMode": 0,
    "SlaveZone": "ap-guangzhou-ziyan3",
    "SecurityGroup": [
        "sg-9c3k3gtd"
    ],
    "InstanceName": "test_create-api2",
    "InstanceNodes": 2,
    "Cpu": 1,
    "EngineType": "InnoDB"
}

Output Example

{
    "Response": {
        "DealIds": [
            "20251117217021754844851"
        ],
        "InstanceIds": [
            "cdb-4wixd9pn"
        ],
        "RequestId": "bae642bd-305a-40fe-b64c-356dc809977b"
    }
}

Example2 Purchase a read-only instance

This example shows you how to purchase a source instance.

Input Example

POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBInstance
<Common request parameters>

{
    "RoGroup": {
        "RoGroupMode": "allinone",
        "RoGroupName": "jersey",
        "RoMaxDelayTime": 5,
        "MinRoInGroup": 1,
        "RoOfflineDelay": 1
    },
    "GoodsNum": 1,
    "InstanceRole": "ro",
    "MasterInstanceId": "cdb-fn3f9xpx",
    "Period": 1,
    "Volume": 100,
    "Memory": 4000
}

Output Example

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "DealIds": [
            "20171205110051"
        ],
        "InstanceIds": [
            "cdbro-hlpl4ik9"
        ]
    }
}

Example3 Set table name case sensitivity when creating an instance

This example shows you how to purchase a read-only instance.

Input Example

POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBInstance
<Common request parameters>

{
    "Memory": 1000,
    "Volume": 25,
    "Period": 1,
    "GoodsNum": 1,
    "Zone": "ap-beijing-3",
    "UniqVpcId": "vpc-4pagx2lk",
    "UniqSubnetId": "subnet-a2eaqb1t",
    "InstanceRole": "master",
    "EngineVersion": "8.0",
    "ParamList": [
        {
            "Name": "lower_case_table_names",
            "Value": "0"
        }
    ],
    "DeviceType": "UNIVERSAL",
    "Cpu": 1,
    "EngineType": "InnoDB"
}

Output Example

{
    "Response": {
        "RequestId": "6166b535-64e8-4372-86fc-d6e25791f4fc",
        "InstanceIds": [
            "cdb-grq113rc"
        ],
        "DealIds": [
            "20250519054092411681521"
        ]
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.