Modifies the description of a database of an instance.
Operation Description
NoteThis operation is not applicable to instances that 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:ModifyDBDescription | WRITE |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBInstanceId | string | Yes | The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance. | rm-uf6wjk5xxxxxxx |
| DBName | string | Yes | The name of the database. | testDB01 |
| DBDescription | string | Yes | The description of the database. | Test database 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 | Database.ConnectError | Database connect error. please check instance status and database processlist | A database connection error occurred. Check the instance state and the database connection pool. |
| 400 | IncorrectDBInstanceLockMode.ValueNotSupported | The Current DB instance lock mode does not support this operation. | The operation failed. The RDS instance is locked. |
| 400 | InvalidDBDescription.Format | Specified DB description is not valid. | The database description is invalid. Specify a valid description. |
| 400 | InvalidDBName.NotFound | Specified DB name does not exist. | The database name cannot be found. Enter a valid database name. |
| 400 | Database.UpdateError | Update Db failed, please check input value and instance status. | Failed to update the database. Check the specified parameters and the instance state. |
| 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 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | - |
| 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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-03-24 | The error codes of the API operation change. | |||||||||
| ||||||||||
| 2022-10-28 | The error codes of the API operation change. | |||||||||
| ||||||||||
| 2022-06-23 | API Description Update,The error codes of the API operation change. | |||||||||
|