Docs

Document Database for MongoDB

Instance management

ModifyDBInstanceName

Call the ModifyDBInstanceName API to modify instance name of target MongoDB instance.

Request type

Asynchronous request.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

InstanceId String required Sample value: mongo-replica-e405f8e2****

Instance ID.

tip

You can call the DescribeDBInstances API to query basic information of all MongoDB instances in the target region, including the instance ID.

InstanceNewName String required Sample value: test-mongo

New instance name. You can customize the instance name as needed; uniqueness is not required for instance names. The name must meet the following requirements:

It cannot start with a number or hyphen (-).

It can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-).

The length should be 2 to 64 characters.

Response parameters

The current API has no specified response parameters. For more information, see Response structure.

Example

Request example

Response example

Error code

For more details, see Error code.

Last updated: 2026.07.23 14:28:26