更新时间:2026-01-12 GMT+08:00

修改集群名称或描述

功能介绍

为了方便集群管理,该接口用于修改集群名称或修改集群描述。

调用方法

请参见如何调用API

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/changename

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID和名称

约束限制

不涉及

取值范围

账户的项目ID。

默认取值

不涉及

cluster_id

String

参数解释

指定更改集群名称的集群ID。获取方法请参见获取集群ID

约束限制

不涉及

取值范围

集群ID。

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

display_name

String

参数解释

修改后集群名称。

约束限制

参数display_name和desc不能同时为null。

取值范围

集群名称在4位到32位之间,必须以字母开头,可以包含字母、数字、点(.)、中划线或者下划线,不能包含其他的特殊字符。

默认取值

不涉及

desc

String

参数解释

集群描述。

约束限制

参数display_name和desc不能同时为null。

取值范围

长度不超过128个字符。

默认取值

不涉及

响应参数

状态码:200

请求已成功。

请求示例

修改当前集群的展示名称。

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/changename

{
  "display_name" : "ES-Test-new",
  "desc" : "test1"
}

响应示例

状态码

状态码

描述

200

请求已成功。

400

非法请求。

建议直接修改该请求,不要重试该请求。

409

服务器在完成请求时发生冲突。

返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。

412

未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。

错误码

请参见错误码