tencent cloud

1. API Description

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

This API is used to create a monthly subscribed TencentDB instance (which can be a source, disaster recovery, or read-only instance) by passing in information such as instance specifications, MySQL version number, purchased duration, and quantity.

This is an asynchronous API. You can also use the DescribeDBInstances API to query the instance details. If the output parameter Status is 1 and the output parameter TaskStatus is 0, the instance has been successfully delivered.

1. You can use the DescribeDBZoneConfig API to query the purchasable instance specifications, and then use the DescribeDBPrice API to query the prices of the purchasable instances.
2. You can create up to 100 instances at a time, with an instance validity period of up to 36 months.
3. MySQL v5.5, v5.6, v5.7, and v8.0 are supported.
4. Source instances, read-only instances, and disaster recovery instances can be created.
5. If Port, ParamList, or Password is specified in the input parameters, the instance (excluding basic instances) will be initialized.
6. If Port, ParamTemplateId, or AlarmPolicyList is specified in the input parameters, you need to update your SDK to the latest version.

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 source 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>

{
    "ResourceTags": [
        {
            "TagKey": "marchtest",
            "TagValue": [
                "test1"
            ]
        }
    ],
    "Zone": "ap-guangzhou-3",
    "UniqVpcId": "vpc-0akbol5v",
    "ProjectId": "0",
    "InstanceRole": "master",
    "GoodsNum": "1",
    "Period": "1",
    "Volume": "25",
    "EngineVersion": "5.6",
    "UniqSubnetId": "subnet-fyrtjbqw",
    "Memory": "1000",
    "InstanceNodes": "2"
}

Output Example

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "InstanceIds": [
            "cdb-pn6gd5jp"
        ],
        "DealIds": [
            "20171201110011"
        ]
    }
}

Example2 Purchasing a read-only 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>

{
    "RoGroup": {
        "RoGroupMode": "allinone",
        "RoGroupName": "jersey_test",
        "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"
        ]
    }
}

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.