Creating a Host Group¶

Function¶

Create a host group.

URI¶

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

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID. Minimum: 1 Maximum: 64

Request Parameters¶

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token. Minimum: 1 Maximum: 10000
Content-Type	Yes	String	Set this parameter to application/json;charset=UTF-8. Minimum: 30 Maximum: 30

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
host_group_name	Yes	String	Host group name. Use only letters, digits, underscores (_), hyphens (-), and periods (.). Do not start with a period or underscore or end with a period. Minimum: 1 Maximum: 64
host_group_type	Yes	String	Host group type. Windows Linux
host_id_list	No	Array of strings	List of host group IDs. The host type must be the same as the host group type. Minimum: 36 Maximum: 36
host_group_tag	No	Array of HostGroupTag objects	Tag information. You can add up to 20 tags.
agent_access_type	No	String	Host access type. LABEL IP
labels	No	Array of strings	Host group identifier. If the host access type is LABEL, this field saves the host group identifier.

**Table 4** HostGroupTag¶
Parameter	Mandatory	Type	Description
key	Yes	String	Tag key. Use only UTF-8 letters, digits, spaces, and the following characters: .:=+-@. Do not start with an underscore (). Max 128 characters are allowed.
value	No	String	Tag value. Use only UTF-8 letters, digits, spaces, and the following characters: `_.:/=+-@.` Max 255 characters are allowed.

Response Parameters¶

Status code: 200

**Table 5** Response body parameters¶
Parameter	Type	Description
host_group_id	String	Host group ID.
host_group_name	String	Host group name.
host_group_type	String	Host group type.
host_id_list	Array of strings	Host ID list.
host_group_tag	Array of HostGroupTagResBody objects	Tag information.
create_time	Long	Creation time.
update_time	Long	Update time.
labels	Array of strings	Host group ID.
agent_access_type	String	Host access type.

**Table 6** HostGroupTagResBody¶
Parameter	Type	Description
key	String	Tag key.
value	String	Tag value.
tags_to_streams_enable	Boolean	Whether to apply the tag to the log stream. Only a tag of a log group can be directly applied to its log stream.

Status code: 400

**Table 7** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error description

Status code: 500

**Table 8** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error description

Example Requests¶

Create a host group. Parameters host_group_name and host_group_type are mandatory.

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

{
  "host_group_name" : "APIxx3",
  "host_group_type" : "linux",
  "host_id_list" : [ "dc1dab7e-b045-4e77xxd1bf7", "713a9fxx2df-24c4ca599def" ],
  "host_group_tag" : [ {
    "key" : "xxx",
    "value" : "xxx",
    "tags_to_streams_enable" : false
  } ]
}

Example Responses¶

Status code: 200

The host group is created.

{
  "host_group_id" : "598c77aa-c69b-42f0-8cb8-983178ad5b38",
  "host_group_name" : "APIxx3",
  "host_group_type" : "linux",
  "host_id_list" : [ "dc1dab7e-b045-4e77-bda4-914d083d1bf7" ],
  "host_group_tag" : [ {
    "key" : "xxx",
    "value" : "xxx",
    "tags_to_streams_enable" : true
  } ],
  "create_time" : 1635149410332,
  "update_time" : 1635149410332
}

Status code: 400

Invalid request. Modify the request based on the description in error_msg before a retry.

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

Status code: 500

The server has received the request but encountered an internal error.

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

Status Codes¶

Status Code	Description
200	The host group is created.
400	Invalid request. Modify the request based on the description in error_msg before a retry.
500	The server has received the request but encountered an internal error.

Error Codes¶

See Error Codes.

last updated: 2025-04-08 10:07 UTC - commit: c3988172dfdb29a962f8d4ee2c0d8b0d508b98f5