Querying Databases
Function
This API is used to query databases in a specified DB instance.
- Before calling this API, learn how to authenticate it.
- Before calling this API, learn about request header parameters.
Constraints
- Databases cannot be queried when the DB instance is in the abnormal state.
- The database list of read replicas cannot be queried.
URI
- Parameter description
Table 1 Parameters Parameter
Mandatory
Description
project_id
Yes
Project ID of a tenant in a region.
To obtain the value, see Obtaining a Project ID.
instance_id
Yes
Specifies the DB instance ID.
page
Yes
Specifies the page number. The value starts from 1.
limit
Yes
Specifies the number of records on each page. The value ranges from 1 (inclusive) to 100 (inclusive).
Response
- Normal response
Table 2 Parameters Parameter
Type
Description
databases
Array of objects
Each element in the list indicates a database.
For details, see Table 3.
total_count
Integer
Indicates the total number of databases.
- Example normal response
{ "databases": [ { "name": "rds-test", "character_set": "utf8" }, { "name": "testdb1", "character_set": "utf8" }, { "name": "tt", "character_set": "utf8" } ], "total_count": 3 }
- Abnormal response
For details, see Abnormal Request Results.
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.