You need to enable JavaScript to run this app.
文档中心
日志服务

日志服务

请输入
  • 文档首页
    • 日志服务API 参考机器组管理DescribeHosts
复制全文
下载 pdf
我的收藏
机器组管理
DescribeHosts
复制全文
下载 pdf
我的收藏
DescribeHosts
调用 DescribeHosts 接口获取所有机器。​
使用说明​
本接口用于查看指定机器组中的服务器列表。支持分页查询、按机器IP模糊查询、按机器心跳状态查询。调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。​
请求说明​
  • 请求方式：GET​
  • 请求地址：https://{tls-endpoint}/DescribeHosts​
请求参数​
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Query​
​
参数​
类型​
是否必选​
示例值​
描述​
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​
/​
机器信息列表。​
​
HostInfo​
​
参数​
类型​
示例值​
描述​
Ip​
String​
127.0.0.1​
机器的 IP 地址。​
HeartbeatStatus​
Integer​
1​
Agent 的心跳状态。​
  • 0：心跳正常​
  • 1：心跳异常。​
LogCollectorVersion​
String​
1.0.11​
机器安装的 LogCollector 的版本。​
​
请求示例​
​
GET https://{tls-endpoint}/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.​
服务器内部错误。​
​
最近更新时间：2025.10.14 14:41:13
这个页面对您有帮助吗？
有用
有用
无用
无用