Help Center> CodeArts Deploy> API Reference> APIs> Managing Host Clusters> Deleting a Host Cluster (Recommended)
Updated on 2024-07-05 GMT+08:00

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

Host cluster ID

Minimum: 32

Maximum: 32

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). Possible values: application/json;charset=utf-8 application/json

Default: application/json;charset=utf-8

Enumeration values:

  • application/json;charset=utf-8

  • application/json

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.

Minimum: 0

Maximum: 20000

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Request success or failure status

id

String

Host cluster ID

Minimum: 32

Maximum: 32

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.