All Products
Document Center

ApsaraDB for MongoDB:ModifyAccountDescription

Last Updated:Jan 17, 2023

Modifies the description of the root account 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:ModifyAccountDescription WRITE
  • MongoDB

Request parameters

Parameter Type Required Description Example
DBInstanceId string Yes

The ID of the instance.

AccountName string Yes

The name of the account for which you want to modify the description.

AccountDescription string Yes

The description of the account.

  • It cannot start with http:// or https://.
  • It must start with a letter.
  • It must be 2 to 256 characters in length, and can contain letters, digits, underscores (_), and hyphens (-).

Response parameters

Parameter Type Description Example
RequestId string

The ID of the request.



Normal return example


  "RequestId": "59DE9FC2-7B40-45CF-9011-7327A8A771A2"

Error codes

Http code Error code Error message
400 InvalidAccountDescription.Malformed Specified parameter AccountDescription is not valid.
400 InvalidAccountName.NotFound Specified account name does not exist.
400 InsType.NotSupport Specified instance type dose not support this operation.

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