Use Case

In order to help you get started with Cloud Database for MySQL APIs quickly, we provide an example on how to use these APIs.
To use Cloud Database for MySQL service, you need to query the supported instance specifications first, which defines the specifications and restrictions for the creatable instances, and then create instances based on the required specifications. Finally, you need to initialize the newly created instances. The procedure is as follows:
First, use API Query Supported Specifications (supporting custom availability zones and configurations) to view the supported instance specifications for various regions. Then use API Create an Instance (Pay by Usage) to create an instance. Finally, use API Initialize an Instance to initialize the instance. When initialized successfully, the instance can be put into use.

1. Query Supported Specifications (supporting custom availability zones and configurations)

Before creating a cloud database instance, we need to check which instance specifications are supported for the selected region. Only Common Request Parameters are required for this API.

By inputting Common Request Parameters, you can get the final request as follows:

https://cdb.api.qcloud.com/v2/index.php?Action=DescribeCdbProductListNew
&SecretId=AKIDTqlxxxxxxxiiRO
&Signature=G%2BepdQfDSklf2eMgrjQR5FdK7MY%3D
&Nonce=12276
&Timestamp=1467277235
&Region=bj

This API will return the instance usage period allowed to be purchased , the maximum number of instances allowed to be purchased at a time, as well as the specification information of each zone within the specified region, including whether VPC is supported, memory size, disk range, database engine version and number of visits per second (QPS). The returned results for the above request is as follows:

{
    "code":"0",
    "message":"",
    "codeDesc":"Success",
    "configs":{
        "timeSpan":[
            "1",
            "2",
            "3",
            "4",
            "5",
            "6",
            "7",
            "8",
            "9",
            "12",
            "24",
            "36"
        ],
        "minGoodsNumPerDeal":"1",
        "maxGoodsNumPerDeal":"10",
        "goodsDescription":{
            "100002":{
                "isSupportVpc":true,
                "types":[
                    {
                        "typeName":"High IO",
                        "memory":"4000",
                        "volumeMax":"125",
                        "volumeMin":"25",
                        "volumeStep":"5",
                        "qps":"4400",
                        "mysqlversion":[
                            "5.5",
                            "5.6"
                        ]
                    },
                    {
                        "typeName":"High IO",
                        "memory":"8000",
                        "volumeMax":"250",
                        "volumeMin":"25",
                        "volumeStep":"5",
                        "qps":"7200",
                        "mysqlversion":[
                            "5.5",
                            "5.6"
                        ]
                    }
                    //Part of the results are omitted. Please refer to the actual response content...
                ]
            }
            //Part of the results are omitted. Please refer to the actual response content...
        }
    }
}

2. Create Instances

After acquiring the supported instance specifications, you can use API API Create Instances (Pay by Usage) to create an instance.
In the following example, custom specifications are used, cdbType is set to CUSTOM, memory size is 1000MB and disk size is 25GB. MySQL version is 5.6, period is 1 month, and number of instances is 1. The relevant API request parameters are as follows:

By combining Common Request Parameters and API request parameters, you can get the final request as follows:

https://cdb.api.qcloud.com/v2/index.php?Action=CreateCdb
&SecretId=AKIDTqlxxxxxxxiiRO
&Signature=G%2BepdQfDSklf2eMgrjQR5FdK7MY%3D
&Nonce=25476
&Timestamp=1467277631
&Region=bj
&cdbType=CUSTOM
&memory=1000
&volume=25
&engineVersion=5.6
&period=1
&goodsNum=1

The results returned for the API "Create Instances" contain short order ID (dealIds), long order ID (dealNames) and instance ID. Parameter dealIds is used to call the cloud API, dealNames to report order-related problems to Tencent Cloud customer service, and instance ID to manage cloud database instance. You can use API Query List of Instances to view the instance you just created.
The result of the above request is as follows:

{
    "code": 0,
    "message": "",
    "dealIds": [
        "2196009"
    ],
    "data": {
        "dealNames": [
            "20161024110051"
        ],
        "dealIds": [
            "457605"
        ],
        "cdbInstanceIds": {
            "20161024110051": [
                "cdb-259sstXX"
            ]
        }
    }
}

3. Initialize Instances

When an instance is created, you need to initialize it. After being initialized successfully, the instance can be put into use. When initializing the instance, you can set the character set, port, whether table name is case-sensitive) and the password of root account for the instance. The relevant API request parameters are as follows:

By combining Common Request Parameters and API request parameters, you can get the final request as follows:

https://cdb.api.qcloud.com/v2/index.php?Action=CdbMysqlInit
&SecretId=AKIDTqlxxxxxxxiiRO
&Signature=G%2BepdQfDSklf2eMgrjQR5FdK7MY%3D
&Nonce=25476
&Timestamp=1467277631
&Region=bj
&cdbInstanceId=cdb-c1nl9rpv
&charset=utf8
&port=3306
&password=cloud123456
&lowerCaseTableNames=0

Initializing instances is an asynchronous process. If the task is successfully initialized, an task ID will be returned. You can use API Query Initialization Task Details to query the progress of the initialization task. The result of the above request is as follows:

{
    "code":"0",
    "message":"",
    "codeDesc":"Success",
    "jobId":"11"
}