调用CreateClusterTemplate接口，创建一个E-MapReduce集群模板，可以用于数据开发初始化新集群。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateClusterTemplate

系统规定参数。对于您自行拼凑HTTP或HTTPS URL发起的API请求，该参数为必选参数。取值：CreateClusterTemplate。
ClusterType String 是 HADOOP

集群类型。
TemplateName String 是 templateName2

模版名称。
ZoneId String 是 cn-hangzhou-b

区域ID。
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.DiskCapacity Integer 是 80

机器组的数据盘容量。
HostGroup.N.DiskCount Integer 是 1

机器组的数据盘数量。
HostGroup.N.DiskType String 是 CLOUD_EFFICIENCY

系统盘类型：

  • CLOUD：普通云盘
  • CLOUD_EFFICIENCY：高效云盘
  • CLOUD_SSD：SSD云盘
HostGroup.N.HostGroupName String 是 master_group

待查询的机器组名称。
HostGroup.N.HostGroupType String 是 MASTER

待查询的机器组类型：

  • MASTER：主实例组
  • CORE：核心实例组
  • TASK：计算实例组
HostGroup.N.InstanceType String 是 ecs.g5.xlarge

机器组的实例。
HostGroup.N.NodeCount Integer 是 2

机器组的节点数。
HostGroup.N.SysDiskCapacity Integer 是 80

机器组的系统盘容量。
HostGroup.N.SysDiskType String 是 CLOUD_SSD

系统盘类型。取值如下：

  • CLOUD：普通云盘
  • CLOUD_EFFICIENCY：高效云盘
  • CLOUD_SSD：SSD云盘
EmrVer String 是 EMR-3.15.0

集群版本。
RegionId String 是 cn-hangzhou

地域ID。
KeyPairName String 否 test_pair

密钥对。
MetaStoreType String 否 LOCAL

元数据类型：

  • LOCAL：集群内部元数据
  • UNIFIED：统一元数据
  • USER_RDS：用户自建RDS
MetaStoreConf String 否 无

一个JSON字段，包含dbUrl、dbUserName和dbPassword分别代表RDS的连接串、用户名和密码。dbUrl中要带上库名。
BootstrapAction.N.ExecutionTarget String 否 core_group

脚本执行范围，取值如下：

  • 整个集群，传入空值即可
  • 机器组名称
BootstrapAction.N.ExecutionMoment String 否 BEFORE_INSTALL

脚本执行时机，取值如下：

  • BEFORE_INSTALL：服务安装之前执行
  • AFTER_STARTED：服务启动之后执行
BootstrapAction.N.ExecutionFailStrategy String 否 FAILED_BLOCKED

脚本失败执行策略，取值如下：

  • FAILED_BLOCKED：失败后工作流转人工处理
  • FAILED_CONTINUE：失败后继续执行
Tag.N.Key String 否 DevDept

精确查找EMR集群时使用的标签键。标签键的取值范围：1~128。N的取值范围：1~20。Tag.N用于精确查找绑定了指定标签的EMR集群，由一个键值对组成。

  • 仅指定Tag.N.Key时，则返回关联该标签键的所有集群。
  • 仅指定Tag.N.Value，则报错MissingParameter.TagKey。
  • 同时指定多个标签键值对时，仅同时满足所有标签键值对的EMR集群会被查找到。
Tag.N.Value String 否 DevNianmin

精确查找EMR集群时使用的标签值。标签值的取值范围：1~128。N的取值范围：1~20。
ResourceGroupId String 否 rg-bp67acfmxazb4p****

资源组ID。
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

是否启用高安全：

  • true：启用高可用
  • false：不启用高可用
HighAvailabilityEnable Boolean 否 true

是否启用高可用：

  • true：启用高可用
  • false：不启用高可用
InitCustomHiveMetaDb Boolean 否 false

保留字段。
InstanceGeneration String 否 ecs-3

ECS实例分代。
IoOptimized Boolean 否 true

是否I/O优化：

  • true：优化
  • false：不优化
IsOpenPublicIp Boolean 否 true

是否开放公网IP：

  • true：开放公网IP
  • false：不开放公网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服务：

  • true：开启SSH服务
  • false：不开启SSH服务
UseCustomHiveMetaDb Boolean 否 false

是否使用Hive统一元数据：

  • true：使用Hive统一元数据
  • false：不使用Hive统一元数据
UseLocalMetaDb Boolean 否 false

是否使用本地Hive元数据库：

  • true：使用
  • false：不使用
UserDefinedEmrEcsRole String 否 AliyunEmrEcsDefaultRole

调用ECS接口使用的权限名。
VpcId String 否 vpc-bp1l4urd87xlh7i4b****

VPC ID。
VSwitchId String 否 vsw-bp10tvjyc77psy0z5****

虚拟交换机的ID。
BootstrapAction.N.Arg String 否 --a

引导操作的参数。
Config.N.Encrypt String 否 0

保留字段，不需要设置。
Config.N.Replace String 否 0

保留字段，无需设置。
HostGroup.N.AutoRenew Boolean 否 false

是否自动扩容：

  • true：自动扩容
  • false：不自动扩容
HostGroup.N.ChargeType String 否 PostPaid

付费类型：

  • PostPaid：按量付费集群
  • PrePaid：包年包月集群
HostGroup.N.ClusterId String 否 0

无需设置。
HostGroup.N.Comment String 否 header

机器组的注释。
HostGroup.N.CreateType String 否 ON-DEMAND

机器组创建类型：

  • ON-DEMAND：按需创建
  • MANUAL：手动创建
HostGroup.N.HostGroupId String 否 0

无需填写。
HostGroup.N.MultiInstanceTypes String 否 ["ecs.c5.xlarge","ecs.sn1ne.xlarge","ecs.hfc5.xlarge"]

JSON字段。机型列表，可用于创建机器的机型列表。
HostGroup.N.Period Integer 否 30

机器组的过期时间。
HostGroup.N.VSwitchId String 否 vsw-bp10tvjyc77psy0z5****

机器组的交换机ID。
AutoRenew Boolean 否 false

自动续费。
DepositType String 否 HALF_MANAGED

集群的托管类型：

  • HALF_MANAGED：半托管
  • 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格式 

{
    "code": "200",
    "data": {
        "RequestId": "8CA40D40-2092-4A09-9F07-2F9C1399FB11",
        "ClusterTemplateId": "CT-35498C56B3F1****"
    },
    "requestId": "8CA40D40-2092-4A09-9F07-2F9C1399FB11",
    "successResponse": true
}