调用 ListClusterHostComponent 接口获取集群各个主机上安装的组件列表。

调试

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

请求参数

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

系统规定参数。取值:ListClusterHostComponent。

ClusterId String C-F32FB31D82954C64

集群ID。

RegionId String cn-hangzhou

地域ID。

ServiceName String TEZ

服务名。

ComponentName String TezInit

待查询的组件名称。

ComponentStatus String STARTED

待查询的组件状态。

HostInstanceId String i-xxx

主机实例ID,一般是 ecsId

HostName String emr-worker-1

主机名。

HostRole String CORE

主机角色。

PageNumber Integer 1

分页查询的查询页码。

PageSize Integer 100

分页查询的每页记录数。

AccessKeyId String LTAI8ljWyu7y****

阿里云AccessKey ID信息,用于标识访问者身份。

返回数据

名称 类型 示例值 描述
ComponentList

组件列表。

Component

组件列表。

ComponentDisplayName String Tez Client

组件的显示名称。

ComponentName String TezInit

组件名。

Cpu Integer 4

主机的CPU核心数。

HostId String 111

主机ID。

HostInstanceId String i-xxx

主机实例ID,一般是ecsID

HostName String emr-worker-1

主机名。

InstanceType String ecs.sn1.xlarge

主机的规格类型。

Memory Integer 8

主机内存大小。

NeedRestart Boolean true

组件是否需要重启。

PrivateIp String 192.168.1.1

主机内网IP。

PublicIp String 48.20.119.10

主机的公网IP。

Role String CORE

主机角色。

SerialNumber String x11-05e5-4d36-b773-8ae4106babd4

主机的 SerialNumber 信息。

ServerStatus String active

组件服务状态,比如高可用集群某些组件的active和standby状态。

ServiceDisplayName String Tez

服务的显示名称。

ServiceName String TEZ

服务名称。

Status String STARTED

组件状态。

PageNumber Integer 100

当前的页号。

PageSize Integer 1

每页的记录数。

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

请求ID。

Total Integer 4

记录总数。

示例

请求示例


http(s)://[Endpoint]/?Action=ListClusterHostComponent
&ClusterId=C-F32FB31D82954C64
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<ListClusterHostComponentResponse>
	  <PageSize>10</PageSize>
	  <RequestId>DF202AC2-5D5D-4288-B608-B7B1595B5C7C</RequestId>
	  <PageNumber>1</PageNumber>
	  <Total>4</Total>
	  <ComponentList>
		    <Component>
			      <Status>STARTED</Status>
			      <ComponentDisplayName>Tez Client</ComponentDisplayName>
			      <PublicIp>47.97.106.27</PublicIp>
			      <HostInstanceId>i-xxx1</HostInstanceId>
			      <HostId>124903</HostId>
			      <ServiceDisplayName>Tez</ServiceDisplayName>
			      <Role>MASTER</Role>
			      <SerialNumber>x11-05e5-4d36-b773-8ae4106babd4</SerialNumber>
			      <PrivateIp>192.168.143.231</PrivateIp>
			      <ServiceName>TEZ</ServiceName>
			      <NeedRestart>false</NeedRestart>
			      <ComponentName>TezInit</ComponentName>
			      <InstanceType>ecs.n4.xlarge</InstanceType>
			      <HostName>emr-header-1</HostName>
		    </Component>
		    <Component>
			      <Status>STARTED</Status>
			      <ComponentDisplayName>Tomcat</ComponentDisplayName>
			      <PublicIp>47.97.106.27</PublicIp>
			      <HostInstanceId>i-xxx2</HostInstanceId>
			      <HostId>124903</HostId>
			      <ServiceDisplayName>Tez</ServiceDisplayName>
			      <Role>MASTER</Role>
			      <SerialNumber>1xx1-05e5-x-b773-xxx</SerialNumber>
			      <PrivateIp>192.168.143.231</PrivateIp>
			      <ServiceName>TEZ</ServiceName>
			      <NeedRestart>false</NeedRestart>
			      <ComponentName>Tomcat</ComponentName>
			      <InstanceType>ecs.n4.xlarge</InstanceType>
			      <HostName>emr-header-1</HostName>
		    </Component>
		    <Component>
			      <Status>STARTED</Status>
			      <ComponentDisplayName>Tez Client</ComponentDisplayName>
			      <PublicIp></PublicIp>
			      <HostInstanceId>i-xxx3</HostInstanceId>
			      <HostId>124902</HostId>
			      <ServiceDisplayName>Tez</ServiceDisplayName>
			      <Role>CORE</Role>
			      <SerialNumber>asd1x1-af39-1c-32b27d83d4c3</SerialNumber>
			      <PrivateIp>192.168.143.232</PrivateIp>
			      <ServiceName>TEZ</ServiceName>
			      <NeedRestart>false</NeedRestart>
			      <ComponentName>TezInit</ComponentName>
			      <InstanceType>ecs.n4.xlarge</InstanceType>
			      <HostName>emr-worker-1</HostName>
		    </Component>
		    <Component>
			      <Status>STARTED</Status>
			      <ComponentDisplayName>Tez Client</ComponentDisplayName>
			      <PublicIp></PublicIp>
			      <HostInstanceId>i-xxx4</HostInstanceId>
			      <HostId>124901</HostId>
			      <ServiceDisplayName>Tez</ServiceDisplayName>
			      <Role>CORE</Role>
			      <SerialNumber>1cc-2762-4d84-a430-xxx</SerialNumber>
			      <PrivateIp>192.168.143.233</PrivateIp>
			      <ServiceName>TEZ</ServiceName>
			      <NeedRestart>false</NeedRestart>
			      <ComponentName>TezInit</ComponentName>
			      <InstanceType>ecs.n4.xlarge</InstanceType>
			      <HostName>emr-worker-2</HostName>
		    </Component>
	  </ComponentList>
</ListClusterHostComponentResponse>

JSON 格式

{
	"PageNumber":1,
	"PageSize":10,
	"RequestId":"DF202AC2-5D5D-4288-B608-B7B1595B5C7C",
	"Total":4,
	"ComponentList":{
		"Component":[
			{
				"NeedRestart":false,
				"HostInstanceId":"i-xxx1",
				"ComponentDisplayName":"Tez Client",
				"HostId":"124903",
				"ServiceDisplayName":"Tez",
				"PrivateIp":"192.168.143.231",
				"HostName":"emr-header-1",
				"InstanceType":"ecs.n4.xlarge",
				"SerialNumber":"x11-05e5-4d36-b773-8ae4106babd4",
				"Status":"STARTED",
				"ServiceName":"TEZ",
				"PublicIp":"47.97.106.27",
				"Role":"MASTER",
				"ComponentName":"TezInit"
			},
			{
				"NeedRestart":false,
				"HostInstanceId":"i-xxx2",
				"ComponentDisplayName":"Tomcat",
				"HostId":"124903",
				"ServiceDisplayName":"Tez",
				"PrivateIp":"192.168.143.231",
				"HostName":"emr-header-1",
				"InstanceType":"ecs.n4.xlarge",
				"SerialNumber":"1xx1-05e5-x-b773-xxx",
				"Status":"STARTED",
				"ServiceName":"TEZ",
				"PublicIp":"47.97.106.27",
				"Role":"MASTER",
				"ComponentName":"Tomcat"
			},
			{
				"NeedRestart":false,
				"HostInstanceId":"i-xxx3",
				"ComponentDisplayName":"Tez Client",
				"HostId":"124902",
				"ServiceDisplayName":"Tez",
				"PrivateIp":"192.168.143.232",
				"HostName":"emr-worker-1",
				"InstanceType":"ecs.n4.xlarge",
				"SerialNumber":"asd1x1-af39-1c-32b27d83d4c3",
				"Status":"STARTED",
				"ServiceName":"TEZ",
				"PublicIp":"",
				"Role":"CORE",
				"ComponentName":"TezInit"
			},
			{
				"NeedRestart":false,
				"HostInstanceId":"i-xxx4",
				"ComponentDisplayName":"Tez Client",
				"HostId":"124901",
				"ServiceDisplayName":"Tez",
				"PrivateIp":"192.168.143.233",
				"HostName":"emr-worker-2",
				"InstanceType":"ecs.n4.xlarge",
				"SerialNumber":"1cc-2762-4d84-a430-xxx",
				"Status":"STARTED",
				"ServiceName":"TEZ",
				"PublicIp":"",
				"Role":"CORE",
				"ComponentName":"TezInit"
			}
		]
	}
}

错误码

HttpCode 错误码 错误信息 描述
403 Params.Illegal The specified parameters are wrongly formed.. 指定参数格式错误
403 User.OtherUserResource.NotAllow It is not allowed to operate other user's resource 不能操作其它用户的资源
403 Invalid.Cluster.Status Invalid cluster status %s in status list 指定集群状态不合法
403 Invalid.Cluster.Type Invalid cluster type %s in cluster type list 指定集群类型不合法
500 InternalError The request processing has failed due to some unknown error. 内部错误,请提工单

访问错误中心查看更多错误码。