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

查询主机组

功能介绍

查询主机组列表

URI

POST /v3/{project_id}/lts/host-group-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=UTF-8。

最小长度：30

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

参数

是否必选

参数类型

描述

host_group_id_list

否

Array of strings

主机组ID

最小长度：36

最大长度：36

filter

是

GetHostGroupListFilter object

主机组过滤参数
表4 GetHostGroupListFilter

参数

是否必选

参数类型

描述

host_group_type

否

String

主机组类型。

  • Windows

  • Linux

host_group_name_list

否

Array of strings

主机组名称列表。

最小长度：1

最大长度：64

host_name_list

否

Array of strings

主机名称列表。

最小长度：1

最大长度：128

host_group_tag

否

GetHostGroupListTag object

主机组标签信息
表5 GetHostGroupListTag

参数

是否必选

参数类型

描述

tag_type

否

String

标签类型。AND：标签过滤的逻辑为与，OR：标签过滤的逻辑为或

tag_list

否

Array of HostGroupTag objects

主机组标签
表6 HostGroupTag

参数

是否必选

参数类型

描述

key

是

String

标签Key：标签键只支持输入UTF-8格式表示的字母(包含中文)、数字和空格，以及以下_ . : = + - @字符且不能以下划线开头。长度不能超过128个字符；

value

否

String

标签Value：标签值只支持输入UTF-8格式表示的字母(包含中文)、数字和空格，以及以下_ . : / = + - @字符。长度不能超过255个字符。

响应参数

状态码：200

表7 响应Body参数

参数

参数类型

描述

result

Array of GetHostGroupInfo objects

主机组列表

total

Long

主机组信息总数量
表8 GetHostGroupInfo

参数

参数类型

描述

host_group_id

String

主机组ID

host_group_name

String

主机组名称

host_group_type

String

主机组类型。

host_id_list

Array of strings

主机ID列表

host_group_tag

Array of HostGroupTagResBody objects

标签信息.

create_time

Long

创建时间

update_time

Long

更新时间

labels

Array of strings

主机组标识

agent_access_type

String

主机接入类型
表9 HostGroupTagResBody

参数

参数类型

描述

key

String

标签Key

value

String

标签Value

tags_to_streams_enable

Boolean

是否将此标签应用至日志流上（只有日志组的标签可以将自身标签直接应用至日志流）

状态码：400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

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

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

{
  "host_group_id_list": [
    "bca6d903-3528-42a8-91f4-586722cxxxxx"
  ],
  "filter": {
    "host_group_type": "linux",
    "host_group_name_list": [
      "wjyTxxx"
    ],
    "host_name_list": [
      "ecs-apmtexxx删"
    ],
    "host_group_tag": {
      "tag_type": "AND",
      "tag_list": [
        {
          "key": "xxx",
          "value": "xxx"，
          “tags_to_streams_enable”：true
        }
      ]
    }
  }
}

响应示例

状态码：200

查询主机组列表请求响应成功

{
  "result" : [ {
    "host_group_id" : "598c77aa-c69b-42f0-8cb8-xxxx5b38",
    "host_group_name" : "wjyTxxx",
    "host_group_type" : "linux",
    "host_id_list" : [ "dc1dab7e-b04xxxx", "xxxxx" ],
    "host_group_tag" : [ {
      "key" : "xxx",
      "value" : "xxx"
    } ],
    "create_time" : 1635459410332,
    "update_time" : 163560332
  } ],
  "total" : 1
}

状态码：400

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

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

状态码：500

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

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

状态码

状态码

描述

200

查询主机组列表请求响应成功

400

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

500

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

错误码

请参见错误码。

父主题： 主机组管理