1. 接口描述
接口请求域名: cvm.tencentcloudapi.com 。
本接口 (AllocateHosts) 用于创建一个或多个指定配置的CDH实例。
- 当HostChargeType为PREPAID时,必须指定HostChargePrepaid参数。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AllocateHosts。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Placement | 是 | Placement | 实例所在的位置。通过该参数可以指定实例所属可用区,所属项目等属性。 示例值:{ "Zone": "ap-shanghai-2" } |
ClientToken | 否 | String | 用于保证请求幂等性的字符串。 示例值:a521b4e4-c903-4d37-9de6-8906e3ad8eb7 |
HostChargePrepaid | 否 | ChargePrepaid | 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。 示例值:{ "Period": 1, "RenewFlag": "NOTIFY_AND_MANUAL_RENEW", "TimeUnit": "MONTH" } |
HostChargeType | 否 | String | 实例计费类型。目前仅支持:PREPAID(预付费,即包年包月模式),默认为:'PREPAID'。 示例值:PREPAID |
HostType | 否 | String | CDH实例机型,默认为:'HS1'。 示例值:HS1 |
HostCount | 否 | Integer | 购买CDH实例数量,默认为:1。 示例值:1 |
TagSpecification.N | 否 | Array of TagSpecification | 标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例。 示例值:[ { "ResourceType": "host", "Tags": [ { "Key": "myTag", "Value": "cloud" } ] } ] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
HostIdSet | Array of String | 新创建云子机的实例ID列表。 示例值:["host-lan4lb2k"] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 包年包月CDH实例购买
购买付费模式为包年包月的CDH实例,指定位置在广州二区,购买一个月,到期自动续费,实例机型为HS1,购买一台
输入示例
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AllocateHosts
<公共请求参数>
{
"HostChargeType": "PREPAID",
"HostCount": "1",
"Placement": {
"Zone": "ap-guangzhou-2"
},
"HostType": "HS1",
"HostChargePrepaid": {
"RenewFlag": "NOTIFY_AND_AUTO_RENEW",
"Period": "1"
}
}
输出示例
{
"Response": {
"HostIdSet": [
"host-lan4lb2k"
],
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidAccount.InsufficientBalance | 账户余额不足。 |
InvalidHostId.Malformed | 无效CDH ID 。指定的CDH ID 格式错误。例如ID 长度错误host-1122 。 |
InvalidParameterValue.Range | 无效参数值。参数值取值范围不合法。 |
InvalidParameterValue.ZoneNotSupported | 请求不支持该可用区 |
InvalidPeriod | 无效时长。目前只支持时长:[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36],单位:月。 |
InvalidProjectId.NotFound | 无效的项目ID,指定的项目ID不存在。 |
InvalidRegion.NotFound | 未找到该区域。 |
InvalidZone.MismatchRegion | 指定的zone 不存在。 |
ResourceInsufficient.ZoneSoldOutForSpecifiedInstance | 指定的实例类型在选择的可用区已售罄。 |