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

Adding a Cluster to a Fleet

Function

This API is used to add a cluster to a fleet.

URI

POST /v1/clusters/{clusterid}/join

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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

clusterGroupID

No

String

ID of the fleet that the cluster is added to

Response Parameters

Status code: 200

The cluster has been added to the fleet.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

-

String

-

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

-

String

-

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

-

String

-

Example Requests

Adding a cluster to a fleet

POST https://ucs.myhuaweicloud.com/v1/clusters/{clusterid}/join

{
  "clusterGroupID" : "49077339-f1cd-11ec-a2be-0255ac1001c2"
}

Example Responses

Status code: 200

The cluster has been added to the fleet.

{ }

Status Codes

Status Code

Description

200

The cluster has been added to the fleet.

400

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

403

The server refused the request.

500

Internal server error.

Error Codes

See Error Codes.