This API is used to add a cluster to a fleet.
POST /v1/clusters/{clusterid}/join
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
clusterid |
Yes |
String |
Cluster ID |
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. |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
clusterGroupID |
No |
String |
ID of the fleet that the cluster will be added to |
None
Adding a cluster to a fleet
{
"clustergroupID" : "49077339-f1cd-11ec-a2be-0255ac1001c2"
}
Status code: 200
The cluster has been added to the fleet.
{ }
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. |
See Error Codes.