调用DescribeMonitoringAgentHosts接口查询所有的已安装和未安装云监控插件的主机列表。

调试

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

请求参数

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

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

HostName String hostNam1

主机名称。

InstanceIds String i-a3d1q1pm2f9yr29e****

实例ID。

InstanceRegionId String cn-hangzhou

实例所在的地域。

KeyWord String host1

模糊搜索关键字。

PageNumber Integer 1

页数。

PageSize Integer 10

每页显示记录条数。取值:

  • 10
  • 20
  • 50
  • 100
说明 目前阿里云没有限制此参数的最大值,但不建议一次传入一个很大的值去获取所有实例列表,传入较大的值会容易超时导致无法正常获取。
SerialNumbers String a1ab31a3-1234-40f2-9e95-c8caa8f0****

序列号搜索。

每台机器成功安装云监控Agent之后会生成一个SerialNumbers,具备全局唯一性。非阿里云主机没有实例ID,但是会有SerialNumbers。

说明 此参数可用于精准查找监控的任何一台被监控的主机。

返回数据

名称 类型 示例值 描述
RequestId String 63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0

请求ID。

Success Boolean true

请求是否成功。

Total Integer 10

总记录条数。

PageTotal Integer 50

页数。

Code String 200

状态码。

说明 状态码为200表示成功。
Hosts Array

主机列表。

Host

主机列表。

AgentVersion String 2.1.55

插件版本。

AliUid Long 123456

阿里云账号ID。

EipAddress String 22.22.XX.XX

EIP地址。

EipId String xxx

EIP的ID。

HostName String hostIP

主机名称。

InstanceId String i-a2d5q7pm3f9yr212****

实例ID。

InstanceTypeFamily String ecs.n4

ECS实例规格。

IpGroup String 12.23.XX.XX

IP地址。

说明 多个IP地址用逗号分隔。
NatIp String 22.22.XX.XX

NAT IP。

NetworkType String vpc

网络类型。

OperatingSystem String Linux

操作系统。

Region String cn-hangzhou

地域。

SerialNumber String x12335-6cc8-4a22-9f21-1a00a719****

序列号搜索。

每台机器成功安装云监控Agent之后会生成一个SerialNumbers,具备全局唯一性。非阿里云主机没有实例ID,但是会有SerialNumbers。

说明 此参数可用于精准查找监控的任何一台被监控的主机。
isAliyunHost Boolean true

是否为阿里云主机。

Message String Successfully

错误信息。

示例

请求示例


http(s)://[Endpoint]/?Action=DescribeMonitoringAgentHosts
&<公共请求参数>

正常返回示例

XML 格式

<PageTotal>1</PageTotal>
<PageNumber>1</PageNumber>
<PageSize>100</PageSize>
<Hosts>
    <Host>
        <AgentVersion>2.1.55</AgentVersion>
        <SerialNumber>x12335-6cc8-4a22-9f21-1a00a719****</SerialNumber>
        <NetworkType>vpc</NetworkType>
        <Region>ap-south-1</Region>
        <InstanceTypeFamily>ecs.n4</InstanceTypeFamily>
        <isAliyunHost>true</isAliyunHost>
        <IpGroup>12.23.XX.XX</IpGroup>
        <AliUid>127067667954****</AliUid>
        <InstanceId>i-a2d5q7pm3f9yr212****</InstanceId>
        <OperatingSystem>Linux</OperatingSystem>
        <HostName>sitemonitor-mengmai-1</HostName>
    </Host>
</Hosts>
<Success>true</Success>
<Code>200</Code>
<Total>2</Total>

JSON 格式

{
	"PageTotal":1,
	"PageNumber":1,
	"PageSize":100,
	"Hosts":{
		"Host":[
			{
				"SerialNumber":"x12335-6cc8-4a22-9f21-1a00a719****",
				"AgentVersion":"2.1.55",
				"NetworkType":"vpc",
				"Region":"ap-south-1",
				"IpGroup":"12.23.XX.XX",
				"isAliyunHost":true,
				"InstanceTypeFamily":"ecs.n4",
				"AliUid":"127067667954****",
				"InstanceId":"i-a2d5q7pm3f9yr212****",
				"OperatingSystem":"Linux",
				"HostName":"sitemonitor-mengmai-1"
			}
		]
	},
	"Success":true,
	"Code":200,
	"Total":2
}

错误码

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