Updated on 2023-09-21 GMT+08:00

Deleting a Host

Function

This API is used to delete a host of a specified ID. This API will not be maintained after September 30, 2024.

URI

DELETE /v2/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). 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

host_id

String

Host ID.

Example Requests

https://{endpoint}/v2/host-groups/ab7647b0863c4e969c8949d38d591339/hosts/300d6d2e53624d0da08b182099ad10f7

Example Responses

Status code: 200

OK: The request is successful.

{
  "host_id" : "300d6d2e53624d0da08b182099ad10f7"
}

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

See Error Codes.