Release Notes
Product Announcements
Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to create a pay-as-you-go TencentDB instance (which can be a source, disaster recovery, or read-only instance) by passing in information such as instance specifications, MySQL version number, and quantity.
This is an async API. You can also use the DescribeDBInstances API to query the instance details. If the Status value of an instance is 1 and TaskStatus is 0, the instance has been successfully delivered.
Port, ParamList, or Password is specified in the input parameters, the instance will be initialized.A maximum of 20 requests can be initiated per second for this API.
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 Params. The value used for this API: CreateDBInstanceHour. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
| Region | Yes | String | Common Params. 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 | Region information of the source instance, which is required when purchasing a read-only or disaster recovery instance. |
| 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 For multiple instances purchased at one time, they will be distinguished by the name suffix number, such as instnaceName=db and goodsNum=3, and their instance names are db1, db2, and db3, respectively. |
| ResourceTags.N | No | Array of TagInfo | Instance tag information. |
| DeployGroupId | No | String | Placement group ID. |
| ClientToken | No | String | A unique string supplied by the client to ensure that the request is idempotent. Its 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 | Array of alarm policy IDs, which is OriginId obtained through the DescribeAlarmPolicy API. |
| 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). Default value: 0. |
| 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). Default value: HIGH_STABILITY. |
| 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. |
| EngineType | No | String | Instance engine type. Valid values: InnoDB (default); RocksDB. |
| Vips.N | No | Array of String | The list of IPs for sources instances. Only one IP address can be assigned to a single source instance. If all IPs are used up, the system will automatically assign IPs to the remaining source instances that do not have one. |
| Parameter Name | Type | Description |
|---|---|---|
| DealIds | Array of String | Short order ID. |
| InstanceIds | Array of String | Instance ID list |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to create a pay-as-you-go TencentDB instance.
POST / HTTP/1.1Host: cdb.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: CreateDBInstanceHour<common request parameters>{ "ResourceTags": [ { "TagKey": "marchtest", "TagValue": [ "test1" ] } ], "Zone": "ap-guangzhou-3", "UniqVpcId": "vpc-0akbol5v", "ProjectId": "0", "SlaveZone": "ap-guangzhou-3", "InstanceRole": "master", "GoodsNum": "1", "DeployMode": "0", "Volume": "25", "EngineVersion": "5.6", "UniqSubnetId": "subnet-fyrtjbqw", "Memory": "1000", "ProtectMode": "0"}{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"InstanceIds": [
"cdb-03brtubb"
],
"DealIds": [
"20171201160000002670226599824833"
]
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.CdbError | System error. |
| 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. |
| InvalidParameter.InstanceNotFound | The instance does not exist. |
| 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. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback