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

调试

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

请求参数

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

系统规定参数。取值：DescribeClusterTemplate。
BizId String 是 CT-35498C56B3F1****

集群模版ID。您可以调用ListClusterTemplates查看。

ResourceGroupId String 否 rg-acfmv6jutt6****

资源组ID。您可以调用ListResourceGroups查看资源组ID。

返回数据

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

请求ID。
TemplateInfo Struct

集群模版详情。
AllowNotebook Boolean false

是否允许交互式工作台。
BootstrapActionList Array of BootstrapAction

引导操作列表。
BootstrapAction
Arg String --a

参数。
Name String action_name

操作名。
Path String oss://bucket/path

脚本路径。
ClusterType String HADOOP

集群类型：

  • HADOOP
  • KAFKA
  • GATEWAY
  • DRUID
  • ZOOKEEPER
  • DATA_SCIENCE
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

集群的托管类型：

  • HALF_MANAGED：半托管
  • MANAGED：全托管
EasEnable Boolean true

是否高安全：

  • true：是
  • false：不是
EmrVer String EMR-3.16.0

E-MapReduce版本。
GmtCreate Long 1543765033000

创建时间。
GmtModified Long 1543765033000

修改时间。
HighAvailabilityEnable Boolean true

是否高可用集群：

  • true：是高可用
  • false：不是高可用
HostGroupList Array of HostGroup

机器组列表。
HostGroup
ChargeType String PostPaid

付费类型：

  • PostPaid：按量付费集群
  • PrePaid：包年包月集群
DiskCapacity Integer 80

机器组的数据盘容量。
DiskCount Integer 4

机器组的数据盘数量。
DiskType String CLOUD_SSD

系统盘类型：

  • CLOUD：普通云盘
  • CLOUD_EFFICIENCY：高效云盘
  • CLOUD_SSD：SSD云盘
HostGroupId String 0

保留字段。
HostGroupName String 主实例组

机器组名字。
HostGroupType String MASTER

待查询的机器组类型：

  • MASTER：主实例组
  • CORE：核心实例组
  • TASK：计算实例组
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

机器组的系统盘类型：

  • CLOUD：普通云盘
  • CLOUD_EFFICIENCY：高效云盘
  • CLOUD_SSD：SSD云盘
Id String CT-4A6799A79D73****

集群模版的ID。
InitCustomHiveMetaDb Boolean true

保留字段。
InstanceGeneration String ecs-3

ECS实例分代。
IoOptimized Boolean true

是否I/O优化：

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

是否开放公网IP：

  • true：开通
  • false：不开通
KeyPairName String test_kp

密钥对名称。
LogEnable Boolean true

是否开启OSS日志：

  • true：开启
  • false：不开启
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

元数据类型：

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

网络类型。
SecurityGroupId String sg-bp1id7ajv83kmqwq2isx

安全组ID。
SecurityGroupName String emr_sg

需要新创建的安全组的名字。
SoftwareInfoList List ["ZOOKEEPER"]

可选软件列表。
SshEnable Boolean true

是否开启SSH：

  • true：开启
  • false：不开启
Tags Array of Tag

标签列表。
Tag
TagKey String DevDept

标签键。
TagValue String DevDept

标签值。
TemplateName String template_name_2

集群模版名。
UseCustomHiveMetaDb Boolean false

保留字段。
UseLocalMetaDb Boolean true

是否使用Hive本地元数据：

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

用于ECS调用的E-MapReduce权限名。
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格式 

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

JSON格式 

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