Updated on 2026-08-25 GMT+08:00

Querying Database Schemas

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

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

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 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. You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances. 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. You can obtain the value of this parameter from name in Table 3 by calling the API for querying databases. 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 parameters
None
URI example
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/schema/detail?db_name=rds_test&page=1&limit=10

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.

Parent topic: Database and Account Management (PostgreSQL)