Files
doc-exports/docs/ucs/api-ref/JoinGroup.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

8.8 KiB

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 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.

Table 3 Parameter in the request body

Parameter

Mandatory

Type

Description

clusterGroupID

No

String

ID of the fleet that the cluster will be added to

Response Parameters

None

Example Requests

Adding a cluster to a fleet

{
  "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.