tencent cloud

Feedback

CreateHourDCDBInstance

Last updated: 2022-04-20 17:10:12

1. API Description

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

This API is used to create pay-as-you-go TDSQL for MySQL instances.

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.

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.
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:
10.0.10: MariaDB 10.0.10;
10.1.9: MariaDB 10.1.9;
5.7.17: Percona 5.7.17.
If this parameter is left empty, 10.1.9 will be used.
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
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
SecurityGroupIds.N No Array of String Array of security group IDs (this parameter is compatible with the old parameter SecurityGroupId)

3. Output Parameters

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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 None

Input Example

https://dcdb.tencentcloudapi.com/?Action=CreateHourDCDBInstance
&ShardMemory=2
&ShardStorage=10
&ShardNodeCount=2
&ShardCount=2
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "14f6980a-7fe1-11ea-b896-525400542aa6",
    "InstanceIds": [
      "tdsql-xxxxxx"
    ],
    "DealName": "20200409111543",
    "FlowId": 1122
  }
}

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

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
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.
InvalidParameter Parameter error.
InvalidParameter.CheckParamNotPass Failed to verify input parameters.
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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support