更新时间:2023-11-21 GMT+08:00

修改实例名称

功能介绍

修改实例名称。

接口约束

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

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

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

URI

PUT https://{Endpoint}/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个字节之间,必须以字母或中文字开头,区分大小写,可以包含字母、数字、中划线、下划线或中文,不能包含其他特殊字符。

响应参数

状态码:204

无响应参数。

请求示例

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

响应示例

无。

状态码

请参见状态码

错误码

请参见错误码