调用 DescribeHosts 接口获取所有机器。
本接口用于查看指定机器组中的服务器列表。支持分页查询、按机器IP模糊查询、按机器心跳状态查询。调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| HostGroupId | String | 是 | 6622a14b-770f-4171-a385-3b68486f**** | 机器组的 ID。 |
| Ip | String | 否 | 127.0.0.1 | 机器 IP，作为模糊查询使用。 |
| HeartbeatStatus | Integer | 否 | 1 | 机器心跳状态。 |
| PageNumber | Integer | 否 | 1 | 分页查询时的页码。默认为 1，即从第一页数据开始返回。 |
| PageSize | Integer | 否 | 20 | 分页大小。默认为 20，最大为 100。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Total | Integer | 2 | 机器数量。 |
| HostInfos | Array of HostInfo | / | 机器信息列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Ip | String | 127.0.0.1 | 机器的 IP 地址。 |
HeartbeatStatus | Integer |
| Agent 的心跳状态。
|
| LogCollectorVersion | String | 1.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 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 400 | InvalidArgument | Invalid argument key %s, value %s, please check argument. | 参数不合法。 |
| 500 | InternalServerError | We encountered an unexpected server error, please try again later. | 服务器内部错误。 |