更新时间:2025-12-10 GMT+08:00

修改集群名称

功能介绍

修改集群名称。

约束限制

guestAgent插件版本8.3.1及以上才支持。

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/clusters/{cluster_id}/cluster-name

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

cluster_id

String

参数解释

集群ID。获取方法请参见获取集群ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

cluster_name

String

参数解释

修改集群名称请求。

约束限制

guestAgent插件版本8.3.1及以上才支持。

取值范围

中文或英文字母开头,3~64位长度。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

job_id

String

参数解释

任务ID,可用于查询任务进度信息。

取值范围

不涉及。

请求示例

修改集群名称为dws_cluster。

put https://{Endpoint}/v1/05f2cff45100d5112f4bc00b794ea08e/clusters/9f76c502-fc9c-4a52-8656-65d0da6e3d57/cluster-name

{
  "cluster_name" : "dws_cluster"
}

响应示例

状态码:200

请求下发成功。

{
  "job_id" : "g6aa82ba1fc9748389b613e8da13e2fe9"
}

状态码

状态码

描述

200

请求下发成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

500

服务内部错误。

503

服务不可用。