文档首页/ 云日志服务 LTS/ 更多文档/ API参考（吉隆坡区域）/ API/ 主机组管理/ 查询主机信息
更新时间：2025-03-21 GMT+08:00
查看PDF
分享

查询主机信息

功能介绍

查询主机列表

URI

POST /v3/{project_id}/lts/host-list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID

最小长度：1

最大长度：64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token，获取方式请参见：获取用户Token

最小长度：1

最大长度：10000

Content-Type

是

String

该字段填为：application/json;charset=utf8。

最小长度：30

最大长度：30
表3 请求Body参数

参数

是否必选

参数类型

描述

host_id_list

否

Array of strings

主机ID列表。可以根据主机ID列表进行批量过滤

最小长度：36

最大长度：36

filter

是

GetHostListFilter object

查询主机信息过滤参数
表4 GetHostListFilter

参数

是否必选

参数类型

描述

host_name_list

否

Array of strings

主机名称列表。可以根据主机名称列表，进行批量过滤

最小长度：1

最大长度：128

host_ip_list

否

Array of strings

主机IP列表。可以根据主机IP列表，进行批量过滤。

最小长度：1

最大长度：16

host_status

否

String

主机状态。可以根据主机状态进行过滤。

  • uninstall:未安装

  • running:运行

  • offline:离线

  • error:异常

  • plugin error:插件错误

  • installing:安装中

  • install-fail:安装失败

  • upgrading:升级中

  • upgrade failed:升级失败

  • uninstalling:卸载中

  • authentication error:鉴权失败

host_version

否

String

主机版本。可以根据主机版本进行过滤。

最小长度：1

最大长度：16

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

result

Array of GetHostListInfo objects

主机列表

total

Long

主机信息总数量
表6 GetHostListInfo

参数

参数类型

描述

host_id

String

主机ID

host_ip

String

主机IP

host_name

String

主机名称

host_status

String

主机状态。

  • uninstall:未安装

  • running:运行

  • offline:离线

  • error:异常

  • plugin error:插件错误

  • installing:安装中

  • install-fail:安装失败

  • upgrading:升级中

  • upgrade failed:升级失败

  • uninstalling:卸载中

  • authentication error:鉴权失败

host_type

String

主机类型。

  • Windows

  • Linux

host_version

String

主机版本

update_time

Long

更新时间

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询主机信息，根据传入的Body体进行过滤。若是body体中无过滤参数，则查询全量数据。

POST https://{endpoint}/v3/{project_id}/lts/host-list

{
  "host_id_list" : [ "713a9f81-574b-45aa-92df-24c4caxxxxxx", "c7085aa9-2142-4ada-9f78-bf81ffxxxxxx" ],
  "filter" : {
    "host_name_list" : [ "ecs-xxxx", "10.66.16xxx" ],
    "host_ip_list" : [ "192.168xxxx" ],
    "host_status" : "running",
    "host_version" : "5.13.xxxx"
  }
}

响应示例

状态码：200

查询主机信息请求响应成功

{
  "result" : [ {
    "host_id" : "dc1dab7e-b045-4e77-bda4-914xxxxxx",
    "host_ip" : "172.16.xxxx",
    "host_name" : "ecs-apmtexxxxxx",
    "host_status" : "running",
    "host_type" : "linux",
    "host_version" : "5.13.xx.x",
    "update_time" : 1637223314526
  } ],
  "total" : 1
}

状态码：400

BadRequest 非法请求 建议根据error_msg直接修改该请求。

{
  "error_code" : "LTS.1807",
  "error_msg" : "Invalid host id"
}

状态码：500

表明服务端能被请求访问到，但是服务内部出错

{
  "error_code" : "LTS.0010",
  "error_msg" : "Internal Server Error"
}

状态码

状态码

描述

200

查询主机信息请求响应成功

400

BadRequest 非法请求 建议根据error_msg直接修改该请求。

500

表明服务端能被请求访问到，但是服务内部出错

错误码

请参见错误码。

父主题： 主机组管理