全部产品
Search

搜索本产品

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

    文档中心

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

    更新时间：Jul 26, 2024

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

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    KeyWordstring否

    模糊搜索关键字。

    		host1
    HostNamestring否

    主机名称。

    		hostNam1
    InstanceIdsstring否

    实例 ID。

    		i-a3d1q1pm2f9yr29e****
    SerialNumbersstring否

    主机序列号。

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

    说明 该参数可用于精准查找监控的任何一台主机。
    		a1ab31a3-1234-40f2-9e95-c8caa8f0****
    PageNumberinteger否

    页数。

    		1
    PageSizeinteger否

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

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

    实例所在的地域。

    		cn-hangzhou
    AliyunHostboolean否

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

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

    主机状态。取值：

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

    SysOM 的开启状态。取值：

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

    返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求 ID。

    		63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0
    Successboolean

    操作是否成功。取值：

    • true：成功。

    • false：失败。

    		true
    Codestring

    状态码。

    说明 200 表示成功。
    		200
    Messagestring

    错误信息。

    		The Request is not authorization.
    PageNumberinteger

    分页页码。

    		1
    PageSizeinteger

    分页大小。

    		10
    PageTotalinteger

    页数。

    		50
    Totalinteger

    总记录条数。

    		10
    Hostsarray<object>

    主机列表。

    object

    主机。

    SerialNumberstring

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

    说明 该参数可用于精准查找监控的任何一台主机。
    		x12335-6cc8-4a22-9f21-1a00a719****
    NatIpstring

    NAT IP 地址。

    		192.168.XX.XX
    HostNamestring

    主机名称。

    		hostIP
    AliUidlong

    阿里云账号 ID。

    		103201326074****
    NetworkTypestring

    网络类型。

    		vpc
    InstanceIdstring

    实例 ID。

    		i-a2d5q7pm3f9yr212****
    isAliyunHostboolean

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

    • true：是。

    • false：否。

    		true
    EipAddressstring

    EIP 的 IP 地址。

    		192.168.XX.XX
    AgentVersionstring

    插件版本。

    		3.4.6
    IpGroupstring

    主机 IP 地址。

    说明 多个 IP 地址之前用半角逗号（,）分隔。
    		192.168.XX.XX
    EipIdstring

    EIP 的 ID。

    		eip-bp16i16k9gcezyfrp****
    Regionstring

    地域。

    		cn-hangzhou
    InstanceTypeFamilystring

    ECS 实例规格。

    		ecs.n4
    OperatingSystemstring

    操作系统。

    		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错误码错误信息描述
    400ParameterInvalidIllegal parameters.-
    403AccessForbiddenUser not authorized to operate on the specified resource.-
    404ResourceNotFoundThe specified resource is not found.未找到指定资源。
    500InternalErrorThe request processing has failed due to some unknown error.-

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

    变更历史

    变更时间变更内容概要操作
    2023-05-25OpenAPI 错误码发生变更查看变更详情
    2022-04-08OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情