Help Center/ CodeArts Deploy/ API Reference/ APIs/ Managing Host Clusters/ Deleting a Host Cluster (Recommended)
Updated on 2025-05-27 GMT+08:00
View PDF

Deleting a Host Cluster (Recommended)

Function

This API is used to delete a host cluster by ID.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/resources/host-groups/{group_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

group_id

Yes

String

Parameter description:

Host cluster ID.

Constraints:

N/A

Value range:

The value consists of 32 characters. Only letters and digits are allowed.

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format).

X-Auth-Token

Yes

String

User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Parameter description:

Request success or failure status.

Value range:

  • success: Request succeeded

  • failed: Request failed

id

String

Parameter description:

Host cluster ID.

Value range:

The value consists of 32 characters. Only letters and digits are allowed.

Example Requests

https://{endpoint}/v1/resources/host-groups/f8421b5e91684258afc1d92ec46f67a2

Example Responses

Status code: 200

OK: The request is successful.

{
  "status" : "success",
  "id" : "f8421b5e91684258afc1d92ec46f67a2"
}

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

See Error Codes.

Parent topic: Managing Host Clusters