You can call DescribeClusterTemplate operation to query the details of cluster templates.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeClusterTemplate |
The operation that you want to perform. Set the value to DescribeClusterTemplate. |
BizId | String | Yes | CT-35498C56B3F1**** |
The ID of the cluster template. You can call ListClusterTemplates View data on the Member Management page. |
ResourceGroupId | String | No | rg-acfmv6jutt6**** |
The ID of the resource group. You can call ListResourceGroups View the resource group ID. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 29A1D3B7-661C-4FCD-8577-DE93C8F6CA55 |
The ID of the request. |
TemplateInfo | Struct |
The information of the cluster template. |
|
AllowNotebook | Boolean | false |
Indicates whether the Notebook app is allowed. |
BootstrapActionList | Array of BootstrapAction |
The list of bootstrap actions. |
|
BootstrapAction | |||
Arg | String | --a |
parameter. |
Name | String | action_name |
The operation name. |
Path | String | oss://bucket/path |
The path of the script. |
ClusterType | String | HADOOP |
Cluster Type:
|
ConfigList | Array of Config |
The list of custom configuration items. |
|
Config | |||
ConfigKey | String | fs.trash.interval |
The key of custom configuration item N. |
ConfigValue | String | 60 |
The value of custom configuration item N. |
Encrypt | String | 0 |
A reserved parameter. You do not need to specify this parameter. |
FileName | String | yarn-site |
The name of the file that contains custom configuration item N. |
Replace | String | 0 |
A reserved parameter. You do not need to specify this parameter. |
ServiceName | String | YARN |
The name of the service for which the custom configuration item is configured. Specify the entire name in uppercase. |
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"}}] |
The custom configuration items for software. You can use a JSON file to modify the software configurations before you start a cluster. |
CreateSource | String | 2 |
A reserved parameter. |
DepositType | String | HALF_MANAGED |
The hosting type of the cluster. Valid values:
|
EasEnable | Boolean | true |
Indicates whether the cluster is high-security:
|
EmrVer | String | EMR-3.16.0 |
The version of the E-MapReduce. |
GmtCreate | Long | 1543765033000 |
The time when the cluster template was created. |
GmtModified | Long | 1543765033000 |
The time when the cluster template was modified. |
HighAvailabilityEnable | Boolean | true |
Indicates whether the cluster is a high-availability cluster. Valid values:
|
HostGroupList | Array of HostGroup |
The list of host groups. |
|
HostGroup | |||
ChargeType | String | PostPaid |
The billing method of the instance. Default value: Postpaid. Valid values:
|
DiskCapacity | Integer | 80 |
The data disk capacity of host group N. |
DiskCount | Integer | 4 |
The number of data disks in the host group. |
DiskType | String | CLOUD_SSD |
System disk type:
|
HostGroupId | String | 0 |
A reserved parameter. You do not need to specify this parameter. |
HostGroupName | String | Master instance group |
The name of host group N. |
HostGroupType | String | MASTER |
The type of the machine group to be queried:
|
InstanceType | String | ecs.mn4.2xlarge |
The type of instances in host group N. |
MultiInstanceTypes | String | ecs.sn1.xlarge,ecs.sn2.xlarge |
The types of instances in the host group. Separate each type with a comma (,). |
NodeCount | Integer | 2 |
The number of nodes in host group N. |
Period | String | 36 |
The validity period of the subscription. Unit: days. |
SysDiskCapacity | Integer | 40 |
The system disk capacity of host group N. |
SysDiskType | String | CLOUD_SSD |
Machine Group system disk type:
|
Id | String | CT-4A6799A79D73**** |
The ID of the cluster template. |
InitCustomHiveMetaDb | Boolean | true |
A reserved parameter that you do not need to specify. |
InstanceGeneration | String | ecs-3 |
The generation of ECS instances. |
IoOptimized | Boolean | true |
Whether I/O optimization:
|
IsOpenPublicIp | Boolean | true |
Whether to open public network IP:
|
KeyPairName | String | test_kp |
The name of the key pair. |
LogEnable | Boolean | true |
Indicates whether to enable OSS logging. Valid values:
|
LogPath | String | oss//bucketname/path |
The path of logs that are stored in OSS buckets. |
MachineType | String | ECS |
The instance type. |
MasterNodeTotal | Integer | 1 |
The number of master nodes. |
MasterPwd | String | testpd |
The password that is used to log on to the master node. |
MetaStoreConf | String | rds-xxx.com |
The configuration information of Hive Metastore. |
MetaStoreType | String | LOCAL |
Metadata type:
|
NetType | String | vpc |
The type of the network. |
SecurityGroupId | String | sg-bp1id7ajv83kmqwq2isx |
The ID of the security group. |
SecurityGroupName | String | emr_sg |
The name of the security group to be created. |
SoftwareInfoList | List | ["ZOOKEEPER"] |
The information of an optional service. |
SshEnable | Boolean | true |
Whether to enable SSH:
|
Tags | Array of Tag |
The information of a tag. |
|
Tag | |||
TagKey | String | DevDept |
The key of each tag. |
TagValue | String | DevDept |
The tag value. |
TemplateName | String | template_name_2 |
The name of the cluster template. |
UseCustomHiveMetaDb | Boolean | false |
A reserved parameter. |
UseLocalMetaDb | Boolean | true |
Indicates whether to use local Hive metadata. Valid values:
|
UserDefinedEmrEcsRole | String | AliyunEmrEcsDefaultRole |
The E-MapReduce permission name used for ECS calls. |
UserId | String | 125046002175**** |
The ID of the user. |
VSwitchId | String | vsw-bp10tvjyc77psy0z5**** |
The ID of the vSwitch. |
VpcId | String | vpc-bp1l4urd87xlh7i4b**** |
The ID of the VPC to which the instance belongs. |
ZoneId | String | cn-hangzhou-b |
The zone ID. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeClusterTemplate
&BizId=CT-35498C56B3F1****
&<common request parameters>
Sample success responses
XML
format
<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>Master instance group</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>Core instance group</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
Syntax
{
"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": "Master instance group",
"hostGroupType": "MASTER",
"instanceType": "ecs.n4.xlarge",
"nodeCount": 1
},
{
"chargeType": "PostPaid",
"diskCapacity": 80,
"diskCount": 4,
"diskType": "CLOUD_EFFICIENCY",
"hostGroupId": "",
"hostGroupName": "Core instance group",
"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"
}
}