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

Enabling Cluster Federation

Function

This API is used to enable cluster federation.

URI

POST /v1/clustergroups/{clustergroupid}/federations

Table 1 Path parameter

Parameter

Mandatory

Type

Description

clustergroupid

Yes

String

Fleet ID

Table 2 Query parameter

Parameter

Mandatory

Type

Description

retryjoinall

No

Boolean

Whether to retry adding the cluster to the federation.

Request Parameters

Table 3 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: 201

container fleet has in enable federation progress.

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

Status code: 201

Cluster federation has been enabled.

{ }

Status Codes

Status Code

Description

201

Cluster federation has been enabled.

400

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

404

Resources not found.

500

Internal server error.

Error Codes

See Error Codes.