Updated on 2024-04-12 GMT+08:00

Deleting a Host Group

Function

Delete a host group.

URI

DELETE /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_id_list

Yes

Array of strings

List of host group IDs.

Minimum: 36

Maximum: 36

Array Length: 1 - 1000

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

Array of GetHostGroupInfo objects

Host group details.

Array Length: 0 - 1000

total

Long

Number of deleted host groups.

Minimum: 0

Maximum: 1000

Table 5 GetHostGroupInfo

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

Delete a host group.

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

{
  "host_group_id_list" : [ "xxxx", "xxxx" ]
}

Example Responses

Status code: 200

Host groups are deleted.

{
  "result" : [ {
    "agent_access_type" : "IP",
    "create_time" : 1684718581734,
    "host_group_id" : "xxxx-a0f3-47bb-8449-c7740a9e764d",
    "host_group_name" : "lmy-xxx-0522-2",
    "host_group_tag" : [ {
      "key" : "tag0522",
      "value" : "xxxx"
    } ],
    "host_group_type" : "linux",
    "host_id_list" : [ "xxx-3054-4f4a-a0b3-86c804d31841", "bd0a5fce-a834-xxxxxx-b9c5-28a812c6643a" ],
    "labels" : [ ],
    "update_time" : 1684719073657
  } ],
  "total" : 1
}

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

Host groups are deleted.

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.