Files
doc-exports/docs/ucs/api-ref/DeleteCluster.html
qiujiandong1 535e30e292 UCS API initial update 20250523 version
Reviewed-by: Gergo-Bence Lorincz <a200452876@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com>
Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
2026-02-23 09:12:31 +00:00

13 KiB

Unregistering a Cluster

Function

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

URI

DELETE /v1/clusters/{clusterid}

Table 1 Path parameter

Parameter

Mandatory

Type

Description

clusterid

Yes

String

Cluster ID

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

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.

Content-Type

Yes

String

Message body type (format). Only application/json is supported.

Response Parameters

Status code: 200

Table 3 Parameter in the response body

Parameter

Type

Description

-

String

The cluster has been unregistered.

Status code: 400

Table 4 Parameter in the response body

Parameter

Type

Description

-

String

-

Status code: 404

Table 5 Parameter in the response body

Parameter

Type

Description

-

String

-

Status code: 500

Table 6 Parameter in the response body

Parameter

Type

Description

-

String

-

Example Requests

None

Example Responses

Status code: 200

The cluster has been unregistered.

{ }

Status Codes

Status Code

Description

200

The cluster has been unregistered.

400

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

404

Resources not found.

500

Internal server error.

Error Codes

See Error Codes.