DescribeMonitoringAgentHosts - 查询所有已安装和未安装云监控插件的主机列表 - 云监控

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cms:DescribeMonitoringAgentHosts

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
KeyWord	string	否	模糊搜索关键字。	host1
HostName	string	否	主机名称。	hostNam1
InstanceIds	string	否	实例 ID。	i-a3d1q1pm2f9yr29e****
SerialNumbers	string	否	主机序列号。每台主机成功安装云监控插件之后会生成一个 SerialNumber，具备全局唯一性。非阿里云主机无实例 ID，有 SerialNumber。说明该参数可用于精准查找监控的任何一台主机。	a1ab31a3-1234-40f2-9e95-c8caa8f0****
PageNumber	integer	否	页数。	1
PageSize	integer	否	每页显示记录条数。取值： 10 20 50 100 说明虽然目前阿里云未限制该参数的最大值，但是不建议设置的值过大，可能会导致超时无法正常获取。	10
InstanceRegionId	string	否	实例所在的地域。	cn-hangzhou
AliyunHost	boolean	否	阿里云主机（ECS）。取值： true（默认值）：过滤出所有阿里云主机（ECS）。 false：过滤出所有非阿里云主机。	true
Status	string	否	主机状态。取值： Running：运行中。 Stopped：已停止、未安装或安装失败。	Running
SysomStatus	string	否	SysOM 的开启状态。取值： installing：开启中。 running：运行中。 stopped：已停止。 uninstalling：关闭中。	running

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0
Success	boolean	操作是否成功。取值： true：成功。 false：失败。	true
Code	string	状态码。说明 200 表示成功。	200
Message	string	错误信息。	The Request is not authorization.
PageNumber	integer	分页页码。	1
PageSize	integer	分页大小。	10
PageTotal	integer	页数。	50
Total	integer	总记录条数。	10
Hosts	object
Host	array<object>	主机列表。
	object	主机。
SerialNumber	string	主机序列号。非阿里云主机无实例 ID，有 SerialNumber。说明该参数可用于精准查找监控的任何一台主机。	x12335-6cc8-4a22-9f21-1a00a719****
NatIp	string	NAT IP 地址。	192.168.XX.XX
HostName	string	主机名称。	hostIP
AliUid	integer	阿里云账号 ID。	103201326074****
NetworkType	string	网络类型。	vpc
InstanceId	string	实例 ID。	i-a2d5q7pm3f9yr212****
isAliyunHost	boolean	是否为阿里云主机。取值： true：是。 false：否。	true
EipAddress	string	EIP 的 IP 地址。	192.168.XX.XX
AgentVersion	string	插件版本。	3.4.6
IpGroup	string	主机 IP 地址。说明多个 IP 地址之前用半角逗号（,）分隔。	192.168.XX.XX
EipId	string	EIP 的 ID。	eip-bp16i16k9gcezyfrp****
Region	string	地域。	cn-hangzhou
InstanceTypeFamily	string	ECS 实例规格。	ecs.n4
OperatingSystem	string	操作系统。	Linux

示例

正常返回示例

JSON格式

{
  "RequestId": "63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0",
  "Success": true,
  "Code": "200",
  "Message": "The Request is not authorization.",
  "PageNumber": 1,
  "PageSize": 10,
  "PageTotal": 50,
  "Total": 10,
  "Hosts": {
    "Host": [
      {
        "SerialNumber": "x12335-6cc8-4a22-9f21-1a00a719****",
        "NatIp": "192.168.XX.XX",
        "HostName": "hostIP",
        "AliUid": 0,
        "NetworkType": "vpc",
        "InstanceId": "i-a2d5q7pm3f9yr212****",
        "isAliyunHost": true,
        "EipAddress": "192.168.XX.XX",
        "AgentVersion": "3.4.6",
        "IpGroup": "192.168.XX.XX",
        "EipId": "eip-bp16i16k9gcezyfrp****",
        "Region": "cn-hangzhou",
        "InstanceTypeFamily": "ecs.n4",
        "OperatingSystem": "Linux"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	未找到指定资源。

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

变更历史

更多信息，参考变更详情。