Querying Databases
Function
This API is used to query databases in a specified DB instance.
- Before calling an API, you need to understand the API in Authentication.
Constraints
- Databases cannot be queried when the DB instance is in the abnormal or frozen state.
- The database list of read replicas cannot be queried.
URI
- Parameter description
Table 1 Parameter description Name
Mandatory
Description
project_id
Yes
Project ID of a tenant in a region.
For details about how to obtain the project ID, 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).
Request
Response
- Normal response
Table 2 Parameter description Name
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.
Table 3 databases element structure description Name
Type
Description
name
String
Indicates the database name.
character_set
String
Indicates the character set used by the database, such as utf8, gbk, and ascii.
comment
String
Specifies the database remarks.
NOTE:If you did not specify this parameter during instance creation, this parameter cannot be queried.
- Example normal response
{ "databases": [ { "name": "rds-test", "character_set": "utf8", "comment":"comment" }, { "name": "testdb1", "character_set": "utf8", "comment":"comment" }, { "name": "tt", "character_set": "utf8", "comment":"comment" } ], "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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot