All Products
Search
Document Center

ApsaraDB for MongoDB:ModifyAccountDescription

Last Updated:Feb 08, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • 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 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.
OperationAccess levelResource typeCondition keyAssociated operation
dds:ModifyAccountDescriptionWRITE
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID.

dds-bp2356****
AccountNamestringYes

The name of the account whose description is to be modified.

root
AccountDescriptionstringYes

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

59DE9FC2-7B40-45CF-9011-7327A8A771A2

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400InvalidAccountDescription.MalformedSpecified parameter AccountDescription is not valid.
400InvalidAccountName.NotFoundSpecified account name does not exist.
400InsType.NotSupportSpecified instance type dose not support this operation.

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

Change history

Change timeSummary of changesOperation
2023-12-07The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400