Querying Database Schemas
Function
This API is used to query database schemas of a specified DB instance.
- Before calling this API, learn how to authenticate it.
- Before calling this API, learn about request header parameters.
Constraints
- This operation cannot be performed when the DB instance is in the abnormal or frozen state.
- The database schemas of read replicas cannot be queried.
URI
- Parameter description
Table 1 Parameters Parameter
Mandatory
Description
project_id
Yes
Definition
Project ID of a tenant in a region.
To obtain the value, see Obtaining a Project ID.
Constraints
N/A
Range
N/A
Default Value
N/A
instance_id
Yes
Definition
Instance ID.
Constraints
N/A
Range
N/A
Default Value
N/A
db_name
Yes
Definition
Specifies the database name.
Constraints
N/A
Range
Database names must be different from RDS for PostgreSQL template database names.
RDS for PostgreSQL template databases include postgres, template0, and template1.
Default Value
N/A
page
Yes
Definition
Page number.
Constraints
N/A
Range
The value starts from 1.
Default Value
N/A
limit
Yes
Definition
Number of records on each page.
Constraints
N/A
Range
[1, 100]
Default Value
N/A
Request
Response
- Normal response
Table 2 Parameters Parameter
Type
Description
database_schemas
Array of objects
Definition
Each element in the list indicates a database schema.
For details, see Table 3.
total_count
Integer
Definition
Indicates the total number of database schemas.
Range
N/A
- Example normal response
{ "database_schemas": [{ "schema_name": "rds_user1", "owner": "root" }], "total_count": 1 }
- 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