文档首页/ 云日志服务 LTS/ 更多文档/ API参考（安卡拉区域）/ API说明/ 主机组管理/ 查询主机组
更新时间：2024-04-12 GMT+08:00
查看PDF
分享

查询主机组

功能介绍

查询主机组列表

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

缺省值：None

最小长度：32

最大长度：32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。

缺省值：None

最小长度：1000

最大长度：2000

Content-Type

是

String

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

缺省值：None

最小长度：29

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

参数

是否必选

参数类型

描述

host_group_id_list

否

Array of strings

主机组ID

最小长度：36

最大长度：36

数组长度：0 - 1000

filter

否

GetHostGroupListFilter object

主机组过滤参数
表4 GetHostGroupListFilter

参数

是否必选

参数类型

描述

host_group_type

否

String

主机类型。linux：linux类型

枚举值：

  • linux

host_group_name_list

否

Array of strings

主机组名称列表。

最小长度：1

最大长度：64

数组长度：0 - 1000

host_name_list

否

Array of strings

主机名称列表。

最小长度：1

最大长度：128

数组长度：0 - 1000

host_group_tag

否

GetHostGroupListTag object

主机组标签信息
表5 GetHostGroupListTag

参数

是否必选

参数类型

描述

tag_type

否

String

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

枚举值：

  • AND
  • OR

tag_list

否

Array of HostGroupTag objects

主机组标签

数组长度：1 - 1000
表6 HostGroupTag

参数

是否必选

参数类型

描述

key

否

String

标签Key

最小长度：1

最大长度：36

value

否

String

标签Value

最小长度：1

最大长度：36

响应参数

状态码： 200

表7 响应Body参数

参数

参数类型

描述

result

Array of GetHostGroupInfo objects

主机组列表

数组长度：0 - 1000

total

Long

主机组信息总数量

最小值：0

最大值：1000
表8 GetHostGroupInfo

参数

参数类型

描述

host_group_id

String

主机组ID

最小长度：36

最大长度：36

host_group_name

String

主机组名称

最小长度：1

最大长度：64

host_group_type

String

主机类型。linux：linux类型

枚举值：

  • linux

host_id_list

Array of strings

主机ID列表

最小长度：36

最大长度：36

数组长度：0 - 1000

host_group_tag

Array of HostGroupTag objects

标签信息

数组长度：0 - 1000

create_time

Long

创建时间

最小值：0

最大值：9999999999999

update_time

Long

更新时间

最小值：0

最大值：9999999999999

agent_access_type

String

主机组类型

枚举值：

  • LABEL
  • IP

labels

Array of strings

标签
表9 HostGroupTag

参数

参数类型

描述

key

String

标签Key

最小长度：1

最大长度：36

value

String

标签Value

最小长度：1

最大长度：36

状态码： 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：8

error_msg

String

错误描述

最小长度：1

最大长度：1000

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：8

error_msg

String

错误描述

最小长度：1

最大长度：1000

请求示例

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

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

/v3/{project_id}/lts/host-group-list 
{
    "host_group_id_list" : ["bca6d903-3528-42a8-91f4-586722cxxxxx"],
    "filter" : {
        "host_group_type" : "lixxx",
        "host_group_name_list" : ["wjyTxxx", "xxxest"],
        "host_name_list" : ["ecs-apmtexxx删"],
        "host_group_tag" : {
            "tag_type" : "AND",
            "tag_list" : [{
                    "key" : "xxx",
                    "value" : "xxx"
                }
            ]
        }
    }
}

响应示例

状态码： 200

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

{
  "result" : [ {
    "agent_access_type" : "IP",
    "create_time" : 1684811693411,
    "host_group_id" : "xxxx-3edb-4bb9-ba61-6b690d44d1cd",
    "host_group_name" : "lmy-xxxx-0522-3",
    "host_group_tag" : [ {
      "key" : "test001",
      "value" : "bbb1"
    }, {
      "key" : "aaa2",
      "value" : "bbb2"
    } ],
    "host_group_type" : "linux",
    "host_id_list" : [ "xxxxx-3054-4f4a-a0b3-86c804d31841" ],
    "labels" : [ ],
    "update_time" : 1684811693411
  } ],
  "total" : 1
}

状态码： 400

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

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

状态码： 500

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

{
  "error_code" : "LTS.0010",
  "error_msg" : "The system encountered an internal error"
}

状态码

状态码

描述

200

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

400

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

500

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

错误码

请参见错误码。

父主题： 主机组管理