CreateDBInstanceHour

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2022-01-19 11:36:35

Download PDF

1. API Description

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

This API is used to create pay-as-you-go TencentDB instances (which can be source instances, disaster recovery instances, or read-only replicas) by passing in information such as instance specifications, MySQL version number, and instance quantity.

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

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

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: CreateDBInstanceHour.
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.
GoodsNum	Yes	Integer	Number of instances. Value range: 1-100. Default value: 1.
Memory	Yes	Integer	Instance memory size in MB. Please use the DescribeDBZoneConfig API to query the supported memory specifications.
Volume	Yes	Integer	Instance disk size in GB. Please use the DescribeDBZoneConfig API to query the supported disk specifications.
EngineVersion	No	String	MySQL version. Valid values: `5.5`, `5.6`, `5.7`, `8.0`. You can use the DescribeDBZoneConfig API to query the supported versions.
UniqVpcId	No	String	VPC ID. If this parameter is not passed in, the basic network will be selected by default. Please use the DescribeVpcs API to query the VPCs.
UniqSubnetId	No	String	VPC subnet ID. If `UniqVpcId` is set, then `UniqSubnetId` will be required. Please use the DescribeSubnets API to query the subnet lists.
ProjectId	No	Integer	Project ID. If this is left empty, the default project will be used.
Zone	No	String	AZ information. By default, the system will automatically select an AZ. Please use the DescribeDBZoneConfig API to query the supported AZs.
MasterInstanceId	No	String	Instance ID, which is required and the same as the primary instance ID when purchasing read-only or disaster recovery instances. Please use the DescribeDBInstances API to query the instance IDs.
InstanceRole	No	String	Instance type. Valid values: master (primary instance), dr (disaster recovery instance), ro (read-only instance). Default value: master.
MasterRegion	No	String	AZ information of the primary instance, which is required for purchasing disaster recovery instances.
Port	No	Integer	Custom port. Value range: [1024-65535].
Password	No	String	Sets the root account password. Rule: the password can contain 8-64 characters and must contain at least two of the following types of characters: letters, digits, and special symbols (_+-&=!@#$%^*()). This parameter can be specified when purchasing primary instances and is meaningless for read-only or disaster recovery instances.
ParamList.N	No	Array of ParamInfo	List of parameters in the format of `ParamList.0.Name=auto_increment&ParamList.0.Value=1`. You can use the DescribeDefaultParams API to query the configurable parameters.
ProtectMode	No	Integer	Data replication mode. Valid values: 0 (async), 1 (semi-sync), 2 (strong sync). Default value: 0. This parameter can be specified when purchasing primary instances and is meaningless for read-only or disaster recovery instances.
DeployMode	No	Integer	Multi-AZ. Valid value: 0 (single-AZ), 1 (multi-AZ). Default value: 0. This parameter can be specified when purchasing primary instances and is meaningless for read-only or disaster recovery instances.
SlaveZone	No	String	AZ information of secondary database 1, which is the `Zone` value by default. This parameter can be specified when purchasing primary instances and is meaningless for read-only or disaster recovery instances.
BackupZone	No	String	The availability zone information of Replica 2, which is left empty by default. Specify this parameter when purchasing a source instance in the one-source-two-replica architecture.
SecurityGroup.N	No	Array of String	Security group parameter. You can use the DescribeProjectSecurityGroups API to query the security group details of a project.
RoGroup	No	RoGroup	Read-only instance information. This parameter must be passed in when purchasing read-only instances.
AutoRenewFlag	No	Integer	This field is meaningless when purchasing pay-as-you-go instances.
InstanceName	No	String	Instance name.
ResourceTags.N	No	Array of TagInfo	Instance tag information.
DeployGroupId	No	String	Placement group ID.
ClientToken	No	String	A string that is used to guarantee the idempotency of the request, which is generated by the user and must be unique in each request on the same day. The maximum length is 64 ASCII characters. If this parameter is not specified, the idempotency of the request cannot be guaranteed.
DeviceType	No	String	Instance resource isolation type. Valid values: `UNIVERSAL` (general instance), `EXCLUSIVE` (dedicated instance), `BASIC` (basic instance). Default value: `UNIVERSAL`.
ParamTemplateId	No	Integer	Parameter template ID.
AlarmPolicyList.N	No	Array of Integer	The array of alarm policy IDs.
InstanceNodes	No	Integer	The number of nodes of the instance. To purchase a read-only replica or a basic instance, set this parameter to `1` or leave it empty. To purchase a three-node instance, set this parameter to `3` or specify the `BackupZone` parameter. If the instance to be purchased is a source instance and both `BackupZone` and this parameter are left empty, the value `2` will be used, which indicates the source instance will have two nodes.
Cpu	No	Integer	The number of CPU cores of the instance. If this parameter is left empty, the number of CPU cores depends on the `Memory` value.
AutoSyncFlag	No	Integer	Whether to automatically start disaster recovery synchronization. This parameter takes effect only for disaster recovery instances. Valid values: `0` (no), `1` (yes).
CageId	No	String	Financial cage ID.
ParamTemplateType	No	String	Type of the default parameter template. Valid values: `HIGH_STABILITY` (high-stability template), `HIGH_PERFORMANCE` (high-performance template).
AlarmPolicyIdList.N	No	Array of String	The array of alarm policy names, such as ["policy-uyoee9wg"]. If the `AlarmPolicyList` parameter is specified, this parameter is invalid.
DryRun	No	Boolean	Whether to check the request without creating any instance. Valid values: `true`, `false` (default). After being submitted, the request will be checked to see if it is in correct format and has all required parameters with valid values. An error code is returned if the check failed, and `RequestId` is returned if the check succeeded. After a successful check, no instance will be created if this parameter is set to `true`, whereas an instance will be created and if it is set to `false`.

3. Output Parameters

Parameter Name	Type	Description
DealIds	Array of String	Short order ID.
InstanceIds	Array of String	Instance ID list
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a pay-as-you-go TencentDB instance

Input Example

https://cdb.tencentcloudapi.com/?Action=CreateDBInstanceHour
&Memory=1000
&Volume=25
&GoodsNum=1
&Zone=ap-guangzhou-3
&UniqVpcId=vpc-0akbol5v
&UniqSubnetId=subnet-fyrtjbqw
&ProjectId=0
&InstanceRole=master
&EngineVersion=5.6
&ProtectMode=0
&DeployMode=0
&SlaveZone=ap-guangzhou-3
&ResourceTags.0.TagKey=marchtest
&ResourceTags.0.TagValue.0=test1
&<Common request parameters>

Output Example

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

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

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.

Error Code	Description
CdbError	Backend or process error.
FailedOperation.StatusConflict	Task status conflict.
InternalError.DatabaseAccessError	Internal database error.
InternalError.DfwError	Security group operation error.
InternalError.TradeError	Transaction system error.
InternalError.UndefinedError	Unknown error
InternalError.VpcError	VPC or subnet error.
InvalidParameter	Parameter error.
OperationDenied	Operation denied.
OperationDenied.ActionNotSupport	Unsupported operation.
OperationDenied.OtherOderInProcess	There are other orders being submitted. Please try again later.
OperationDenied.UserHasNoStrategy	This account is not authorized to access the requested resource.
OperationDenied.WrongPassword	Incorrect password or verification failed.

Recent Pages