Queries the details about the databases on an instance.
Operation description
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
rds:DescribeDatabases | READ |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. | rm-uf6wjk5**** |
DBName | string | No | The name of the database. | testDB01 |
DBStatus | string | No | The status of the database. Valid values:
| Creating |
PageSize | integer | No | The number of entries per page. Valid values:
Default value: 30. | 30 |
PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
ResourceGroupId | string | No | The ID of the resource group. | rg-acfmy**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "2603CA96-B17D-4903-BC04-61A2C829CD94",
"Databases": {
"Database": [
{
"DBDescription": "testdb",
"DBStatus": "Creating",
"DBName": "testDB01",
"DBInstanceId": "rm-uf6wjk5****",
"Engine": "MySQL",
"CharacterSetName": "utf8",
"Collate": "C",
"Ctype": "en_US.utf8",
"ConnLimit": "-1",
"Tablespace": "pg_default",
"ResourceGroupId": "rg-acfmy****",
"Accounts": {
"AccountPrivilegeInfo": [
{
"Account": "test",
"AccountPrivilege": "DMLOnly",
"AccountPrivilegeDetail": "SELECT"
}
]
},
"PageNumber": 1,
"PageSize": 30,
"TotalCount": 100,
"BasicInfo": {
"BasicDbProperty": [
{
"allowedValues": [
"CHECKSUM"
],
"databasePropertyName": "page_verify",
"allowModify": true,
"excludeLock": "0",
"currentValue": "CHECKSUM"
}
]
},
"RuntimeInfo": {
"RuntimeDbProperty": [
{
"allowedValues": [],
"databasePropertyName": "TotalDataSizeInMB",
"allowModify": false,
"currentValue": "5.38"
}
]
},
"AdvancedInfo": {
"AdvancedDbProperty": [
{
"allowedValues": [
"OFF",
"ON"
],
"databasePropertyName": "ansi_nulls",
"allowModify": true,
"excludeLock": "0",
"currentValue": "OFF"
}
]
}
}
]
}
}
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 | InvalidDBInstanceStatus.NotSupport | The Specified instance status is not supported to query account list. | - |
400 | Database.QueryError | Query Db failed, please check input value and instance status. | Failed to query the database. Check the specified parameters and the instance state. |
400 | SqlExcutionFailed | Database is in transition. Try the statement later. | The database is being modified. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||
---|---|---|---|---|---|---|---|---|
2023-08-09 | The Error code has changed | see changesets | ||||||
| ||||||||
2023-06-21 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||
| ||||||||
2023-03-24 | The Error code has changed | see changesets | ||||||
| ||||||||
2023-01-06 | The Error code has changed | see changesets | ||||||
| ||||||||
2022-09-15 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||
| ||||||||
2022-09-15 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||
|