You need to enable JavaScript to run this app.
导航
日志服务
  • 文档首页
    • /
  • 日志服务

DescribeHosts

最近更新时间：2024.04.19 13:54:13

首次发布时间：2022.05.11 11:26:48

我的收藏

调用 DescribeHosts 接口获取所有机器。

使用说明

本接口用于查看指定机器组中的服务器列表。支持分页查询、按机器IP模糊查询、按机器心跳状态查询。调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

请求说明

  • 请求方式：GET
  • 请求地址：https://tls-{Region}.ivolces.com/DescribeHosts

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数类型是否必选示例值描述
HostGroupIdString是6622a14b-770f-4171-a385-3b68486f****机器组的 ID。
IpString否127.0.0.1机器 IP，作为模糊查询使用。
HeartbeatStatusInteger否1机器心跳状态。
PageNumberInteger否1分页查询时的页码。默认为 1，即从第一页数据开始返回。
PageSizeInteger否20分页大小。默认为 20，最大为 100。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数类型示例值描述
TotalInteger2机器数量。
HostInfosArray of HostInfo/机器信息列表。

HostInfo

参数类型示例值描述
IpString127.0.0.1机器的 IP 地址。

HeartbeatStatus

Integer

1

Agent 的心跳状态。

  • 0：心跳正常
  • 1：心跳异常。
LogCollectorVersionString1.0.11机器安装的 LogCollector 的版本。

请求示例

GET https://tls-{Region}.ivolces.com/DescribeHosts?HostGroupId=6622a14b-770f-4171-a385-3b68486f*****PageSize=20 HTTP/1.1

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "Total": 1,
    "HostInfos": [
        {
            "Ip": "127.0.0.1",
            "LogCollectorVersion": "logcollector-1.0.3",
            "HeartbeatStatus": 0
        }
    ]
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码错误码错误信息说明
400InvalidArgumentInvalid argument key %s, value %s, please check argument.参数不合法。
500InternalServerErrorWe encountered an unexpected server error, please try again later.服务器内部错误。