You can call the ModifyAccountDescription operation to modify the description of an account of an instance.
Operation Description
NoteThis operation is not supported for instances that run SQL Server 2017 on RDS Cluster Edition or run PostgreSQL.
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 Resourcesis 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 |
|---|---|---|---|---|
| rds:ModifyAccountDescription | WRITE |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBInstanceId | string | Yes | The ID of the instance. | rm-uf6wjk5xxxxxxx |
| AccountName | string | Yes | The name of the account. | test1 |
| AccountDescription | string | Yes | The description of the account. The value must be 2 to 256 characters in length The value can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter. NoteThe value cannot start with http:// or https://. | Test Account A |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "17F57FEE-EA4F-4337-8D2E-9C23CAA63D74"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidDBDescription.Format | Specified DB description is not valid. | The database description is invalid. Specify a valid description. |
| 403 | IncorrectDBInstanceType | Current DB instance engine and type does not support operations. | The operation failed. The operation is not supported for the database engine of the RDS instance. |
| 403 | IncorrectDBInstanceCharacterType | Current DB Instance character_type does not support this operation. | This operation is not supported for the character type of the current instance. |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | - |
| 403 | IncorrectAccountType | Current account type does not support this operation. | This operation is not supported for the current account type. Check the account type. |
| 404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | The name of the RDS instance cannot be found. Check the name of the RDS instance. |
| 404 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | The operation failed. The RDS instance is locked. |
| 404 | InvalidAccountName.NotFound | Specified account name does not exist. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2022-10-28 | The error codes of the API operation change. | |||||||||
| ||||||||||
| 2022-06-23 | API Description Update | |||||||||
|