调用CreateClusterTemplate接口，创建一个E-MapReduce集模板，可用于数据开发初始化新集群。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CreateClusterTemplate |
系统规定参数。取值：CreateClusterTemplate。 |
| ClusterType | String | 是 | HADOOP |
集群类型。 |
| TemplateName | String | 是 | templateName2 |
模版名称。 |
| BootstrapAction.N.Name | String | 是 | action_name |
引导操作的名字。 |
| BootstrapAction.N.Path | String | 是 | oss://bucket/path |
引导操作脚本路径。 |
| Config.N.ConfigKey | String | 是 | fs.trash.interval |
自定义配置项的Key。 |
| Config.N.ConfigValue | String | 是 | 60 |
自定义配置项的值。 |
| Config.N.FileName | String | 是 | yarn-site |
自定义配置项所属文件名。 |
| Config.N.ServiceName | String | 是 | YARN |
自定义配置项服务名（大写）。 |
| HostGroup.N.HostGroupType | String | 是 | MASTER |
机器组的类型。 |
| HostGroup.N.InstanceType | String | 是 | ecs.g5.xlarge |
机器组的实例类型。 |
| HostGroup.N.NodeCount | Integer | 是 | 2 |
机器组的节点数。 |
| EmrVer | String | 是 | EMR-3.15.0 |
集群版本。 |
| RegionId | String | 是 | cn-hangzhou |
地域ID。 |
| KeyPairName | String | 否 | test_pair |
密钥对。 |
| MetaStoreConf | String | 否 | {"dbUrl":"jdbc:mysql://rm-xxxxx.mysql.rds.aliyuncs.com:3306/hivemeta3?createDatabaseIfNotExist=true&characterEncoding=UTF-8","dbUserName":"user","dbPassword":"password"} |
一个JSON字段，包含dbUrl, dbUserName, dbPassword分别代表RDS的连接串、用户名和密码。dbUrl 中要带上库名。 |
| MetaStoreType | String | 否 | local |
可选值：local, unified, user_rds 分别代表集群内部元数据、统一元数据和用户自建RDS作为元数据。 |
| Configurations | String | 否 | [{"classification": "core-site","properties": {"fs.trash.interval": "61"}},{"classification": "hadoop-log4j","properties": {"hadoop.log.file": "hadoop1.log","hadoop.root.logger": "INFO","a.b.c": "ABC"}}] |
软件自定义配置（集群启动前，可以指定一个JSON文件修改软件配置）。 |
| EasEnable | Boolean | 否 | true |
是否启用高安全。 |
| HighAvailabilityEnable | Boolean | 否 | true |
是否启用高可用。 |
| InitCustomHiveMetaDb | Boolean | 否 | true |
如果指定为true，Hive 的hive-site配置项init.meta.db会被设置为 true。 |
| InstanceGeneration | String | 否 | ecs-3 |
ECS实例分代。 |
| IoOptimized | Boolean | 否 | true |
是否I/O优化。 |
| IsOpenPublicIp | Boolean | 否 | true |
是否开放公网IP。 |
| LogPath | String | 否 | oss://bucket/path |
OSS文件路径。 |
| MachineType | String | 否 | ECS |
无需设置，总是为ECS。 |
| MasterPwd | String | 否 | pwd |
Master机器密码。 |
| NetType | String | 否 | vpc |
网络类型。 |
| OptionSoftWareList.N | RepeatList | 否 | ["HBASE","FLINK"] |
可选软件列表。 |
| Period | Integer | 否 | 36 |
包年包月集群的过期时间。 |
| SecurityGroupId | String | 否 | sg-bp1id7ajv83kmqwq**** |
安全组ID。 |
| SecurityGroupName | String | 否 | sg-name |
需要新创建的安全组的名字。 |
| SshEnable | Boolean | 否 | true |
是否开启集群机器的SSH服务。 |
| UseCustomHiveMetaDb | Boolean | 否 | false |
是否使用Hive统一元数据。 |
| UseLocalMetaDb | Boolean | 否 | false |
使用本地Hive元数据库。 |
| UserDefinedEmrEcsRole | String | 否 | AliyunEmrEcsDefaultRole |
调用ECS接口使用的权限名。 |
| VpcId | String | 否 | vpc-bp1l4urd87xlh7i4b**** |
VPC ID。 |
| VSwitchId | String | 否 | vsw-bp10tvjyc77psy0z5**** |
虚拟交换机的ID。 |
| ZoneId | String | 否 | cn-hangzhou-b |
区域ID。 |
| BootstrapAction.N.Arg | String | 否 | --a |
引导操作的参数。 |
| Config.N.Encrypt | String | 否 | 0 |
保留字段，不需要设置。 |
| Config.N.Replace | String | 否 | 0 |
保留字段，无需设置。 |
| HostGroup.N.AutoRenew | Boolean | 否 | false |
是否自动扩容。 |
| HostGroup.N.ChargeType | String | 否 | PostPaid |
机器组的付费类型。 |
| HostGroup.N.ClusterId | String | 否 | 0 |
无需设置。 |
| HostGroup.N.Comment | String | 否 | header |
机器组的注释。 |
| HostGroup.N.CreateType | String | 否 | ON-DEMAND |
机器组创建类型。 |
| HostGroup.N.DiskCapacity | Integer | 否 | 80 |
机器组的数据盘容量。 |
| HostGroup.N.DiskCount | Integer | 否 | 1 |
机器组的数据盘数量。 |
| HostGroup.N.DiskType | String | 否 | CLOUD_EFFICIENCY |
机器组的数据盘类型。 |
| HostGroup.N.HostGroupId | String | 否 | 0 |
无需填写。 |
| HostGroup.N.HostGroupName | String | 否 | 主实例组 |
机器组的名字。 |
| HostGroup.N.MultiInstanceTypes | String | 否 | ["ecs.c5.xlarge","ecs.sn1ne.xlarge","ecs.hfc5.xlarge"] |
JSON字段。机型列表，可用于创建机器的机型列表。 |
| HostGroup.N.Period | Integer | 否 | 30 |
机器组的过期时间。 |
| HostGroup.N.SysDiskCapacity | Integer | 否 | 80 |
机器组的系统盘容量。 |
| HostGroup.N.SysDiskType | String | 否 | CLOUD_SSD |
机器组的系统盘类型。 |
| HostGroup.N.VSwitchId | String | 否 | vsw-bp10tvjyc77psy0z5**** |
机器组的交换机ID。 |
| AccessKeyId | String | 否 | LTAI8ljWyu7y**** |
阿里云AccessKey ID信息，用于标识访问者身份。 |
| AutoRenew | Boolean | 否 | false |
自动续费。 |
| DepositType | String | 否 | HALF_MANAGED |
集群托管类型。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ClusterTemplateId | String | CT-35498C56B3F12002 |
集群模版ID。 |
| RequestId | String | 8CA40D40-2092-4A09-9F07-2F9C1399FB11 |
请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateClusterTemplate
&ClusterType=HADOOP
&TemplateName=templateName2
&BootstrapAction.1.1ame=action_name
&BootstrapAction.1.Path=oss://bucket/path
&Config.1.ConfigKey=fs.trash.interval
&Config.1.ConfigValue=60
&Config.1.FileName=yarn-site
&Config.1.ServiceName=YARN
&HostGroup.1.HostGroupType=MASTER
&HostGroup.1.InstanceType=ecs.g5.xlarge
&HostGroup.1.1odeCount=2
&EmrVer=EMR-3.15.0
&RegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML 格式
<CreateClusterTemplateResponse>
<code>200</code>
<data>
<RequestId>8CA40D40-2092-4A09-9F07-2F9C1399FB11</RequestId>
<ClusterTemplateId>CT-35498C56B3F1****</ClusterTemplateId>
</data>
<requestId>8CA40D40-2092-4A09-9F07-2F9C1399FB11</requestId>
<successResponse>true</successResponse>
</CreateClusterTemplateResponse>JSON 格式
{
"successResponse":true,
"requestId":"8CA40D40-2092-4A09-9F07-2F9C1399FB11",
"data":{
"RequestId":"8CA40D40-2092-4A09-9F07-2F9C1399FB11",
"ClusterTemplateId":"CT-35498C56B3F1****"
},
"code":"200"
}错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | Forbbiden | User not authorized to operate on the specified resource. | 没有权限操作指定资源，联系主账号授权 |
| 400 | ECSInfo.DiskSize.TooSmall | disk size per ecs should be >= 80GB. | 磁盘容量太小，加大磁盘容量 |
| 403 | User.OtherUserResource.NotAllow | It is not allowed to operate other user's resource | 不能操作其它用户的资源 |
| 403 | User.Account.Abnormal | The User Account maybe is out of service! | 用户帐号已经停止服务 |
| 403 | Master.Pwd.Cannot.Blank | Master password can not be blank when enable password! | Master节点的密码不能为空，填写Master的密码 |
| 403 | LogPath.Cannot.Blank | Log path can not be blank when enablbe log! | 日志路径不能为空，请填写正确的参数 |
| 403 | EMR.Version.Not.Exist | Specified emr version [%s] does not exist in region [%s]! | 指定EMR版本不存在，选择正确的EMR版本 |
| 400 | HighAvailability.Master.NodeCount.Not.Match | HighAvailability parameter does not match the master's node count | 高可用参数与master数量不匹配，HA集群需要master节点个数为2 |
| 400 | HighAvailability.is.not.permitted.in.this.emr.version | HighAvailability parameter is not permitted in this emr version | 该EMR版本不支持HA集群，切换EMR版本 |
| 400 | InvalidParameter.Period | Invalid parameter 'period'. | 包年包月类型的period参数不合规范 |
| 400 | Balance.Not.Enough | Account balance is not enough! | 帐号没有足够的余额，账户至少有100元人民币余额 |
| 403 | VSwitch.NotBelongTo.Zone | VSwitchid should belong to the ZoneId! | 指定交换机不属于该可用区 |
| 400 | InsufficientBalance | Your account does not have enough balance | 帐号没有足够的余额，帐号至少有100元余额 |
| 400 | Create.PrePaid.Cluster.Failed | Create prepaid cluster order failed:[%s] | 创建包年包月集群订单失败 |
| 400 | ECSInfo.ECSOrder.INVALID | invalid parameter format(ecsorderinfo) | 创建订单参数错误 |
| 400 | Ecs.InstanceType.NotSupported | Unsupported ecs instance type [%s] at zone [%s] with IO-optimized [%s] and network type [%s]. | 实例规格不支持，选择其它实例规格 |
| 400 | DiskType.Invalid | Unsupported disk type [%s] at zone [%s] with IO-optimized [%s] and network type [%s]. | 磁盘类型不支持，更换磁盘类型 |
| 400 | Unsupported.DiskType | Ecs instance type [%s] does not support disk type [%] | 磁盘类型不支持 |
| 400 | Unsupported.ZoneId | Zone [%s] is invalid or not supported in emr | EMR不支持该可用区，切换可用区 |
| 400 | ECSInfo.DiskSize.TooBig | Disk size exceeded max value limit. | 磁盘容量超过磁盘限制，减少磁盘容量 |
| 400 | ECSInfo.DiskCount.ExceedLimit | Disk count exceeded max value limit. | 磁盘块数超过限制，减少磁盘块数 |
| 400 | ECSInfo.NodeType.Unsupported | the specify node type is unsupport. | 指定节点类型不支持，切换节点类型 |
| 400 | Must.Specify.MasterNode | master node is mandatory. | 请指定Master节点信息 |
| 400 | Only.Support.One.Master | Only one master node is supported in emr cluster | 在EMR集群中只支持一个主节点 |
| 400 | Have.Orders.Wait.For.Pay | Have other orders wait for pay | 有另外的待付款订单 |
| 400 | Unsupported.IoOptimization.Option | IO-optimization option [%s] is not supported at zone [%s] and network type [%s]. | 该可用区中的该网络类型不支持IO优化机型 |
| 400 | Unsupported.EcsInstanceGeneration | Unsupported ecs instance generation [%s] at zone [%s] with IO-optimized [%s] and network type [%s]. | 该可用区中的该网络类型不支持IO优化机型 |
| 400 | AuthRealNameNotPass | User real name authenticate failed! | 帐号没有经过实名认证，进行实名认证 |
| 403 | EMR.Version.OptionSoftWare.UnSupported | only emr version >= 2.0.0 support optionsoftware. | 不能选择可选的软件，只有EMR2.0.0以上版本可以装可选软件 |
| 403 | Check.Account.Failed | Verify account's registration info failed:[%s]. | 验证帐号失败，帐号信息不完整，请补全帐号信息 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 内部错误，请提工单 |
访问错误中心查看更多错误码。