更新时间:2024-04-12 GMT+08:00

创建主机组

功能介绍

创建主机组

URI

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

表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=UTF-8。

缺省值:None

最小长度:30

最大长度:30

表3 请求Body参数

参数

是否必选

参数类型

描述

host_group_name

String

主机组名称

最小长度:1

最大长度:64

host_group_type

String

主机类型。linux:linux类型

枚举值:

  • linux

host_id_list

Array of strings

主机组ID列表。主机类型必须与主机组类型一致

最小长度:36

最大长度:36

数组长度:1 - 1000

host_group_tag

Array of HostGroupTag objects

标签信息。最多支持20个标签。KEY不能重复。

数组长度:1 - 10

agent_access_type

String

主机组类型

枚举值:

  • LABEL
  • IP

labels

Array of strings

标签

表4 HostGroupTag

参数

是否必选

参数类型

描述

key

String

标签Key

最小长度:1

最大长度:36

value

String

标签Value

最小长度:1

最大长度:36

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

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

标签

表6 HostGroupTag

参数

参数类型

描述

key

String

标签Key

最小长度:1

最大长度:36

value

String

标签Value

最小长度:1

最大长度:36

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

调用失败响应信息描述。

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

调用失败响应信息描述。

请求示例

创建主机组

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

/v3/{project_id}/lts/host-group 
{
    "host_group_name" : "APIxx3",
    "host_group_type" : "linxx",
    "host_id_list" : ["dc1dab7e-b045-4e77xxd1bf7", "713a9fxx2df-24c4ca599def"]
}

响应示例

状态码: 200

创建主机组请求响应成功

{
  "agent_access_type" : "IP",
  "create_time" : 1684982746202,
  "host_group_id" : "xxxxx-abb8-4ec7-914c-25ce9ea10835",
  "host_group_name" : "lmy-test-0522-8",
  "host_group_tag" : [ ],
  "host_group_type" : "linux",
  "host_id_list" : [ "xxxx-e8ad-430c-ac12-46bac5e39fe6", "xxxxx-7179-463b-90b1-0c3261aedceb" ],
  "labels" : [ ],
  "update_time" : 1684982746202
}

状态码: 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

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

错误码

请参见错误码