Updated on 2025-09-04 GMT+08:00

Querying Database Schemas

This API is used to query database schemas of a specified DB instance.

This operation cannot be performed when the DB instance is in the abnormal state.
The database schemas of read replicas cannot be queried.

URI format
GET /v3/{project_id}/instances/{instance_id}/schema/detail?db_name={name}&page={page}&limit={limit}

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

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

**Table 3** users element structure description
Name	Type	Description
schema_name	String	Definition Indicates a schema name. Range N/A
owner	String	Definition Indicates a schema owner. Range N/A

Example normal response

{
  "database_schemas": [{
    "schema_name": "rds_user1",
    "owner": "root"
  }],
"total_count": 1
}

For details, see Error Codes.