调用ListClusterTemplates接口,查询指定或者全部集群模版列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListClusterTemplates |
系统规定参数。对于您自行拼凑HTTP或HTTPS URL发起的API请求,该参数为必选参数。取值:ListClusterTemplates。 |
PageNumber | Integer | 是 | 1 |
当前页码,从1开始。 |
PageSize | Integer | 是 | 5 |
分页查询时设置的每页行数。 |
RegionId | String | 否 | cn-hangzhou |
地域ID。您可以调用DescribeRegions接口查看最新的阿里云地域列表。 |
BizId | String | 否 | CT-1422C105DE88**** |
集群模版ID。 |
ProductType | String | 否 | EMR |
产品类型。固定值EMR。 |
ResourceGroupId | String | 否 | rg-bp67acfmxazb4p**** |
资源组ID。您可以调用ListResourceGroups查看资源组ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageNumber | Integer | 1 |
当前页码。 |
PageSize | Integer | 5 |
分页查询时设置的每页行数。 |
RequestId | String | 2DAD3958-DB40-45AC-A08D-01D876AA6D04 |
请求ID。 |
TemplateInfoList | Array of TemplateInfo |
集群模版列表。 |
|
TemplateInfo | |||
AllowNotebook | Boolean | true |
保留字段。 |
BootstrapActionList | Array of BootstrapAction |
引导操作列表。 |
|
BootstrapAction | |||
Arg | String | ---a |
参数。 |
Name | String | create |
操作名。 |
Path | String | oss://bucket/path |
引导操作脚本路径。 |
ClusterType | String | HADOOP |
集群类型。 |
ConfigList | Array of Config |
自定义配置项列表。 |
|
Config | |||
ConfigKey | String | fs.trash.interval |
自定义配置项的key。 |
ConfigValue | String | 60 |
自定义配置项的值。 |
Encrypt | String | 0 |
保留字段。 |
FileName | String | yarn-site |
自定义配置项所属文件名。 |
Replace | String | 0 |
保留字段。 |
ServiceName | String | YARN |
自定义配置项服务名(大写)。 |
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文件修改软件配置。 |
CreateSource | String | 2 |
模版通过何种方式创建。 |
DepositType | String | HALF_MANAGED |
托管类型:
|
EasEnable | Boolean | false |
是否高安全集群模板:
|
GmtCreate | Long | 1601361773000 |
创建时间。 |
GmtModified | Long | 1601361773000 |
修改时间。 |
HighAvailabilityEnable | Boolean | false |
是否高可用集群:
|
HostGroupList | Array of HostGroup |
机器组列表。 |
|
HostGroup | |||
ChargeType | String | PostPaid |
付费方式:
|
DiskCapacity | Integer | 80 |
机器组的数据盘容量。单位:GB。 |
DiskCount | Integer | 1 |
机器组的数据盘数量。 |
DiskType | String | CLOUD_ESSD |
机器组的数据盘类型。 |
HostGroupId | String | 0 |
保留字段。 |
HostGroupName | String | 主实例组 |
机器组名字。 |
HostGroupType | String | MASTER |
机器组类型。 |
InstanceType | String | ecs.g6.xlarge |
机器组型号。 |
MultiInstanceTypes | String | ecs.sn1.xlarge,ecs.sn2.xlarge |
多规格机器型号列表,使用逗号(,)隔开。 |
NodeCount | Integer | 1 |
机器组节点数。 |
Period | String | 36 |
包年包月时间(月:1,2,3,4,5,6,7,8,9,12,24,36)。 说明 按量付费集群无此参数。
|
SysDiskCapacity | Integer | 120 |
机器组的系统盘容量。 |
SysDiskType | String | CLOUD_ESSD |
机器组的系统盘类型。 |
Id | String | CT-53B394A1B559**** |
集群模版的ID。 |
InitCustomHiveMetaDb | Boolean | false |
保留字段,无需填写。 |
InstanceGeneration | String | ecs-3 |
实例规格族。保留字段。 |
IoOptimized | Boolean | true |
是否I/O优化:
|
IsOpenPublicIp | Boolean | true |
是否开放公网IP:
|
KeyPairName | String | test_kp |
密钥对名称。 |
LogEnable | Boolean | false |
是否开启OSS日志:
|
LogPath | String | oss//bucketname/path |
OSS文件路径。 |
MachineType | String | ECS |
机器类型。 |
MasterNodeTotal | Integer | 1 |
Master节点数量。 |
MetaStoreConf | String | rdsxxx.com |
统一元数据配置信息。 |
MetaStoreType | String | local |
统一元数据类型。 |
NetType | String | vpc |
网络类型。 |
SecurityGroupId | String | sg-bp1gldj1nzq5t3b8**** |
安全组ID。 |
SecurityGroupName | String | emr_sg |
需要新创建的安全组的名字。 |
SoftwareInfoList | List | ["ZOOKEEPER"] |
可选软件列表。 |
SshEnable | Boolean | true |
是否开启SSH:
|
TemplateName | String | template_name_2 |
集群模版名。 |
UseCustomHiveMetaDb | Boolean | false |
保留字段。 |
UseLocalMetaDb | Boolean | true |
是否使用Hive本地元数据:
|
UserDefinedEmrEcsRole | String | AliyunEmrEcsDefaultRole |
用于ECS调用的EMR权限名。 |
UserId | String | 125046002175**** |
创建用户ID。 |
VSwitchId | String | vsw-bp1g6ftcv6p1w6h8x**** |
交换机ID。 |
VpcId | String | pc-bp15pknn5td3mkc4g**** |
VPC ID。 |
ZoneId | String | cn-hangzhou-i |
可用区ID。 |
TotalCount | Integer | 1 |
集群模版总数。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListClusterTemplates
&PageNumber=1
&PageSize=5
&<公共请求参数>
正常返回示例
XML
格式
<TotalCount>1</TotalCount>
<RequestId>2DAD3958-DB40-45AC-A08D-01D876AA6D04</RequestId>
<PageSize>5</PageSize>
<PageNumber>1</PageNumber>
<TemplateInfoList>
<TemplateInfo>
<SecurityGroupName>emr_sg</SecurityGroupName>
<BootstrapActionList>
<BootstrapAction>
<Path>oss://bucket/path</Path>
<Arg>---a</Arg>
<Name>create</Name>
</BootstrapAction>
</BootstrapActionList>
<CreateSource>2</CreateSource>
<LogEnable>false</LogEnable>
<GmtModified>1601361773000</GmtModified>
<HighAvailabilityEnable>false</HighAvailabilityEnable>
<SshEnable>true</SshEnable>
<IsOpenPublicIp>true</IsOpenPublicIp>
<TemplateName>template_name_2</TemplateName>
<UserDefinedEmrEcsRole>AliyunEmrEcsDefaultRole</UserDefinedEmrEcsRole>
<NetType>vpc</NetType>
<SoftwareInfoList>
</SoftwareInfoList>
<UseLocalMetaDb>true</UseLocalMetaDb>
<KeyPairName>test_kp</KeyPairName>
<IoOptimized>true</IoOptimized>
<ZoneId>cn-hangzhou-i</ZoneId>
<VSwitchId>vsw-bp1g6ftcv6p1w6h8x****</VSwitchId>
<SecurityGroupId>sg-bp1gldj1nzq5t3b8****</SecurityGroupId>
<DepositType>HALF_MANAGED</DepositType>
<MachineType>ECS</MachineType>
<MetaStoreType>LOCAL</MetaStoreType>
<MasterNodeTotal>1</MasterNodeTotal>
<ClusterType>HADOOP</ClusterType>
<EasEnable>false</EasEnable>
<GmtCreate>1601361773000</GmtCreate>
<VpcId>vpc-bp15pknn5td3mkc4g****</VpcId>
<UserId>125046002175****</UserId>
<HostGroupList>
<HostGroup>
<HostGroupType>MASTER</HostGroupType>
<DiskType>CLOUD_ESSD</DiskType>
<DiskCount>1</DiskCount>
<DiskCapacity>80</DiskCapacity>
<HostGroupId>0</HostGroupId>
<NodeCount>1</NodeCount>
<SysDiskType>CLOUD_ESSD</SysDiskType>
<ChargeType>PostPaid</ChargeType>
<HostGroupName>主实例组</HostGroupName>
<InstanceType>ecs.g6.xlarge</InstanceType>
<SysDiskCapacity>120</SysDiskCapacity>
</HostGroup>
<HostGroup>
<HostGroupType>CORE</HostGroupType>
<DiskType>CLOUD_ESSD</DiskType>
<DiskCount>4</DiskCount>
<DiskCapacity>80</DiskCapacity>
<HostGroupId>0</HostGroupId>
<NodeCount>2</NodeCount>
<SysDiskType>CLOUD_ESSD</SysDiskType>
<ChargeType>PostPaid</ChargeType>
<HostGroupName>核心实例组</HostGroupName>
<InstanceType>ecs.g6.xlarge</InstanceType>
<SysDiskCapacity>120</SysDiskCapacity>
</HostGroup>
</HostGroupList>
<Id>CT-53B394A1B559****</Id>
<ConfigList>
</ConfigList>
</TemplateInfo>
</TemplateInfoList>
JSON
格式
{
"TotalCount": 1,
"RequestId": "2DAD3958-DB40-45AC-A08D-01D876AA6D04",
"PageSize": 5,
"PageNumber": 1,
"TemplateInfoList": {
"TemplateInfo": [
{
"SecurityGroupName": "emr_sg",
"BootstrapActionList": {
"BootstrapAction": [
{
"Path": "oss://bucket/path",
"Arg": "---a",
"Name": "create"
}
]
},
"CreateSource": 2,
"LogEnable": false,
"GmtModified": 1601361773000,
"HighAvailabilityEnable": false,
"SshEnable": true,
"IsOpenPublicIp": true,
"TemplateName": "template_name_2",
"UserDefinedEmrEcsRole": "AliyunEmrEcsDefaultRole",
"NetType": "vpc",
"SoftwareInfoList": {
"SoftwareInfo": []
},
"UseLocalMetaDb": true,
"KeyPairName": "test_kp",
"IoOptimized": true,
"ZoneId": "cn-hangzhou-i",
"VSwitchId": "vsw-bp1g6ftcv6p1w6h8x****",
"SecurityGroupId": "sg-bp1gldj1nzq5t3b8****",
"DepositType": "HALF_MANAGED",
"MachineType": "ECS",
"MetaStoreType": "LOCAL",
"MasterNodeTotal": 1,
"ClusterType": "HADOOP",
"EasEnable": false,
"GmtCreate": 1601361773000,
"VpcId": "vpc-bp15pknn5td3mkc4g****",
"UserId": "125046002175****",
"HostGroupList": {
"HostGroup": [
{
"HostGroupType": "MASTER",
"DiskType": "CLOUD_ESSD",
"DiskCount": 1,
"DiskCapacity": 80,
"HostGroupId": "0",
"NodeCount": 1,
"SysDiskType": "CLOUD_ESSD",
"ChargeType": "PostPaid",
"HostGroupName": "主实例组",
"InstanceType": "ecs.g6.xlarge",
"SysDiskCapacity": 120
},
{
"HostGroupType": "CORE",
"DiskType": "CLOUD_ESSD",
"DiskCount": 4,
"DiskCapacity": 80,
"HostGroupId": "0",
"NodeCount": 2,
"SysDiskType": "CLOUD_ESSD",
"ChargeType": "PostPaid",
"HostGroupName": "核心实例组",
"InstanceType": "ecs.g6.xlarge",
"SysDiskCapacity": 120
}
]
},
"Id": "CT-53B394A1B559****",
"ConfigList": {
"Config": []
}
}
]
}
}