创建CDH实例

最近更新时间:2018-10-12 16:02:24

1. 接口描述

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

本接口 (AllocateHosts) 用于创建一个或多个指定配置的CDH实例。

  • 当HostChargeType为PREPAID时,必须指定HostChargePrepaid参数。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AllocateHosts
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
Placement Placement 实例所在的位置。通过该参数可以指定实例所属可用区,所属项目等属性。
ClientToken String 用于保证请求幂等性的字符串。
HostChargePrepaid ChargePrepaid 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
HostChargeType String 实例计费类型。目前仅支持:PREPAID(预付费,即包年包月模式)。
HostType String CDH实例机型,默认为:'HS1'。
HostCount Integer 购买CDH实例数量。

3. 输出参数

参数名称 类型 描述
HostIdSet Array of String 新创建云子机的实例id列表。
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 包年包月CDH实例购买

输入示例

https://cvm.tencentcloudapi.com/?Action=AllocateHosts
&Placement.Zone=ap-guangzhou-2
&HostChargeType=PREPAID
&HostChargePrepaid.Period=1
&HostChargePrepaid.RenewFlag=NOTIFY_AND_AUTO_RENEW
&HostType=HS1
&HostCount=1
&<公共请求参数>

输出示例

{
  "Response": {
    "HostIdSet": [
      "host-lan4lb2k"
    ],
    "RequestID": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidPeriod 无效时长。目前只支持时长:[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36],单位:月。
InvalidProjectId.NotFound 无效的项目ID,指定的项目ID不存在。
InvalidRegion.NotFound 未找到该区域。
InvalidZone.MismatchRegion 指定的zone不存在。

如果有其他疑问,你也可以通过提问形式与我们联系探讨