文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 修改实例名称 - EditingtheNameofanInstance
更新时间：2025-11-27 GMT+08:00
查看PDF
分享

修改实例名称 - EditingtheNameofanInstance

功能介绍

修改实例名称。

接口约束

该接口支持如下数据库实例：

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx
  • GeminiDB Redis

创建中和创建失败的实例不支持修改实例名称。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:instance:rename

    Write

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:instance:rename

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/name

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一region下的project ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

参数解释：

新实例名称。

约束限制：

不能包含其他特殊字符。

取值范围：

实例名称长度在4个到64个字节之间，必须以字母或中文字开头，区分大小写，可以包含字母、数字、中划线、下划线或中文（一个中文字符占用3个字节），不能包含其他特殊字符。

默认取值：

不涉及。

响应参数

状态码：204

无响应参数。

请求示例

  • URI样例 
    PUT https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/name
  • 修改实例名称为"myNewName" 
    {
  "name" : "myNewName"
}

响应示例

无。

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理