You can call this operation to view the health information of the components of a specified service.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListClusterServiceComponentHealthInfo

The operation that you want to perform. Set the value to ListClusterServiceComponentHealthInfo.

ClusterId String Yes C-F32FB31D82954C64

The ID of the cluster.

RegionId String Yes ccn-hangzhou

The ID of the region to which the cluster belongs.

ServiceName String No TEZ

The name of the service.

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

The AccessKey ID provided to you by Alibaba Cloud. This parameter identifies the user.

Response parameters

Parameter Type Example Description
ClusterId String C-F32FB31D82954C64

The ID of the cluster.

HealthInfoList

The health information of the components of the specified service.

HealthInfo

The health information of the component.

AgentHeartBeatLostNum Integer 0

The number of hosts on which the agent heartbeat is lost.

ComponentName String ResourceManger

The name of the component.

HealthDetailList

The health details of the component.

HealthDetail

The health detail of the component.

HealthRuleParam

The rule used to monitor the health detail of the component.

Component String Ecm-Agent

The name of the component.

HostNames String emr-worker-1

The names of the hosts on which the component is installed.

Pass String ""

The result of the monitoring rule.

RuleDescription String Agent monitoring

The description of the rule.

RuleId String 111

The ID of the rule.

RuleTitle String AgentHeartBeatCheck

The title of the health monitoring rule.

Service String YARN

The name of the service.

code String 200

The code of the error.

HealthLevel String NORMAL

The health level of the component.

ManualStoppedNum Integer 0

The number of manually stopped components.

NormalNum Integer 7

The number of functioning components.

ServiceName String YARN

The name of the service.

StoppedNum Integer 0

The number of components that have stopped running.

TotalNum Integer 7

The total number of components in the specified service.

RequestId String DF202AC2-5D5D-4288-B608-B7B1595B5C7C

The ID of the request.

Examples

Sample requests


http(s)://[Endpoint]/? Action=ListClusterServiceComponentHealthInfo
&ClusterId=C-F32FB31D82954C64
&RegionId=ccn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<ListClusterServiceComponentHealthInfoResponse>
	  <RequestId>F695F08B-6C37-482A-AA4F-44A07B05CE84</RequestId>
	  <ClusterId>C-F7CBF0B43D98****</ClusterId>
	  <HealthInfoList>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>7</NormalNum>
			      <TotalNum>7</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>EMR-MONITOR</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>8</NormalNum>
			      <TotalNum>8</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>GANGLIA</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>4</NormalNum>
			      <TotalNum>4</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>EMRDOCTOR</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>1</NormalNum>
			      <TotalNum>1</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>MYSQL</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>3</NormalNum>
			      <TotalNum>3</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>SQOOP</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>1</NormalNum>
			      <TotalNum>1</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>APACHEDS</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>3</NormalNum>
			      <TotalNum>3</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>ILOGTAIL</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>2</StoppedNum>
			      <NormalNum>7</NormalNum>
			      <TotalNum>9</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>HDFS</ServiceName>
			      <ManualStoppedNum>2</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>4</NormalNum>
			      <TotalNum>4</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>TEZ</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>5</NormalNum>
			      <TotalNum>5</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>SPARK</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>1</NormalNum>
			      <TotalNum>1</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>HAPROXY</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>6</NormalNum>
			      <TotalNum>6</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>PRESTO</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>9</NormalNum>
			      <TotalNum>9</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>YARN</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>5</NormalNum>
			      <TotalNum>5</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>EMRFLOW</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>1</NormalNum>
			      <TotalNum>1</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>KNOX</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>3</NormalNum>
			      <TotalNum>3</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>PIG</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>5</NormalNum>
			      <TotalNum>5</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>HIVE</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
		    <HealthInfo>
			      <StoppedNum>0</StoppedNum>
			      <NormalNum>1</NormalNum>
			      <TotalNum>1</TotalNum>
			      <HealthDetailList></HealthDetailList>
			      <ServiceName>HUE</ServiceName>
			      <ManualStoppedNum>0</ManualStoppedNum>
			      <HealthLevel>NORMAL</HealthLevel>
			      <AgentHeartBeatLostNum>0</AgentHeartBeatLostNum>
		    </HealthInfo>
	  </HealthInfoList>
</ListClusterServiceComponentHealthInfoResponse>

JSON format

{
	"ClusterId":"C-F7CBF0B43D98****",
	"HealthInfoList":{
		"HealthInfo":[
			{
				"NormalNum":7,
				"ServiceName":"EMR-MONITOR",
				"TotalNum":7,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			},
			{
				"NormalNum":8,
				"ServiceName":"GANGLIA",
				"TotalNum":8,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			},
			{
				"NormalNum":4,
				"ServiceName":"EMRDOCTOR",
				"TotalNum":4,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			},
			{
				"NormalNum":1,
				"ServiceName":"MYSQL",
				"TotalNum":1,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			},
			{
				"NormalNum":3,
				"ServiceName":"SQOOP",
				"TotalNum":3,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			},
			{
				"NormalNum":1,
				"ServiceName":"APACHEDS",
				"TotalNum":1,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			},
			{
				"NormalNum":3,
				"ServiceName":"ILOGTAIL",
				"TotalNum":3,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			},
			{
				"NormalNum":7,
				"ServiceName":"HDFS",
				"TotalNum":9,
				"HealthLevel":"NORMAL",
				"StoppedNum":2,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":2
			},
			{
				"NormalNum":4,
				"ServiceName":"TEZ",
				"TotalNum":4,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			},
			{
				"NormalNum":5,
				"ServiceName":"SPARK",
				"TotalNum":5,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			},
			{
				"NormalNum":1,
				"ServiceName":"HAPROXY",
				"TotalNum":1,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			},
			{
				"NormalNum":6,
				"ServiceName":"PRESTO",
				"TotalNum":6,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			},
			{
				"NormalNum":9,
				"ServiceName":"YARN",
				"TotalNum":9,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			},
			{
				"NormalNum":5,
				"ServiceName":"EMRFLOW",
				"TotalNum":5,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			},
			{
				"NormalNum":1,
				"ServiceName":"KNOX",
				"TotalNum":1,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			},
			{
				"NormalNum":3,
				"ServiceName":"PIG",
				"TotalNum":3,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			},
			{
				"NormalNum":5,
				"ServiceName":"HIVE",
				"TotalNum":5,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			},
			{
				"NormalNum":1,
				"ServiceName":"HUE",
				"TotalNum":1,
				"HealthLevel":"NORMAL",
				"StoppedNum":0,
				"AgentHeartBeatLostNum":0,
				"HealthDetailList":{
					"HealthDetail":[]
				},
				"ManualStoppedNum":0
			}
		]
	},
	"RequestId":"F695F08B-6C37-482A-AA4F-44A07B05CE84"
}

Error codes

For a list of error codes, visit the API Error Center.