更新集群-UpdateCluster
功能介绍
更新集群名称或描述。支持部分更新，name 和 description 至少传一个。修改名称时校验同 project 下名称不重复。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| aics::updateCluster | Write | - | - | - | - |
URI
PUT /v2/{project_id}/clusters/{cluster_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID，获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| cluster_id | 是 | String | 参数解释: 集群唯一标识UUID。 约束限制: 不涉及。 取值范围: UUID格式，[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 参数解释: 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | String | 参数解释: 集群名称。 约束限制: 修改时同 project 下不可重复。 取值范围: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。 默认取值: 不涉及。 |
| description | 否 | String | 参数解释: 集群描述。 约束限制: 不涉及。 取值范围: 最长256字符。 默认取值: 不涉及。 |
响应参数
状态码：204
无
请求示例
更新集群请求示例。使用场景：用户需要修改集群名称或描述时，通过集群ID更新集群信息。
PUT https://{endpoint}/v2/0605767a3300d5762fb7c0186d9e1779/clusters/c69808bd-6832-49d4-8c04-fe631f7640c5
{
"name" : "cluster_new_name",
"description" : "更新后的集群描述"
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 204 | 成功更新集群。 |
错误码
请参见错误码。
