This API is used to update the description of a fleet. You must have the permissions to update the fleet.
PUT /v1/clustergroups/{clustergroupid}/description
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
clustergroupid |
Yes |
String |
Fleet 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 |
|---|---|---|---|
description |
Yes |
String |
Fleet description |
None
Updating fleet description
{
"description" : "aaaaaaaaa"
}
None
Status Code |
Description |
|---|---|
200 |
Updated. |
400 |
Client request error. The server could not execute the request. |
403 |
The server refused the request. |
404 |
Resources not found. |
500 |
Internal server error. |
See Error Codes.