本文导读

接口说明
约束说明
调试
URI
请求消息
请求示例
响应消息
SDK
状态码
错误码

展开导读

文档首页/ 文档数据库服务 DDS/ API参考/ API v3（推荐）/ 实例管理/ 修改实例名称

修改实例名称

更新时间：2025-04-29 GMT+08:00

查看PDF

接口说明

修改实例的名称。

约束说明

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

调试

您可以在API Explorer中调试该接口。

URI

URI格式
 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-name
URI样例
 https://dds.cn-north-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文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 实例管理

上一篇：切换SSL开关

下一篇：修改实例备注

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问