1. 接口描述
接口请求域名： tke.tencentcloudapi.com 。
预留券实例的购买会预先扣除本次实例购买所需金额，在调用本接口前请确保账户余额充足。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateReservedInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2018-05-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ReservedInstanceSpec | 是 | ReservedInstanceSpec | 预留券实例规格。 |
| InstanceCount | 是 | Integer | 购买实例数量，一次最大购买数量为300。 示例值：1 |
| InstanceChargePrepaid | 是 | InstanceChargePrepaid | 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。 |
| InstanceName | 否 | String | 预留券名称。 |
| ClientToken | 否 | String | 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ReservedInstanceIds | Array of String | 预留券实例 ID。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建通用型预留券
创建的预留券是地域抵扣范围，如需修改抵扣范围，请调用修改抵扣范围接口。
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateReservedInstances
<公共请求参数>
{
"ReservedInstanceSpec": {
"Type": "common",
"Cpu": 1,
"Memory": 2
},
"InstanceCount": 1,
"InstanceChargePrepaid": {
"Period": 1,
"RenewFlag": "NOTIFY_AND_MANUAL_RENEW"
},
"ClientToken": "my-unique-token"
}输出示例
{
"Response": {
"RequestId": "adbb030e-163e-44c6-a940-fb42190d0d56",
"ReservedInstanceIds": [
"eksri-mloz4700"
]
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.InsufficientBalance | 余额不足。 |
| InternalError.NoPaymentAccess | 无支付权限。 |
| InternalError.NotVerified | 未实名认证。 |
| InternalError.Param | Param。 |
| InternalError.TradeCommon | 计费错误。 |
| InternalError.UnexpectedInternal | 未知的内部错误。 |