Updated on 2025-12-01 GMT+08:00

Deregistering a Cluster

Function

This API is used to deregister a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permission on the corresponding cluster. Otherwise, the authentication fails.

URI

DELETE /v1/clusters/{clusterid}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

clusterid

Yes

String

Cluster ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Identity authentication information. Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

-

String

-

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

-

String

-

Status code: 404

Table 5 Response body parameters

Parameter

Type

Description

-

String

-

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

-

String

-

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

The cluster has been deregistered.

400

Client request error. The server could not execute the request.

404

Resource not found.

500

Internal server error.

Error Codes

See Error Codes.