Creating a Fleet

Function

This API is used to create a fleet. You can select clusters during fleet creation.

URI

POST /v1/clustergroups

Request Parameters

**Table 1** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Identity authentication information

**Table 2** Parameters in the request body
Parameter	Mandatory	Type	Description
metadata	Yes	RegisterClusterGroupObjectMeta object	Fleet metadata information
spec	No	RegisterClusterGroupSpec object	Attributes

**Table 3** RegisterClusterGroupObjectMeta
Parameter	Mandatory	Type	Description
name	Yes	String	Fleet name

**Table 4** RegisterClusterGroupSpec
Parameter	Mandatory	Type	Description
clusterIds	No	Array of strings	IDs of associated clusters
description	No	String	Fleet description

Response Parameters

Status code: 201

**Table 5** Parameters in the response body
Parameter	Type	Description
uid	String	Fleet UID

Status code: 400

**Table 6** Parameters in the response body
Parameter	Type	Description
-	String

Status code: 403

**Table 7** Parameters in the response body
Parameter	Type	Description
-	String

Status code: 500

**Table 8** Parameters in the response body
Parameter	Type	Description
-	String

Example Requests

Creating a fleet and (optional) adding clusters to the fleet

https://ucs.myhuaweicloud.com/v1/clustergroups

{
  "metadata" : {
    "name" : "group02281605"
  },
  "spec" : {
    "clusterIds" : [ "514c1a3c-8ec7-11ec-b384-0255ac100189", "d4804da3-8f03-11ec-b384-0255ac100189" ],
    "description" : "aaaaaaaaa"
  }
}

Example Responses

Status code: 201

The UID of the fleet that has been created is returned.

{
  "uid" : "6efb4a18-2fa4-11ee-ad1d-0255ac1001c4"
}

Status Codes

Status Code	Description
201	The UID of the fleet that has been created is returned.
400	Client request error. The server could not execute the request.
403	The server refused the request.
500	Internal server error.