tencent cloud

Feedback

CreateDBInstances

Last updated: 2022-11-29 17:26:14

1. API Description

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

This API is used to create an instance.

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: CreateDBInstances.
Version Yes String Common Params. The value used for this API: 2018-03-28.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Zone Yes String Instance AZ, such as ap-guangzhou-1 (Guangzhou Zone 1). Purchasable AZs for an instance can be obtained through the DescribeZones API
Memory Yes Integer Instance memory size in GB
Storage Yes Integer Instance storage capacity in GB
InstanceChargeType No String Billing mode. Valid value: POSTPAID (pay-as-you-go).
ProjectId No Integer Project ID
GoodsNum No Integer Number of instances purchased this time. Default value: 1. Maximum value: 10
SubnetId No String VPC subnet ID in the format of subnet-bdoe83fa. SubnetId and VpcId should be set or ignored simultaneously
VpcId No String VPC ID in the format of vpc-dsp338hz. SubnetId and VpcId should be set or ignored simultaneously
Period No Integer Length of purchase of instance. The default value is 1, indicating one month. The value cannot exceed 48
AutoVoucher No Integer Whether to automatically use voucher. 0: no, 1: yes. Default value: no
VoucherIds.N No Array of String Array of voucher IDs (currently, only one voucher can be used per order)
DBVersion No String SQL Server version. Valid values: 2008R2 (SQL Server 2008 R2 Enterprise), 2012SP3 (SQL Server 2012 Enterprise), 201202 (SQL Server 2012 Standard), 2014SP2 (SQL Server 2014 Enterprise), 201402 (SQL Server 2014 Standard), 2016SP1 (SQL Server 2016 Enterprise), 201602 (SQL Server 2016 Standard), 2017 (SQL Server 2017 Enterprise), 201702 (SQL Server 2017 Standard), 2019 (SQL Server 2019 Enterprise), 201902 (SQL Server 2019 Standard). Default value: 2008R2. The available version varies by region, and you can pull the version information by calling the DescribeProductConfig API.
AutoRenewFlag No Integer Auto-renewal flag. 0: normal renewal, 1: auto-renewal. Default value: 1.
SecurityGroupList.N No Array of String Security group list, which contains security group IDs in the format of sg-xxx.
Weekly.N No Array of Integer Configuration of the maintenance window, which specifies the day of the week when maintenance can be performed. Valid values: 1 (Monday), 2 (Tuesday), 3 (Wednesday), 4 (Thursday), 5 (Friday), 6 (Saturday), 7 (Sunday).
StartTime No String Configuration of the maintenance window, which specifies the start time of daily maintenance.
Span No Integer Configuration of the maintenance window, which specifies the maintenance duration in hours.
HAType No String The type of purchased high-availability instance. Valid values: DUAL (dual-server high availability), CLUSTER (cluster). Default value: DUAL.
MultiZones No Boolean Whether to deploy across availability zones. Default value: false.
ResourceTags.N No Array of ResourceTag Tags associated with the instances to be created
Collation No String Collation of system character sets. Default value: Chinese_PRC_CI_AS.
TimeZone No String System time zone. Default value: China Standard Time.

3. Output Parameters

Parameter Name Type Description
DealName String Order name
DealNames Array of String Order name array
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating an instance

Input Example

POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBInstances
<Common request parameters>

{
    "Collation": "Chinese_PRC_CI_AS",
    "TimeZone": "China Standard Time",
    "Storage": 100,
    "Zone": "ap-guangzhou-1",
    "Memory": "2"
}

Output Example

{
    "Response": {
        "DealName": "20200318114212",
        "DealNames": [
            "20200318114212"
        ],
        "RequestId": "2b6f7e2a-e909-4753-84b7-0db3e6099877"
    }
}

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 order.
FailedOperation.DBError Database error.
FailedOperation.GetVpcFailed Failed to get VPC information.
InternalError.DBError Database error
InternalError.UnknownError Unknown error.
InvalidParameter.InputIllegal Input error.
InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
InvalidParameter.PayOrderFailed Failed to make order payment.
InvalidParameterValue.IllegalRegion Invalid region.
InvalidParameterValue.IllegalSpec Incorrect instance specification information.
InvalidParameterValue.IllegalZone Incorrect AZ ID.
InvalidParameterValue.SecurityGroupIdIsIllegal Invalid security group ID.
ResourceNotFound.VpcNotExist The VPC does not exist.
ResourceUnavailable.VpcNotExist VPC not found.
UnauthorizedOperation.PermissionDenied CAM authentication error.
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