ModifyAccountDescription - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Modifies the description of the root account in an ApsaraDB for MongoDB instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
dds:ModifyAccountDescription	update	*Instance `acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-bp2356****
AccountName	string	Yes	The name of the account whose description is to be modified.	root
AccountDescription	string	Yes	The description of the account. The description must start with a letter and cannot start with http:// or https://. The description must be 2 to 256 characters in length, and can contain letters, digits, underscores (_), and hyphens (-).	superadmin
CharacterType	string	No	The type of the account whose description you can modify. Valid values: db: shard account cs: ConfigServer account normal (default): replica set account (available) Note You can set this parameter only to normal.	normal

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	59DE9FC2-7B40-45CF-9011-7327A8A771A2

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidAccountDescription.Malformed	Specified parameter AccountDescription is not valid.	-
400	InvalidAccountName.NotFound	Specified account name does not exist.	AccountName not entered or entered incorrectly.
400	InsType.NotSupport	Specified instance type dose not support this operation.	The specified instance type does not support this operation.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-01-09	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-12-07	The Error code has changed	View Change Details