调用 DescribeClusterTemplate 接口查询集群模版详情。

调试

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

请求参数

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

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

BizId String CT-35498C56B3F1****

集群模版ID。

AccessKeyId String LTAI8ljWyu7y**

阿里云AccessKey ID信息,用于标识访问者身份。

返回数据

名称 类型 示例值 描述
RequestId String 29A1D3B7-661C-4FCD-8577-DE93C8F6CA55

请求ID。

TemplateInfo

集群模版详情。

AllowNotebook Boolean false

是否允许交互式工作台。

BootstrapActionList

引导操作列表。

BootstrapAction

引导操作列表。

Arg String --a

参数

Name String action_name

操作名

Path String oss://bucket/path

脚本路径

ClusterType String HADOOP

集群类型。

ConfigList

自定义配置项列表。

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 FULL_MANAGED

托管类型。

EasEnable Boolean true

是否高安全。

EmrVer String EMR-3.16.0

EMR版本。

GmtCreate Long 1543765033000

创建时间。

GmtModified Long 1543765033000

修改时间。

HighAvailabilityEnable Boolean true

是否高可用集群。

HostGroupList

机器组列表。

HostGroup

机器组列表。

ChargeType String PostPaid

付费方式。

DiskCapacity Integer 80

机器组的数据盘容量。

DiskCount Integer 4

机器组的数据盘数量。

DiskType String CLOUD_SSD

机器组的数据盘类型。

HostGroupId String 0

保留字段。

HostGroupName String 主实例组

机器组名字。

HostGroupType String MASTER

机器组类型。

InstanceType String ecs.mn4.2xlarge

机器组型号。

MultiInstanceTypes String ecs.sn1.xlarge,ecs.sn2.xlarge

多规格机器型号列表,逗号隔开。

NodeCount Integer 2

机器组节点数。

Period String 36

包年包月时间(天)。

SysDiskCapacity Integer 40

机器组的系统盘容量。

SysDiskType String CLOUD_SSD

机器组的系统盘类型。

Id String CT-4A6799A79D73****

集群模版的ID。

InitCustomHiveMetaDb Boolean true

保留字段。

InstanceGeneration String ecs-3

ECS实例分代。

IoOptimized Boolean true

是否I/O优化。

IsOpenPublicIp Boolean true

是否开放公网IP。

KeyPairName String test_kp

秘钥对名称。

LogEnable Boolean true

是否开启OSS日志。

LogPath String oss//bucketname/path

OSS文件路径。

MachineType String ECS

机器类型。

MasterNodeTotal Integer 1

Master节点数量。

MasterPwd String testpd

Master节点的登录密码。

MetaStoreConf String rds-xxx.com

统一元数据的配置信息。

MetaStoreType String local

统一元数据类型。

NetType String vpc

网络类型。

SecurityGroupId String sg-bp1id7ajv83kmqwq2isx

安全组ID。

SecurityGroupName String emr_sg

需要新创建的安全组的名字。

SoftwareInfoList ["ZOOKEEPER"]

可选软件列表。

SoftwareInfo

可选软件列表。

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

交换机ID。

VpcId String vpc-bp1l4urd87xlh7i4b****

VPC ID。

ZoneId String cn-hangzhou-b

可用区ID。

示例

请求示例


http(s)://[Endpoint]/?Action=DescribeClusterTemplate
&BizId=CT-35498C56B3F1****
&<公共请求参数>

正常返回示例

XML 格式

<DescribeClusterTemplateResponse>
	  <requestId>29A1D3B7-661C-4FCD-8577-DE93C8F6CA55</requestId>
	  <templateInfo>
		    <clusterType>HADOOP</clusterType>
		    <createSource>2</createSource>
		    <depositType>HALF_MANAGED</depositType>
		    <easEnable>false</easEnable>
		    <emrVer>EMR-3.16.0</emrVer>
		    <gmtCreate>1543765033000</gmtCreate>
		    <gmtModified>1543765033000</gmtModified>
		    <highAvailabilityEnable>false</highAvailabilityEnable>
		    <hostGroupList>
			      <chargeType>PostPaid</chargeType>
			      <diskCapacity>80</diskCapacity>
			      <diskCount>1</diskCount>
			      <diskType>CLOUD_EFFICIENCY</diskType>
			      <hostGroupId></hostGroupId>
			      <hostGroupName>主实例组</hostGroupName>
			      <hostGroupType>MASTER</hostGroupType>
			      <instanceType>ecs.n4.xlarge</instanceType>
			      <nodeCount>1</nodeCount>
		    </hostGroupList>
		    <hostGroupList>
			      <chargeType>PostPaid</chargeType>
			      <diskCapacity>80</diskCapacity>
			      <diskCount>4</diskCount>
			      <diskType>CLOUD_EFFICIENCY</diskType>
			      <hostGroupId></hostGroupId>
			      <hostGroupName>核心实例组</hostGroupName>
			      <hostGroupType>CORE</hostGroupType>
			      <instanceType>ecs.n4.xlarge</instanceType>
			      <nodeCount>2</nodeCount>
		    </hostGroupList>
		    <id>CT-35498C56B3F1****</id>
		    <ioOptimized>true</ioOptimized>
		    <isOpenPublicIp>true</isOpenPublicIp>
		    <logEnable>false</logEnable>
		    <machineType>ECS</machineType>
		    <masterNodeTotal>0</masterNodeTotal>
		    <netType>vpc</netType>
		    <securityGroupId>sg-bp1id7ajv83kmqwq****</securityGroupId>
		    <securityGroupName>emxxx</securityGroupName>
		    <softwareInfoList>FLUME</softwareInfoList>
		    <softwareInfoList>FLINK</softwareInfoList>
		    <sshEnable>false</sshEnable>
		    <templateName>template_name_2</templateName>
		    <useLocalMetaDb>true</useLocalMetaDb>
		    <userDefinedEmrEcsRole>AliyunEmrEcsDefaultRole</userDefinedEmrEcsRole>
		    <userId>125046002175****</userId>
		    <vSwitchId>vsw-bp10tvjyc77psy0z5****</vSwitchId>
		    <vpcId>vpc-bp1l4urd87xlh7i4b****</vpcId>
		    <zoneId>cn-hangzhou-b</zoneId>
	  </templateInfo>
</DescribeClusterTemplateResponse>

JSON 格式

{
	"requestId":"29A1D3B7-661C-4FCD-8577-DE93C8F6CA55",
	"templateInfo":{
		"gmtModified":1543765033000,
		"clusterType":"HADOOP",
		"logEnable":false,
		"configList":[],
		"id":"CT-35498C56B3F1****",
		"emrVer":"EMR-3.16.0",
		"useLocalMetaDb":true,
		"masterNodeTotal":0,
		"vpcId":"vpc-bp1l4urd87xlh7i4b****",
		"userId":"125046002175****",
		"isOpenPublicIp":true,
		"highAvailabilityEnable":false,
		"depositType":"HALF_MANAGED",
		"gmtCreate":1543765033000,
		"machineType":"ECS",
		"sshEnable":false,
		"vSwitchId":"vsw-bp10tvjyc77psy0z5****",
		"bootstrapActionList":[],
		"securityGroupId":"sg-bp1id7ajv83kmqwq****",
		"easEnable":false,
		"zoneId":"cn-hangzhou-b",
		"userDefinedEmrEcsRole":"AliyunEmrEcsDefaultRole",
		"softwareInfoList":[
			"FLUME",
			"FLINK"
		],
		"hostGroupList":[
			{
				"instanceType":"ecs.n4.xlarge",
				"diskCount":1,
				"diskCapacity":80,
				"diskType":"CLOUD_EFFICIENCY",
				"chargeType":"PostPaid",
				"hostGroupName":"主实例组",
				"hostGroupId":"",
				"nodeCount":1,
				"hostGroupType":"MASTER"
			},
			{
				"instanceType":"ecs.n4.xlarge",
				"diskCount":4,
				"diskCapacity":80,
				"diskType":"CLOUD_EFFICIENCY",
				"chargeType":"PostPaid",
				"hostGroupName":"核心实例组",
				"hostGroupId":"",
				"nodeCount":2,
				"hostGroupType":"CORE"
			}
		],
		"netType":"vpc",
		"securityGroupName":"emxxx",
		"ioOptimized":true,
		"createSource":"2",
		"templateName":"template_name_2"
	}
}

错误码

HttpCode 错误码 错误信息 描述
403 Params.Illegal The specified parameters are wrongly formed.. 指定参数格式错误
403 User.OtherUserResource.NotAllow It is not allowed to operate other user's resource 不能操作其它用户的资源
500 InternalError The request processing has failed due to some unknown error. 内部错误,请提工单

访问错误中心查看更多错误码。