Help & DocumentationTencentDB for SQL ServerAPI DocumentationInstance Management APIsCreateDBInstances

CreateDBInstances

Last updated: 2020-04-02 18:42:31

PDF

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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: sqlserver.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: CreateDBInstances.
Version Yes String Common parameter. The value used for this API: 2018-03-28.
Region Yes String Common parameter. 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 Enterprise), 2012SP3 (SQL Server 2012 Enterprise), 2016SP1 (SQL Server 2016 Enterprise), 201602 (SQL Server 2016 Standard), 2017 (SQL Server 2017 Enterprise). The version purchasable varies by region and can be queried by calling the DescribeProductConfig API. If this parameter is left empty, 2008R2 will be used by default.
AutoRenewFlag No Integer Auto-renewal flag. 0: normal renewal, 1: auto-renewal. Default value: 1.

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 instance

Input Example

https://sqlserver.tencentcloudapi.com/?Action=CreateDBInstances
&Zone=ap-guangzhou-1
&Memory=2
&Storage=100
&<Common request parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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