You need to enable JavaScript to run this app.
导航

DescribeHosts

最近更新时间2023.11.13 16:31:28

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

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

使用说明

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

URI

请求方法
GET

URI

https://tls-{Region}.ivolces.com/DescribeHosts

传输协议

HTTPS

URI请求参数

参数
参数类型
是否必选
示例值
说明

HostGroupId

String

必选

66*********

机器组的 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

/

机器信息列表。详细信息请参考 HostInfo

示例

请求示例

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

响应示例

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

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

参数不合法。

InternalServerError

500

We encountered an unexpected server error, please try again later.

服务器内部错误。

更多信息,请参考通用错误码