Updating Fleet Description

Function

This API is used to update the description of a fleet. You must have the permissions to update the fleet.

URI

PUT /v1/clustergroups/{clustergroupid}/description

Table 1 Path parameter

Parameter

Mandatory

Type

Description

clustergroupid

Yes

String

Fleet 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

description

Yes

String

Fleet description

Response Parameters

None

Example Requests

Updating fleet description

{
  "description" : "aaaaaaaaa"
}

Example Responses

None

Status Codes

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.

Error Codes

See Error Codes.