You need to enable JavaScript to run this app.
文档中心
文档数据库 MongoDB 版

文档数据库 MongoDB 版

请输入
  • 文档首页
    • 文档数据库 MongoDB 版API 参考实例管理ModifyDBInstanceName
复制全文
下载 pdf
我的收藏
实例管理
ModifyDBInstanceName
复制全文
下载 pdf
我的收藏
ModifyDBInstanceName
调用 ModifyDBInstanceName 接口修改目标 MongoDB 实例的实例名称。​
请求类型​
异步请求。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
​
请求参数​
InstanceId String 必选 示例值：mongo-replica-e405f8e2****​
实例 ID。​
说明​
您可以调用 DescribeDBInstances接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。​
​
InstanceNewName String 必选 示例值：test-mongo​
修改后的实例新名称。您可以根据需要自定义实例名称，实例名称无唯一性要求。名称需同时满足如下要求：​
  • 不能以数字、中划线（-）开头。​
  • 只能包含中文、字母、数字、下划线（_）和中划线（-）。​
  • 长度需为 2~64 个字符。​
​
​
返回参数​
本接口无特有的返回参数。更多信息请见返回结构。​
示例​
请求示例​
​
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=ModifyDBInstanceName&Version=2022-01-01 HTTP/1.1​
Host: mongodb.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=utf-8​
X-Date: 20201103T104027Z​
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****​
{​
"InstanceId":"mongo-replica-e405f8e2****",​
"InstanceNewName":"mongo-test"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2022022316053801021214504818071807",​
"Action": "ModifyDBInstanceName",​
"Version": "2022-01-01",​
"Service": "mongodb",​
"Region": "cn-beijing"​
},​
"Result": null​
}​
​
错误码​
更多详情，请参见错误码。​
最近更新时间：2026.06.17 15:58:13
这个页面对您有帮助吗？
有用
有用
无用
无用