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 Account Tenant ID, Log Group ID, and Log Stream ID. Default: None Minimum: 32 Maximum: 32

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM. Default: None Minimum: 1000 Maximum: 2000
Content-Type	Yes	String	Set this parameter to application/json;charset=UTF-8. Default: None Minimum: 30 Maximum: 30

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
host_group_name	Yes	String	Host group name. Minimum: 1 Maximum: 64
host_group_type	Yes	String	Host type. The value can be linux. Enumeration values: 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 Array Length: 1 - 1000
host_group_tag	No	Array of HostGroupTag objects	Tag information. You can add up to 20 tags. The tag key must be unique. Array Length: 1 - 10
agent_access_type	No	String	Host group type. Enumeration values: LABEL IP
labels	No	Array of strings	Tags.

**Table 4** HostGroupTag
Parameter	Mandatory	Type	Description
key	No	String	Tag key. Minimum: 1 Maximum: 36
value	No	String	Tag value. Minimum: 1 Maximum: 36

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
host_group_id	String	Host group ID. Minimum: 36 Maximum: 36
host_group_name	String	Host group name. Minimum: 1 Maximum: 64
host_group_type	String	Host type. The value can be linux. Enumeration values: linux
host_id_list	Array of strings	Host ID list. Minimum: 36 Maximum: 36 Array Length: 0 - 1000
host_group_tag	Array of HostGroupTag objects	Tags. Array Length: 0 - 1000
create_time	Long	Creation time. Minimum: 0 Maximum: 9999999999999
update_time	Long	Update time. Minimum: 0 Maximum: 9999999999999
agent_access_type	String	Host group type. Enumeration values: LABEL IP
labels	Array of strings	Tag.

**Table 6** HostGroupTag
Parameter	Type	Description
key	String	Tag key. Minimum: 1 Maximum: 36
value	String	Tag value. Minimum: 1 Maximum: 36

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Create a host group.

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"]
}

Example Responses

Status code: 200

The host group is created.

{
  "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
}

Status code: 400

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

{
  "error_code" : "LTS.1807",
  "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" : "The system encountered an internal 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.