Alarm Upgrade
Domain name for API request: dcdb.intl.tencentcloudapi.com.
This API is used to create a pay-as-you-go TDSQL instance.
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: CreateHourDCDBInstance. |
| Version | Yes | String | Common Params. The value used for this API: 2018-04-11. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley. |
| ShardMemory | Yes | Integer | Shard memory in GB, which can be obtained through the DescribeShardSpec API. |
| ShardStorage | Yes | Integer | Shard capacity in GB, which can be obtained through the DescribeShardSpec API. |
| ShardNodeCount | Yes | Integer | The number of nodes per shard, which can be obtained through the DescribeShardSpec API. |
| ShardCount | Yes | Integer | The number of shards in the instance. Value range: 2-8. Upgrade your instance to have up to 64 shards if you require more. |
| Count | No | Integer | The number of instances to be purchased |
| ProjectId | No | Integer | Project ID, which can be obtained through the DescribeProjects API. If this parameter is not passed in, the instance will be associated with the default project. |
| VpcId | No | String | VPC ID. If this parameter is left empty or not passed in, the instance will be created on the classic network. |
| SubnetId | No | String | VPC subnet ID, which is required when VpcId is specified |
| ShardCpu | No | Integer | The number of CPU cores per shard, which can be obtained through the DescribeShardSpec API. |
| DbVersionId | No | String | Database engine version. Valid values: 5.7, 8.0, 10.0, 10.1. |
| Zones.N | No | Array of String | AZs to deploy shard nodes. You can specify up to two AZs. |
| SecurityGroupId | No | String | Security group ID |
| InstanceName | No | String | Custom name of the instance |
| Ipv6Flag | No | Integer | Whether IPv6 is supported. Valid values: 0 (unsupported), 1 (supported). |
| ResourceTags.N | No | Array of ResourceTag | Array of tag key-value pairs |
| DcnRegion | No | String | If you create a disaster recovery instance, you need to use this parameter to specify the region of the associated source instance so that the disaster recovery instance can sync data with the source instance over the Data Communication Network (DCN). |
| DcnInstanceId | No | String | If you create a disaster recovery instance, you need to use this parameter to specify the ID of the associated source instance so that the disaster recovery instance can sync data with the source instance over the Data Communication Network (DCN). |
| InitParams.N | No | Array of DBParamValue | List of parameters. Valid values: character_set_server (character set; required); lower_case_table_names (table name case sensitivity; required; 0: case-sensitive; 1: case-insensitive); innodb_page_size (InnoDB data page size; default size: 16 KB); sync_mode (sync mode; 0: async; 1: strong sync; 2: downgradable strong sync; default value: 2). |
| RollbackInstanceId | No | String | ID of the instance to be rolled back |
| RollbackTime | No | String | Rollback time, such as "2021-11-22 00:00:00". |
| SecurityGroupIds.N | No | Array of String | Array of security group IDs (this parameter is compatible with the old parameter SecurityGroupId) |
| DcnSyncMode | No | Integer | |
| CpuType | No | String |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceIds | Array of String | IDs of the instances you have purchased in this order. If no instance IDs are returned, you can query them with the DescribeOrders API. You can also use the DescribeDBInstances API to check whether an instance has been created successfully. |
| FlowId | Integer | Task ID, which can be used to query the creation progress |
| DealName | String | Order ID, which is used for calling the DescribeOrders API.The parameter can be used to either query order details or call the user account APIs to make another payment when this payment fails. |
| 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 yearly/monthly subscribed TDSQL instance.
POST / HTTP/1.1Host: dcdb.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: CreateHourDCDBInstance<common request parameters>{ "ShardCount": "2", "ShardMemory": "2", "ShardNodeCount": "2", "ShardStorage": "10"}
{
"Response": {
"RequestId": "14f6980a-7fe1-11ea-b896-525400542aa6",
"InstanceIds": [
"tdsql-xxxxxx"
],
"DealName": "20200409111543",
"FlowId": 1122
}
}
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 |
|---|---|
| FailedOperation.CreateOrderFailed | Failed to create an order. |
| FailedOperation.TagDryRunError | Either tag key/value verification or tag API authentication failed. |
| FailedOperation.UserNotAuthed | Unverified user. |
| InternalError.DbOperationFailed | Failed to query the database. |
| InternalError.GetVpcFailed | Failed to query the VPC information. |
| InternalError.InnerSystemError | Internal system error. |
| InternalError.OperateDatabaseFailed | Database operation failed. |
| InternalError.RetreateTime | Invalid rollback time |
| InvalidParameter | Parameter error. |
| InvalidParameter.CheckParamNotPass | Failed to verify input parameters. |
| InvalidParameter.InstanceNotFound | Failed to find the requested instance. |
| InvalidParameter.SubnetNotFound | The specified VPC subnet was not found. |
| InvalidParameter.VpcNotFound | The specified VPC was not found. |
| InvalidParameterValue.IllegalZone | The specified AZ was not found. |
| InvalidParameterValue.SpecIdIllegal | The specification information of the database instance was not found. |
| ResourceUnavailable.InstanceStatusAbnormal | Incorrect database instance status. Operations are not allowed. |
| UnauthorizedOperation.PermissionDenied | You have no permission to manipulate this API or resource. |
| UnsupportedOperation.DbVersionNotSupported | This database version is not supported. |
フィードバック