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

修改实例名称

接口说明

修改实例的名称。

约束说明

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

URI

  • URI格式

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-name

  • URI样例

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-name

表1 请求参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

参数解释：

从IAM服务获取的用户Token。请参考认证鉴权。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

project_id

string

path

是

参数解释：

租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

string

path

是

参数解释：

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求消息

  • 参数说明
    表2 参数说明

    名称

    参数类型

    是否必选

    描述

    new_instance_name

    String

    是

    参数解释：

    新实例名称。用于表示实例的名称，允许和已有名称重复。

    约束限制：

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

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求示例

修改实例名称为myNewName。 
{
    "new_instance_name": "myNewName"
}

响应消息

  • 响应示例 
    {}

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 实例管理