You can call ListClusterServiceComponentHealthInfo operation to query the health information of the components of a specified service in a cluster.

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

The cluster ID. You can call ListClusters View the ID of the cluster.

RegionId String Yes cn-hangzhou

The region ID. You can call DescribeRegions View the latest list of Alibaba Cloud regions.

ServiceName String No TEZ

The name of the service.

Response parameters

Parameter Type Example Description
ClusterId String C-F32FB31D8295****

The ID of the cluster.

HealthInfoList Array of HealthInfo

The health information of the components of the specified service.

HealthInfo
AgentHeartBeatLostNum Integer 0

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

ComponentName String ResourceManager

The name of the component that you want to upgrade.

CreatedTime Long 0

A reserved parameter. You do not need to specify this parameter.

HealthDetailList Array of HealthDetail

The health details of the component.

HealthDetail
HealthRuleParam Struct

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

Component String Ecm-Agent

The names of add-ons.

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 IDs of the rules.

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

Health level, the value is as follows:

  • ABNORMAL: abnormal
  • NORMAL: The virtual MFA device is normal.
  • RESIZING: in configuration
  • INITIALIZING: Initializing
  • RELEASED: Released
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.

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

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListClusterServiceComponentHealthInfo
&ClusterId=C-F32FB31D8295****
&RegionId=cn-hangzhou
&<common request parameters>

Sample success responses

XML format

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

JSON Syntax

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