You can call this operation to query instances that have been created in a cluster.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. You can use OpenAPI Explorer to search for APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeClusterBasicInfo

The operation that you want to perform. Set this parameter to DescribeClusterBasicInfo.

ClusterId String Yes C-0EF9B0EC8564****

The ID of the cluster.

RegionId String Yes cn-huhehaote

The ID of the region where the cluster instance resides. You can call the DescribeRegions operation to query the ID of the region.

AccessKeyId String No LTA****u7gTm****

The AccessKey ID provided to you by Alibaba Cloud.

Response parameters

Parameter Type Example Description
ClusterInfo

The detailed information about the cluster.

AccessInfo

The access address of the cluster.

ZKLinks

The list of access addresses of ZooKeeper.

Link String 192.168.*. *

The access address of ZooKeeper.

Port String 2181

The port of ZooKeeper.

AutoScalingAllowed Boolean true

Indicates whether the cluster supports auto scaling.

AutoScalingByLoadAllowed Boolean true

Indicates whether the cluster supports load-based scaling.

AutoScalingEnable Boolean true

Indicates whether auto scaling is enabled for the cluster.

AutoScalingSpotWithLimitAllowed Boolean true

Indicates whether auto scaling allows the use of spot instances.

BootstrapActionList

The information about the bootstrap script of the cluster.

Arg String name=NAME

The parameter of the bootstrap script.

Name String boot1

The name of the bootstrap script.

Path String oss://script/boot1

The path of the bootstrap script in OSS.

BootstrapFailed Boolean false

The execution result of the bootstrap action. The value true indicates that the execution is successful, and false indicates that the execution fails.

ChargeType String PostPaid

The billing method of the cluster. The value PostPaid indicates pay-as-you-go, and PrePaid indicates subscription.

ClusterId String C-02582A4A415E****

The ID of the cluster.

Configurations String ""

The reserved field. Currently, there is no return value for this field, so you do not need to pay attention to this field.

CoreNodeInService Integer 0

The deprecated field. Currently, 0 is returned by default. This field will be removed from later versions.

CoreNodeTotal Integer 0

The deprecated field. Currently, 0 is returned by default. This field will be removed from later versions.

CreateResource String ECM_EMR

The deployment method of the cluster. Currently, the default value is ECM_EMR. For clusters created in E-MapReduce of some earlier versions, such as version 1.3.0, the default value is RAW_EMR.

CreateType String MANUAL

Indicates whether the cluster is created manually or automatically. The value MANUAL indicates that the cluster is created manually.

DepositType String HALF_MANAGED

The hosting type of the cluster. The type can be half-hosting or full-hosting. The value HALF_MANAGED indicates half-hosting.

EasEnable Boolean false

Indicates whether the cluster is of high security. The value false indicates that the cluster is not of high security.

ExpiredTime Long 1564367083000

The expiration time of a subscription cluster.

FailReason

The reason why the cluster failed to be created.

ErrorCode String ClusterId.NotFound

The error code displayed when cluster creation failed.

ErrorMsg String ClusterId [null] does not exist.

The error message displayed when cluster creation failed.

RequestId String FDFFCB97-1609-469A-B153-F511CA9FC1F5

The ID of the request in the background when cluster creation failed.

GatewayClusterIds String C-xxx

The deprecated field. This field will be removed from later versions.

GatewayClusterInfoList

The list of gateway clusters associated with the cluster.

ClusterId String C-1AD4D95AF8B6****

The ID of the gateway cluster.

ClusterName String test_gateway

The name of the gateway cluster.

Status String IDLE

The status of the gateway cluster.

HighAvailabilityEnable Boolean true

Indicates whether the cluster provides high availability.

HostPoolInfo

The information about the host pool that is used to create the cluster. This parameter is returned when the cluster is created by using the host pool.

HpBizId String HP-xxx

The ID of the host pool.

HpName String test_hp

The name of the host pool.

ImageId String m-xxx

The ID of the ECS image used by nodes in the cluster.

InstanceGeneration String ecs-2

The deprecated field. This field will be removed from later versions.

IoOptimized Boolean true

The deprecated field. This field will be removed from later versions.

LocalMetaDb Boolean true

Indicates whether the cluster uses the local Hive metadatabase. The value true indicates that the local metadatabase is used, and false indicates that the unified metadatabase is used.

LogEnable Boolean false

The deprecated field. This field will be removed from later versions.

LogPath String ""

The deprecated field. This field will be removed from later versions.

MachineType String ECS

The node type of the cluster. Currently, the default value is ECS.

MasterNodeInService Integer 0

The deprecated field. This field will be removed from later versions.

MasterNodeTotal Integer 0

The deprecated field. This field will be removed from later versions.

MetaStoreType String local

The unified metadata type of the cluster.

Name String test_cluster

The name of the cluster.

NetType String vpc

The network type of the cluster. Valid values: classic and vpc.

Period Integer 0

The deprecated field. This field will be removed from later versions.

RegionId String cn-huhehaote-a

The ID of the region where the cluster resides.

RelateClusterId String C-xxx

The deprecated field. This field will be removed from later versions.

RelateClusterInfo

The information about the primary cluster associated with the gateway cluster.

ClusterId String C-4A502AECB275****

The ID of the primary cluster.

ClusterName String test_hadoop

The name of the primary cluster.

Status String IDLE

The status of the primary cluster.

ResizeDiskEnable Boolean true

Indicates whether the cluster supports disk resizing.

RunningTime Integer 1583000

The running duration of the cluster, in milliseconds.

SecurityGroupId String sg-xxx

The ID of the security group of the cluster.

SecurityGroupName String test_groupName

The name of the security group of the cluster.

ShowSoftwareInterface Boolean false

The deprecated field. This field will be removed from later versions.

SoftwareInfo

The information about the software services deployed in the cluster.

ClusterType String HADOOP

The type of the cluster.

EmrVer String EMR-3.21.0

The version of E-MapReduce.

Softwares

The list of services.

DisplayName String HDFS

The displayed name of the service.

Name String HDFS

The name of the service.

OnlyDisplay Boolean false

The deprecated field. This field will be removed from later versions.

StartTpe Integer 1

The deprecated field. This field will be removed from later versions.

Version String 2.8.5

The version of the service.

StartTime Long 1564367083000

The time when the cluster started.

Status String IDLE

The status of the cluster.

StopTime Long 1564367083000

The time when the cluster stopped.

TaskNodeInService Integer 0

The deprecated field. This field will be removed from later versions.

TaskNodeTotal Integer 0

The deprecated field. This field will be removed from later versions.

UserDefinedEmrEcsRole String AliyunEmrEcsDefaultRole

The name of the service role of E-MapReduce.

UserId String 11131321311****

The ID of the user.

VSwitchId String vsw-xxx

The ID of the VSwitch.

VpcId String vpc-xxx

The ID of the VPC.

ZoneId String cn-huhehaote-a

The ID of the zone where the cluster resides.

RequestId String BB81FF02-2FE0-4DB0-A04B-A0876D21EDD7

The ID of the request.

Examples

Sample request


http(s)://[Endpoint]/? Action=DescribeClusterBasicInfo
&ClusterId=C-0EF9B0EC8564****
&RegionId=cn-huhehaote
&<Common request parameters>

Sample success response

XML format

<DescribeClusterBasicInfoResponse>	
	  <ClusterInfo>
		    <ImageId>m-hp37dmahkdx7h2b5qunn</ImageId>
		    <SecurityGroupId>sg-hp360xqw5l179aty****</SecurityGroupId>
		    <DepositType>HALF_MANAGED</DepositType>
		    <CoreNodeInService>0</CoreNodeInService>
		    <ZoneId>cn-huhehaote-a</ZoneId>
		    <AutoScalingSpotWithLimitAllowed>false</AutoScalingSpotWithLimitAllowed>
		    <IoOptimized>true</IoOptimized>
		    <TaskNodeInService>0</TaskNodeInService>
		    <MachineType>ECS</MachineType>
		    <AutoScalingAllowed>false</AutoScalingAllowed>
		    <ShowSoftwareInterface>false</ShowSoftwareInterface>
		    <ResizeDiskEnable>false</ResizeDiskEnable>
		    <SecurityGroupName>sg-hp360xqw5l179aty****</SecurityGroupName>
		    <BootstrapActionList></BootstrapActionList>
		    <CreateResource>ECM_EMR</CreateResource>
		    <RegionId>cn-huhehaote</RegionId>
		    <GatewayClusterInfoList></GatewayClusterInfoList>
		    <NetType>vpc</NetType>
		    <MasterNodeInService>0</MasterNodeInService>
		    <AutoScalingByLoadAllowed>true</AutoScalingByLoadAllowed>
		    <SoftwareInfo>
			      <Softwares>
				        <Software>
					          <Name>HDFS</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>2.8.5</Version>
					          <DisplayName>HDFS</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>YARN</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>2.8.5</Version>
					          <DisplayName>YARN</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>HIVE</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>3.1.1</Version>
					          <DisplayName>Hive</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>GANGLIA</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>3.7.2</Version>
					          <DisplayName>Ganglia</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>ZOOKEEPER</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>3.4.13</Version>
					          <DisplayName>Zookeeper</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>SPARK</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>2.4.3</Version>
					          <DisplayName>Spark</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>HBASE</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>1.4.9</Version>
					          <DisplayName>HBase</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>HUE</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>4.4.0</Version>
					          <DisplayName>HUE</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>ZEPPELIN</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>0.8.1</Version>
					          <DisplayName>Zeppelin</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>OOZIE</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>5.1.0</Version>
					          <DisplayName>Oozie</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>TEZ</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>0.9.1</Version>
					          <DisplayName>Tez</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>PHOENIX</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>4.14.1</Version>
					          <DisplayName>Phoenix</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>PRESTO</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>0.213</Version>
					          <DisplayName>Presto</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>SQOOP</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>1.4.7</Version>
					          <DisplayName>Sqoop</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>PIG</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>0.14.0</Version>
					          <DisplayName>Pig</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>STORM</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>1.2.2</Version>
					          <DisplayName>Storm</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>IMPALA</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>2.12.2</Version>
					          <DisplayName>Impala</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>FLINK</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>1.7.2</Version>
					          <DisplayName>Flink</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>RANGER</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>1.2.0</Version>
					          <DisplayName>Ranger</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>KNOX</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>1.1.0</Version>
					          <DisplayName>Knox</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>SUPERSET</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>0.28.1</Version>
					          <DisplayName>Superset</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>BIGBOOT</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>1.0.0</Version>
					          <DisplayName>Bigboot</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>LIVY</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>0.6.0</Version>
					          <DisplayName>LIVY</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>SMARTDATA</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>1.0.0</Version>
					          <DisplayName>SmartData</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>FLUME</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>1.8.0</Version>
					          <DisplayName>FLUME</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>ANALYTICS-ZOO</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>0.5.0</Version>
					          <DisplayName>analytics-zoo</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
				        <Software>
					          <Name>APACHEDS</Name>
					          <OnlyDisplay>false</OnlyDisplay>
					          <Version>2.0.0</Version>
					          <DisplayName>ApacheDS</DisplayName>
					          <StartTpe>1</StartTpe>
				        </Software>
			      </Softwares>
			      <EmrVer>EMR-3.21.1</EmrVer>
			      <ClusterType>HADOOP</ClusterType>
		    </SoftwareInfo>
		    <CreateType>MANUAL</CreateType>
		    <VSwitchId>vsw-hp333ghqgdxkk3djb****</VSwitchId>
		    <VpcId>vpc-hp3fawn3tu8ny436o****</VpcId>
		    <TaskNodeTotal>0</TaskNodeTotal>
		    <BootstrapFailed>false</BootstrapFailed>
		    <CoreNodeTotal>0</CoreNodeTotal>
		    <StartTime>1564132024000</StartTime>
		    <MasterNodeTotal>0</MasterNodeTotal>
		    <ChargeType>PostPaid</ChargeType>
		    <Configurations></Configurations>
		    <UserId>107992689699****</UserId>
		    <Name>EMR-API-test</Name>
		    <EasEnable>false</EasEnable>
		    <AutoScalingEnable>false</AutoScalingEnable>
		    <Status>IDLE</Status>
		    <LocalMetaDb>true</LocalMetaDb>
		    <HighAvailabilityEnable>false</HighAvailabilityEnable>
		    <ClusterId>C-02582A4A415E****</ClusterId>
		    <RunningTime>1004</RunningTime>
		    <UserDefinedEmrEcsRole>AliyunEmrEcsDefaultRole</UserDefinedEmrEcsRole>
	  </ClusterInfo>
	  <RequestId>BB81FF02-2FE0-4DB0-A04B-A0876D21EDD7</RequestId>
</DescribeClusterBasicInfoResponse>

JSON format

{
	"ClusterInfo":{
		"SecurityGroupId":"sg-hp360xqw5l179aty****",
		"ImageId":"m-hp37dmahkdx7h2b5qunn",
		"MasterNodeInService":0,
		"AutoScalingByLoadAllowed":true,
		"SoftwareInfo":{
			"Softwares":{
				"Software":[
					{
						"Name":"HDFS",
						"OnlyDisplay":false,
						"DisplayName":"HDFS",
						"Version":"2.8.5",
						"StartTpe":1
					},
					{
						"Name":"YARN",
						"OnlyDisplay":false,
						"DisplayName":"YARN",
						"Version":"2.8.5",
						"StartTpe":1
					},
					{
						"Name":"HIVE",
						"OnlyDisplay":false,
						"DisplayName":"Hive",
						"Version":"3.1.1",
						"StartTpe":1
					},
					{
						"Name":"GANGLIA",
						"OnlyDisplay":false,
						"DisplayName":"Ganglia",
						"Version":"3.7.2",
						"StartTpe":1
					},
					{
						"Name":"ZOOKEEPER",
						"OnlyDisplay":false,
						"DisplayName":"Zookeeper",
						"Version":"3.4.13",
						"StartTpe":1
					},
					{
						"Name":"SPARK",
						"OnlyDisplay":false,
						"DisplayName":"Spark",
						"Version":"2.4.3",
						"StartTpe":1
					},
					{
						"Name":"HBASE",
						"OnlyDisplay":false,
						"DisplayName":"HBase",
						"Version":"1.4.9",
						"StartTpe":1
					},
					{
						"Name":"HUE",
						"OnlyDisplay":false,
						"DisplayName":"HUE",
						"Version":"4.4.0",
						"StartTpe":1
					},
					{
						"Name":"ZEPPELIN",
						"OnlyDisplay":false,
						"DisplayName":"Zeppelin",
						"Version":"0.8.1",
						"StartTpe":1
					},
					{
						"Name":"OOZIE",
						"OnlyDisplay":false,
						"DisplayName":"Oozie",
						"Version":"5.1.0",
						"StartTpe":1
					},
					{
						"Name":"TEZ",
						"OnlyDisplay":false,
						"DisplayName":"Tez",
						"Version":"0.9.1",
						"StartTpe":1
					},
					{
						"Name":"PHOENIX",
						"OnlyDisplay":false,
						"DisplayName":"Phoenix",
						"Version":"4.14.1",
						"StartTpe":1
					},
					{
						"Name":"PRESTO",
						"OnlyDisplay":false,
						"DisplayName":"Presto",
						"Version":"0.213",
						"StartTpe":1
					},
					{
						"Name":"SQOOP",
						"OnlyDisplay":false,
						"DisplayName":"Sqoop",
						"Version":"1.4.7",
						"StartTpe":1
					},
					{
						"Name":"PIG",
						"OnlyDisplay":false,
						"DisplayName":"Pig",
						"Version":"0.14.0",
						"StartTpe":1
					},
					{
						"Name":"STORM",
						"OnlyDisplay":false,
						"DisplayName":"Storm",
						"Version":"1.2.2",
						"StartTpe":1
					},
					{
						"Name":"IMPALA",
						"OnlyDisplay":false,
						"DisplayName":"Impala",
						"Version":"2.12.2",
						"StartTpe":1
					},
					{
						"Name":"FLINK",
						"OnlyDisplay":false,
						"DisplayName":"Flink",
						"Version":"1.7.2",
						"StartTpe":1
					},
					{
						"Name":"RANGER",
						"OnlyDisplay":false,
						"DisplayName":"Ranger",
						"Version":"1.2.0",
						"StartTpe":1
					},
					{
						"Name":"KNOX",
						"OnlyDisplay":false,
						"DisplayName":"Knox",
						"Version":"1.1.0",
						"StartTpe":1
					},
					{
						"Name":"SUPERSET",
						"OnlyDisplay":false,
						"DisplayName":"Superset",
						"Version":"0.28.1",
						"StartTpe":1
					},
					{
						"Name":"BIGBOOT",
						"OnlyDisplay":false,
						"DisplayName":"Bigboot",
						"Version":"1.0.0",
						"StartTpe":1
					},
					{
						"Name":"LIVY",
						"OnlyDisplay":false,
						"DisplayName":"LIVY",
						"Version":"0.6.0",
						"StartTpe":1
					},
					{
						"Name":"SMARTDATA",
						"OnlyDisplay":false,
						"DisplayName":"SmartData",
						"Version":"1.0.0",
						"StartTpe":1
					},
					{
						"Name":"FLUME",
						"OnlyDisplay":false,
						"DisplayName":"FLUME",
						"Version":"1.8.0",
						"StartTpe":1
					},
					{
						"Name":"ANALYTICS-ZOO",
						"OnlyDisplay":false,
						"DisplayName":"analytics-zoo",
						"Version":"0.5.0",
						"StartTpe":1
					},
					{
						"Name":"APACHEDS",
						"OnlyDisplay":false,
						"DisplayName":"ApacheDS",
						"Version":"2.0.0",
						"StartTpe":1
					}
				]
			},
			"EmrVer":"EMR-3.21.1",
			"ClusterType":"HADOOP"
		},
		"DepositType":"HALF_MANAGED",
		"CoreNodeInService":0,
		"ZoneId":"cn-huhehaote-a",
		"CreateType":"MANUAL",
		"VSwitchId":"vsw-hp333ghqgdxkk3djb****",
		"AutoScalingSpotWithLimitAllowed":false,
		"VpcId":"vpc-hp3fawn3tu8ny436o****",
		"IoOptimized":true,
		"TaskNodeTotal":0,
		"TaskNodeInService":0,
		"BootstrapFailed":false,
		"CoreNodeTotal":0,
		"StartTime":1564132024000,
		"MasterNodeTotal":0,
		"ChargeType":"PostPaid",
		"MachineType":"ECS",
		"Configurations":"",
		"AutoScalingAllowed":false,
		"UserId":"107992689699****",
		"ShowSoftwareInterface":false,
		"AutoScalingEnable":false,
		"EasEnable":false,
		"Name":"EMR-API-test",
		"Status":"IDLE",
		"ResizeDiskEnable":false,
		"HighAvailabilityEnable":false,
		"LocalMetaDb":true,
		"SecurityGroupName":"sg-hp360xqw5l179aty****",
		"BootstrapActionList":{
			"BootstrapAction":[]
		},
		"ClusterId":"C-02582A4A415E****",
		"CreateResource":"ECM_EMR",
		"RegionId":"cn-huhehaote",
		"RunningTime":1004,
		"GatewayClusterInfoList":{
			"GatewayClusterInfo":[]
		},
		"NetType":"vpc",
		"UserDefinedEmrEcsRole":"AliyunEmrEcsDefaultRole"
	},
	"RequestId":"BB81FF02-2FE0-4DB0-A04B-A0876D21EDD7"
}

Error codes

Http status code Error code Error message Description
403 Params.Illegal The specified parameters are wrongly formed. The error message returned because the format of the specified parameter is invalid.
404 ClusterId.NotFound ClusterId [%s] does not exist. The error message returned because the specified ClusterId parameter does not exist. Check the ID of the cluster.
403 User.OtherUserResource.NotAllow It is not allowed to operate other user's resource The error message returned because operations cannot be performed on resources of other users.
500 InternalError The request processing has failed due to some unknown error. The error message returned because an internal error has occurred. Open a ticket.

For more information about error codes, see API Error Center.