创建实例

最近更新时间:2018-11-15 19:05:52

1. 接口描述

接口请求域名: sqlserver.tencentcloudapi.com 。

本接口(CreateDBInstances)用于创建实例。

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:sqlserver.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateDBInstances
Version String 公共参数,本接口取值:2018-03-28
Region String 公共参数,详见产品支持的地域列表
Zone String 实例可用区,类似ap-guangzhou-1(广州一区);实例可售卖区域可以通过接口DescribeZones获取
Memory Integer 实例内存大小,单位GB
Storage Integer 实例磁盘大小,单位GB
InstanceChargeType String 付费模式,目前只支持预付费,其值为PREPAID。可不填,默认值为PREPAID
ProjectId Integer 项目ID
GoodsNum Integer 本次购买几个实例,默认值为1。取值不超过10
SubnetId String VPC子网ID,形如subnet-bdoe83fa;SubnetId和VpcId需同时设置或者同时不设置
VpcId String VPC网络ID,形如vpc-dsp338hz;SubnetId和VpcId需同时设置或者同时不设置
Period Integer 购买实例周期,默认取值为1,表示一个月。取值不超过48
AutoVoucher Integer 是否自动使用代金券;1 - 是,0 - 否,默认不使用
VoucherIds.N Array of String 代金券ID数组,目前单个订单只能使用一张
DBVersion String 数据库版本号,目前取值有2012SP3,表示SQL Server 2012;2008R2,表示SQL Server 2008 R2;2016SP1,表示SQL Server 2016 SP1。每个地域支持售卖的版本可能不一样,可以通过DescribeZones接口来拉取每个地域可售卖的版本信息。不填的话,默认为版本2008R2

3. 输出参数

参数名称 类型 描述
DealName String 订单名称
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建实例

输入示例

https://sqlserver.tencentcloudapi.com/?Action=CreateDBInstances
&Zone=ap-guangzhou-1
&Memory=2
&Storage=100
&<公共请求参数>

输出示例

{
  "Response": {
    "DealName": "201806261980",
    "RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
FailedOperation.CreateOrderFailed 创建订单失败。
FailedOperation.GetVpcFailed 获取VPC网络信息失败。
InternalError.DBError 数据库错误。
InvalidParameter.InputIllegal 输入错误。
InvalidParameter.ParamsAssertFailed 参数断言转换错误。
InvalidParameterValue.IllegalRegion 地域错误。
InvalidParameterValue.IllegalSpec 实例规格信息错误。
InvalidParameterValue.IllegalZone 可用区ID错误。
ResourceNotFound.VpcNotExist VPC网路不存在。