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

调试

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

请求参数

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

要执行的操作，取值：DescribeMonitoringAgentHosts。

KeyWord String 否 host1

模糊搜索关键字。
HostName String 否 hostNam1

主机名称。
InstanceIds String 否 i-a3d1q1pm2f9yr29e****

实例ID。
SerialNumbers String 否 a1ab31a3-1234-40f2-9e95-c8caa8f0****

主机序列号。

每台主机成功安装云监控插件之后会生成一个SerialNumber，具备全局唯一性。非阿里云主机无实例ID，有SerialNumber。

说明 该参数可用于精准查找监控的任何一台主机。
PageNumber Integer 否 1

页数。
PageSize Integer 否 10

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

  • 10
  • 20
  • 50
  • 100
说明 虽然目前阿里云未限制该参数的最大值，但是不建议设置的值过大，可能会导致超时无法正常获取。
InstanceRegionId String 否 cn-hangzhou

实例所在的地域。
AliyunHost Boolean 否 true

阿里云主机（ECS）。取值：

  • true（默认值）：过滤出所有阿里云主机（ECS）。
  • false：过滤出所有非阿里云主机。
Status String 否 Running

主机状态。取值：

  • Running：运行中。
  • Stopped：已停止、未安装或安装失败。
SysomStatus String 否 running

SysOM的开启状态。取值：

  • installing：开启中。
  • running：运行中。
  • stopped：已停止。
  • uninstalling：关闭中。

返回数据

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

请求ID。
Success Boolean true

操作是否成功。取值：

  • true：成功。
  • false：失败。
Code String 200

状态码。

说明 200表示成功。
Message String The Request is not authorization.

错误信息。
PageNumber Integer 1

分页页码。
PageSize Integer 10

分页大小。
PageTotal Integer 50

页数。
Total Integer 10

总记录条数。
Hosts Array of Host

主机列表。
Host
SerialNumber String x12335-6cc8-4a22-9f21-1a00a719****

主机序列号。非阿里云主机无实例ID，有SerialNumber。

说明 该参数可用于精准查找监控的任何一台主机。
NatIp String 192.168.XX.XX

NAT IP地址。
HostName String hostIP

主机名称。
AliUid Long 103201326074****

阿里云账号ID。
NetworkType String vpc

网络类型。
InstanceId String i-a2d5q7pm3f9yr212****

实例ID。
isAliyunHost Boolean true

是否为阿里云主机。取值：

  • true：是。
  • false：否。
EipAddress String 192.168.XX.XX

EIP的IP地址。
AgentVersion String 3.4.6

插件版本。
IpGroup String 192.168.XX.XX

主机IP地址。

说明 多个IP地址之前用半角逗号（,）分隔。
EipId String eip-bp16i16k9gcezyfrp****

EIP的ID。
Region String cn-hangzhou

地域。
InstanceTypeFamily String ecs.n4

ECS实例规格。
OperatingSystem String Linux

操作系统。

示例

请求示例

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

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeMonitoringAgentHostsResponse>
		<Hosts>
			<Host>
				<OperatingSystem>Windows</OperatingSystem>
				<SerialNumber>f0a434f2-632b-4588-95e6-202d4396****</SerialNumber>
				<isAliyunHost>true</isAliyunHost>
				<InstanceId>i-uf6hm9lnlzsarrc7****</InstanceId>
				<AgentVersion>3.4.6</AgentVersion>
				<NetworkType>vpc</NetworkType>
				<InstanceTypeFamily>ecs.g6</InstanceTypeFamily>
				<Region>cn-shanghai</Region>
				<IpGroup>192.168.XX.XX,192.168.XX.XX</IpGroup>
				<HostName>iZlzsarrc78****</HostName>
				<AliUid>103201326074****</AliUid>
			</Host>
			<Host>
				<OperatingSystem>Linux</OperatingSystem>
				<SerialNumber>9c336dc5-1802-4db0-b7a0-2d46ad4f****</SerialNumber>
				<isAliyunHost>true</isAliyunHost>
				<InstanceId>i-uf6hn19s56zumk9w****</InstanceId>
				<AgentVersion>3.4.4</AgentVersion>
				<NetworkType>vpc</NetworkType>
				<InstanceTypeFamily>ecs.g5</InstanceTypeFamily>
				<Region>cn-shanghai</Region>
				<IpGroup>192.168.XX.XX,192.168.XX.XX</IpGroup>
				<HostName>launch-advisor-2019****</HostName>
				<AliUid>103201326074****</AliUid>
			</Host>
		</Hosts>
		<PageSize>100</PageSize>
		<PageNumber>1</PageNumber>
		<PageTotal>1</PageTotal>
		<Total>5</Total>
		<Code>200</Code>
		<Success>true</Success>
</DescribeMonitoringAgentHostsResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Hosts" : {
    "Host" : [ {
      "OperatingSystem" : "Windows",
      "SerialNumber" : "f0a434f2-632b-4588-95e6-202d4396****",
      "isAliyunHost" : true,
      "InstanceId" : "i-uf6hm9lnlzsarrc7****",
      "AgentVersion" : "3.4.6",
      "NetworkType" : "vpc",
      "InstanceTypeFamily" : "ecs.g6",
      "Region" : "cn-shanghai",
      "IpGroup" : "192.168.XX.XX,192.168.XX.XX",
      "HostName" : "iZlzsarrc78****",
      "AliUid" : "103201326074****"
    }, {
      "OperatingSystem" : "Linux",
      "SerialNumber" : "9c336dc5-1802-4db0-b7a0-2d46ad4f****",
      "isAliyunHost" : true,
      "InstanceId" : "i-uf6hn19s56zumk9w****",
      "AgentVersion" : "3.4.4",
      "NetworkType" : "vpc",
      "InstanceTypeFamily" : "ecs.g5",
      "Region" : "cn-shanghai",
      "IpGroup" : "192.168.XX.XX,192.168.XX.XX",
      "HostName" : "launch-advisor-2019****",
      "AliUid" : "103201326074****"
    } ]
  },
  "PageSize" : 100,
  "PageNumber" : 1,
  "PageTotal" : 1,
  "Total" : 5,
  "Code" : 200,
  "Success" : true
}

错误码

HttpCode 错误码 错误信息 描述
404 ResourceNotFound The specified resource is not found. 未找到指定资源。

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