调用CreateClusterTemplate接口,创建一个E-MapReduce集群模板。

调试

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

请求参数

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

系统规定参数。取值:CreateClusterTemplate。

ClusterType String HADOOP

集群类型,取值如下:

  • HADOOP
  • KAFKA
  • DATA SCIENCE
  • DRUID
  • FLINK
  • GATEWAY
  • CLICKHOSUE
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:高安全集群
  • true:非高安全集群
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

机器类型。

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-35498C56B3F1****

集群模版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格式

<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>

JSON格式

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