You need to enable JavaScript to run this app.
导航
ModifyDBInstanceName
最近更新时间:2024.10.17 14:42:41首次发布时间:2022.04.12 11:06:53

调用 ModifyDBInstanceName 接口修改目标 MongoDB 实例的实例名称。

请求类型

异步请求。

请求参数

参数
类型
是否必选
示例值
描述
InstanceId
String
mongo-replica-e405f8e2****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息,包括实例 ID。

InstanceNewName
String
test-mongo

修改后的实例新名称。您可以根据需要自定义实例名称,实例名称无唯一性要求。名称需同时满足如下要求:

  • 不能以数字、中划线(-)开头。
  • 只能包含中文、字母、数字、下划线(_)和中划线(-)。
  • 长度需为 2~64 个字符。

返回参数

本接口无特有的返回参数。更多信息请见返回结构

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=ModifyDBInstanceName&Version=2022-01-01 HTTP/1.1
Host: mongodb.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": "202202231605380102121450481807****",
        "Action": "ModifyDBInstanceName",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

更多详情,请参见错误码