Help Center/ Ubiquitous Cloud Native Service/ API Reference/ API/ Fleets/ Updating Fleet Description
Updated on 2025-07-15 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

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 parameters

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
Table 3 Parameters in the request body

Parameter

Mandatory

Type

Description

description

Yes

String

Fleet description

Response Parameters

Status code: 200

Table 4 Parameters in the response body

Parameter

Type

Description

-

String

Status code: 400

Table 5 Parameters in the response body

Parameter

Type

Description

-

String

Status code: 403

Table 6 Parameters in the response body

Parameter

Type

Description

-

String

Status code: 404

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

Updating fleet description

PUT https://ucs.myhuaweicloud.com/v1/clustergroups/{clustergroupid}/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.

Parent topic: Fleets