调用CreateClusterTemplate接口,创建一个E-MapReduce集群模板。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateClusterTemplate | 系统规定参数。取值:CreateClusterTemplate。 |
ClusterType | String | 是 | HADOOP | 集群类型,取值如下:
|
TemplateName | String | 是 | ETLClusterTemplate | 模版名称。 |
ZoneId | String | 是 | cn-hangzhou-b | 可用区ID。您可以调用DescribeZones查看阿里云地域下的可用区。 |
BootstrapAction.N.Name | String | 是 | init_script | 引导操作名称。 |
BootstrapAction.N.Path | String | 是 | oss://bucket/path | 引导操作脚本OSS存放路径。 |
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 | 机器组的数据盘类型,取值如下:
|
HostGroup.N.HostGroupName | String | 是 | master_group | 机器组名称。 |
HostGroup.N.HostGroupType | String | 是 | MASTER | 机器组类型,取值如下:
说明 MASTER和CORE均只支持设置一个组。 |
HostGroup.N.InstanceType | String | 是 | ecs.g5.xlarge | 机器组中的ECS实例规格。更多信息,请参见实例规格族,您也可以调用DescribeInstanceTypes接口获得最新的规格表。 |
HostGroup.N.NodeCount | Integer | 是 | 2 | 机器组的节点数。 |
HostGroup.N.SysDiskCapacity | Integer | 是 | 80 | 机器组的系统盘容量。 |
HostGroup.N.SysDiskType | String | 是 | CLOUD_SSD | 系统盘类型,取值如下:
|
EmrVer | String | 是 | EMR-3.35.0 | EMR版本。提示:控制台创建集群可查看到EMR版本列表 |
RegionId | String | 是 | cn-hangzhou | 地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
KeyPairName | String | 否 | test_pair | 免密登录ECS密钥对。 |
MetaStoreType | String | 否 | user_rds | Hive元数据服务类型,取值如下:
|
MetaStoreConf | String | 否 | {"dbUrl":"jdbc:mysql://rm-xxxxxxxxxx.mysql.rds.aliyuncs.com/hmsdata?createDatabaseIfNotExist=true&characterEncoding=UTF-8","dbUserName":"xxxxxxx","dbPassword":"xxxxxx"} | 统一元数据服务的配置信息。 当MetaStoreType为local或者dlf时,不填该参数。 当MetaStoreType为user_rds时,值例子: {"dbUrl":"jdbc:mysql://rm-xxxxxxxxxx.mysql.rds.aliyuncs.com/hmsdata?createDatabaseIfNotExist=true&characterEncoding=UTF-8","dbUserName":"xxxxxxx","dbPassword":"xxxxxx"} |
HostGroup.N.PrivatePoolOptionsMatchCriteria | String | 否 | Target | 实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量,供实例启动时选择。取值如下:
|
HostGroup.N.PrivatePoolOptionsId | String | 否 | crp-bp1e4wcvoucrish**** | 私有池ID。即弹性保障服务ID或容量预定服务ID。 |
BootstrapAction.N.ExecutionTarget | String | 否 | core_group | 脚本执行范围,取值如下:
|
BootstrapAction.N.ExecutionMoment | String | 否 | BEFORE_INSTALL | 脚本执行时机,取值如下:
|
BootstrapAction.N.ExecutionFailStrategy | String | 否 | FAILED_BLOCKED | 脚本失败执行策略,取值如下:
|
Tag.N.Key | String | 否 | Dept | EMR集群标签键。N的取值范围:1~20。一旦传入该值,则不允许为空字符串。标签键的取值范围1~128,不能以aliyun和acs:开头,不能包含 http:// 或者 https:// 。 |
Tag.N.Value | String | 否 | DevIT | EMR集群标签值。N的取值范围:1~20。一旦传入该值,可以为空字符串。标签值的取值范围:1~128,不能以acs:开头,不能包含 http:// 或者 https:// 。 |
ResourceGroupId | String | 否 | rg-bp67acfmxazb4p**** | 资源组ID。 |
ClientToken | String | 否 | 123e4567-e89b-12d3-a456-42665544**** | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。 |
DataDiskEncrypted | Boolean | 否 | false | 保留字段。 |
DataDiskKMSKeyId | String | 否 | false | 保留字段。 |
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 | 是否开启高可用集群,取值如下:
高可用集群至少2个MASTER节点,未开启高可用集群,无法保证集群高可靠。 |
InitCustomHiveMetaDb | Boolean | 否 | false | 保留字段。 |
InstanceGeneration | String | 否 | ecs-3 | ECS实例分代。 |
IoOptimized | Boolean | 否 | true | 是否开启I/O优化,默认为true,该参数已废弃。 取值如下:
|
IsOpenPublicIp | Boolean | 否 | true | 是否开放公网IP:
|
LogPath | String | 否 | oss://bucket/path | OSS日志路径,该参数已废弃。 |
MachineType | String | 否 | ECS | 集群构建的IaaS层资源类型。取值:ECS。 |
MasterPwd | String | 否 | pwd | Master节点root密码。需要满足ECS的密码规则:8~30个字符,且同时包含任意三项(大、小写字母、数字和特殊符号)。 |
NetType | String | 否 | VPC | 网络类型。 取值:VPC。 |
OptionSoftWareList.N | RepeatList | 否 | ["HBASE","FLINK"] | 可选服务列表。服务名称为大写字母,如ZOOKEEPER,LIVY。 可选服务可从EMR控制台创建集群步骤1-软件配置-可选服务查看获取。 |
Period | Integer | 否 | 36 | 包年包月集群的过期时间,单位:月。 |
SecurityGroupId | String | 否 | sg-bp1id7ajv83kmqwq**** | 安全组ID。 |
SecurityGroupName | String | 否 | sg-name | 需要新建的安全组名称。如果不指定安全组ID,那么将使用这个名字创建一个新的安全组。当集群创建完成以后,可以在集群详情中看到创建的安全组ID。这个安全组将会带有默认的安全组策略:出方向开放所有端口。 参数SecurityGroupId和SecurityGroupName要求不能同时为空。 |
SshEnable | Boolean | 否 | true | 是否修改安全组规则允许公网SSH登录,默认为false,该参数已废弃,取值如下:
|
UseCustomHiveMetaDb | Boolean | 否 | false | 保留字段,无需填写。 |
UseLocalMetaDb | Boolean | 否 | false | 是否使用集群内置MySQL作为Hive元数据库。 取值如下:
集群内置MySQL单节点,无法保证高可靠。 |
UserDefinedEmrEcsRole | String | 否 | AliyunEmrEcsDefaultRole | 授权给ECS的角色,用于ECS内部访问OSS等其他阿里云服务。
|
VpcId | String | 否 | vpc-bp1l4urd87xlh7i4b**** | VPC ID。 |
VSwitchId | String | 否 | vsw-bp10tvjyc77psy0z5**** | 虚拟交换机的ID。 |
BootstrapAction.N.Arg | String | 否 | --arg1 | 引导操作的参数。 |
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.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 | 集群的托管类型,取值如下:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
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
格式
<RequestId>8CA40D40-2092-4A09-9F07-2F9C1399FB11</RequestId>
<ClusterTemplateId>CT-35498C56B3F1****</ClusterTemplateId>
JSON
格式
{
"RequestId": "8CA40D40-2092-4A09-9F07-2F9C1399FB11",
"ClusterTemplateId": "CT-35498C56B3F1****"
}