API 文档

创建实例

最近更新时间:2020-11-30 08:29:22

我的收藏

1. 接口描述

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

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

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(预付费),POSTPAID(后付费)。
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 sqlserver版本,目前只支持: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)版本。每个地域支持售卖的版本不同,可通过DescribeProductConfig接口来拉取每个地域可售卖的版本信息。不填,默认为版本2008R2。
AutoRenewFlag Integer 自动续费标志:0-正常续费 1-自动续费,默认为1自动续费。只在购买预付费实例时有效。
SecurityGroupList.N Array of String 安全组列表,填写形如sg-xxx的安全组ID
Weekly.N Array of Integer 可维护时间窗配置,以周为单位,表示周几允许维护,1-7分别代表周一到周末
StartTime String 可维护时间窗配置,每天可维护的开始时间
Span Integer 可维护时间窗配置,持续时间,单位:小时
HAType String 购买高可用实例的类型:DUAL-双机高可用 CLUSTER-集群,默认值为DUAL
MultiZones Boolean 是否跨可用区部署,默认值为false

3. 输出参数

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

4. 示例

示例1 创建实例

输入示例

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

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错误。
InvalidParameterValue.SecurityGroupIdIsIllegal 安全组ID非法。
ResourceNotFound.VpcNotExist VPC网络不存在。
UnauthorizedOperation.PermissionDenied cam鉴权错误。
目录