文档首页/MapReduce服务 MRS/API参考/API V2/集群管理接口/修改集群名称-UpdateClusterName
更新时间：2025-12-17 GMT+08:00
查看PDF
分享

修改集群名称-UpdateClusterName

功能介绍

修改集群名称

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和受限项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    mrs:cluster:updateClusterName

    Write

    cluster *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目编号。获取方法，请参见获取项目ID。

约束限制：

不涉及

取值范围：

只能由英文字母和数字组成，且长度为[1-64]个字符。

默认取值：

不涉及

cluster_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

只能由英文字母、数字以及“_”和“-”组成，且长度为[1-64]个字符。

默认取值：

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

cluster_name

是

String

参数解释：

新的集群名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

result

String

参数解释：

更新映射请求操作结果。

约束限制：

不涉及

取值范围：

  • succeeded：操作成功
  • failed：操作失败

默认取值：

不涉及

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

error_msg

String

参数解释：

错误描述。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求示例

修改MRS集群名称为mrs_jdRU_dm01

{
  "cluster_name" : "mrs_jdRU_dm01"
}

响应示例

状态码：200

修改集群名称成功

{
  "result" : "succeeded"
}

状态码

状态码请参见状态码。

错误码

请参见错误码。

父主题：集群管理接口