Help Center/ CodeArts Deploy/ API Reference/ APIs/ Managing Hosts/ Deleting a Host from a Host Cluster
Updated on 2025-05-27 GMT+08:00

Deleting a Host from a Host Cluster

Function

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

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

group_id

Yes

String

Host cluster ID

host_id

Yes

String

Host ID

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

Request success or failure status

id

String

Host ID

Example Requests

https://{endpoint}/v1/resources/host-groups/6bec5f67ab9b4c34a21c7ffe0b0191c8/hosts/a94facdc4b1e40d799dbe6de91167072

Example Responses

Status code: 200

OK: The request is successful.

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

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

See Error Codes.