Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Database and Account Management (PostgreSQL)/ Querying Database Schemas
Updated on 2024-01-12 GMT+08:00
View PDF

Querying Database Schemas

Function

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

  • Before calling an API, you need to understand the API in Authentication.

Constraints

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

URI

  • URI format

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

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the 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.

    db_name

    Yes

    Specifies the database name.

    Database names must be different from RDS for PostgreSQL template libraries.

    RDS for PostgreSQL template libraries include postgres, template0, and template1.

    page

    Yes

    Specifies the page number. The value starts from 1.

    limit

    Yes

    Specifies the number of records on each page. The value range is from 1 (inclusive) to 100 (inclusive).

Request

  • Request parameters

    None

Response

  • Normal response
    Table 2 Parameter description

    Name

    Type

    Description

    database_schemas

    Array of objects

    Each element in the list indicates a database schema.

    For details, see Table 3.

    total_count

    Integer

    Indicates the total number of database schemas.
    Table 3 users element structure description

    Name

    Type

    Description

    schema_name

    String

    Indicates a schema name.

    owner

    String

    Indicates a schema owner.
  • Example normal response 
    {
  "database_schemas": [{
    "schema_name": "rds_user1",
    "owner": "root"
  }],
"total_count": 1
}

Status Code

Error Code

For details, see Error Codes.