ModifyDBInstanceDescription - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Modifies the name of an ApsaraDB for MongoDB instance.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
Condition keyword: refers to the condition keyword defined by the cloud product itself.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operate	access level	Resource type	conditional keyword	Association operation
dds:ModifyDBInstanceDescription	WRITE	MongoDB acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	without	without

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance NoteTo modify the name of a shard or mongos node in a sharded cluster instance, you must also specify the NodeId parameter.	dds-bp2234****
NodeId	string	No	The ID of the shard or mongos node in the sharded cluster instance. NoteThis parameter is valid only if you set the DBInstanceId parameter to the ID of a sharded cluster instance.	d-bp89067****
DBInstanceDescription	string	Yes	The name of the instance. Note The name cannot start with `http://` or `https://`. The name must start with a letter. The name must be 2 to 256 characters in length, and can contain letters, underscores (_), hyphens (-), and digits.	testdata

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	06F8F642-4009-4FFC-80C4-9D67DBF7B74E

Example

Normal return example

JSONFormat

{
  "RequestId": "06F8F642-4009-4FFC-80C4-9D67DBF7B74E"
}

Error codes

Http code	Error code	Error message	Description
400	InvalidDBInstanceDescription.Malformed	Specified parameter DBInstanceDescription is not valid.	Invalid node name.

For a list of error codes, visit the API error center.