1. 接口描述
接口请求域名： sqlserver.tencentcloudapi.com 。
本接口（CreateBasicDBInstances）用于创建基础版实例 (云盘)。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateBasicDBInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Zone | 是 | String | 实例可用区，类似ap-guangzhou-1（广州一区）；实例可售卖区域可以通过接口DescribeZones获取 示例值：ap-guangzhou-3 |
| Cpu | 是 | Integer | 实例的CPU核心数 示例值：2 |
| Memory | 是 | Integer | 实例内存大小，单位GB 示例值：2 |
| Storage | 是 | Integer | 实例磁盘大小，单位GB 示例值：20 |
| SubnetId | 是 | String | VPC子网ID，形如subnet-bdoe83fa 示例值：subnet-pudyecyk |
| VpcId | 是 | String | VPC网络ID，形如vpc-dsp338hz 示例值：vpc-huew581t |
| MachineType | 是 | String | 购买实例的宿主机类型，CLOUD_PREMIUM-虚拟机高性能云盘，CLOUD_SSD-虚拟机SSD云盘,CLOUD_HSSD-虚拟机加强型SSD云盘，CLOUD_TSSD-虚拟机极速型SSD云盘，CLOUD_BSSD-虚拟机通用型SSD云盘 示例值：CLOUD_PREMIUM |
| InstanceChargeType | 否 | String | 付费模式，取值支持 PREPAID（预付费），POSTPAID（后付费）。 示例值：PREPAID |
| ProjectId | 否 | Integer | 项目ID 示例值：0 |
| GoodsNum | 否 | Integer | 本次购买几个实例，默认值为1。取值不超过10 示例值：1 |
| DBVersion | 否 | String | sqlserver版本，目前所有支持的版本有：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)。每个地域支持售卖的版本不同，可通过DescribeProductConfig接口来拉取每个地域可售卖的版本信息。不填，默认为版本2008R2。 示例值：2008R2 |
| Period | 否 | Integer | 购买实例周期，默认取值为1，表示一个月。取值不超过48 示例值：1 |
| SecurityGroupList.N | 否 | Array of String | 安全组列表，填写形如sg-xxx的安全组ID 示例值：sg-xxx |
| AutoRenewFlag | 否 | Integer | 自动续费标志：0-正常续费 1-自动续费，默认为1自动续费。只在购买预付费实例时有效。 示例值：0 |
| AutoVoucher | 否 | Integer | 是否自动使用代金券；1 - 是，0 - 否，默认不使用 示例值：2 |
| VoucherIds.N | 否 | Array of String | 代金券ID数组，目前单个订单只能使用一张 示例值：xxx |
| Weekly.N | 否 | Array of Integer | 可维护时间窗配置，以周为单位，表示周几允许维护，1-7分别代表周一到周末 示例值：["1\n"] |
| StartTime | 否 | String | 可维护时间窗配置，每天可维护的开始时间 示例值：00:00 |
| Span | 否 | Integer | 可维护时间窗配置，持续时间，单位：小时 示例值：6 |
| ResourceTags.N | 否 | Array of ResourceTag | 新建实例绑定的标签集合 |
| Collation | 否 | String | 系统字符集排序规则，默认：Chinese_PRC_CI_AS 示例值：Chinese_PRC_CI_AS |
| TimeZone | 否 | String | 系统时区，默认：China Standard Time 示例值：China Standard Time |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DealName | String | 订单名称 示例值：20200713383000001111250 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建基础版实例
创建基础版实例
输入示例
POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBasicDBInstances
<公共请求参数>
{
"VpcId": "vpc-huew581t",
"AutoRenewFlag": "0",
"Zone": "ap-guangzhou-3",
"GoodsNum": "1",
"TimeZone": "China Standard Time",
"DBVersion": "2008R2",
"Storage": "20",
"Period": "1",
"MachineType": "CLOUD_PREMIUM",
"Collation": "Chinese_PRC_CI_AS",
"InstanceChargeType": "PREPAID",
"StartTime": "00:00",
"Memory": "2",
"SubnetId": "subnet-pudyecyk",
"Span": "6",
"Cpu": "1",
"Weekly": [
"1"
]
}输出示例
{
"Response": {
"DealName": "20200713383000001111250",
"RequestId": "d84adfca-3ff0-46d2-b400-b5527446df72"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.CreateOrderFailed | 创建订单失败。 |
| FailedOperation.DBError | 数据库错误。 |
| FailedOperation.GetVpcFailed | 获取VPC网络信息失败。 |
| InternalError.DBError | 数据库错误。 |
| InternalError.VPCError | VPC错误。 |
| InvalidParameter.InputIllegal | 输入错误。 |
| InvalidParameter.ParamsAssertFailed | 参数断言转换错误。 |
| InvalidParameter.PayOrderFailed | 支付订单失败。 |
| InvalidParameterValue.IllegalSpec | 实例规格信息错误。 |
| InvalidParameterValue.ParameterTypeError | 参数类型错误。 |
| InvalidParameterValue.SecurityGroupIdIsIllegal | 安全组ID非法。 |
| ResourceNotFound.VpcNotExist | VPC网络不存在。 |
| ResourceUnavailable.VpcNotExist | VPC不存在。 |
| UnauthorizedOperation.PermissionDenied | cam鉴权错误。 |