文档首页/华为云UCS/API参考/API/容器舰队/更新容器舰队描述信息 - UpdateClusterGroup
更新时间：2026-01-14 GMT+08:00
查看PDF
分享

更新容器舰队描述信息 - UpdateClusterGroup

功能介绍

更新集群所属的容器舰队description信息；需要用户对相应容器舰队有更新权限

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

PUT /v1/clustergroups/{clustergroupid}/description

表1 路径参数

参数

是否必选

参数类型

描述

clustergroupid

是

String

容器舰队ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

身份认证信息，调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值

Content-Type

是

String

消息体的类型（格式），仅支持application/json

表3 请求Body参数

参数

是否必选

参数类型

描述

description

是

String

容器舰队描述信息

响应参数

状态码：200

更新成功

状态码：400

表4 响应Body参数

参数

参数类型

描述

-

String

-

状态码：403

表5 响应Body参数

参数

参数类型

描述

-

String

-

状态码：404

表6 响应Body参数

参数

参数类型

描述

-

String

-

状态码：500

表7 响应Body参数

参数

参数类型

描述

-

String

-

请求示例

更新容器舰队的描述信息

PUT https://ucs.myhuaweicloud.com/v1/clustergroups/{clustergroupid}/description

{
  "description" : "aaaaaaaaa"
}

响应示例

状态码：200

更新成功

{ }

状态码

状态码

描述

200

更新成功

400

客户端请求错误，服务器无法执行请求

403

服务器拒绝执行请求

404

资源不存在

500

服务器内部错误

错误码

请参见错误码。

父主题：容器舰队

相关文档