All Products
Document Center


Last Updated: Jan 18, 2018


This API supports both replica set instances and sharded cluster instances.

Input parameters

NameTypeRequired or notDescription
ActionStringYesRequired parameter; value: ModifyDBInstanceDescription.
DBInstanceIdStringYesInstance name
NodeIdStringNoIDs of instances of shard type that are successfully input to mongos or shard nodes.
DBInstanceDescriptionStringYes- Instance description.
- It cannot start with http://, https.
- It must start with a Chinese character or an English letter.
- It can contain 2 to 256 characters, which can be English letters, Chinese characters, underscores (_), hyphens (-), and numbers.

Response parameters

Public response parameters-For more information, see public response parameters.