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 this API.
Obtain the required region and endpoint.

Constraints

Databases cannot be queried when the DB instance is in the abnormal or frozen state.

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/schemas?db_name={db_name}

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	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	String	DB instance ID.
db_name	Yes	String	Database name. It must be different from template databases. Template databases include postgres, template0, and template1.
offset	No	Integer	Offset for pagination. If offset is set to N, the resource query starts from the N+1 page. The default value is 0, indicating that the query starts from the first data entry on the first page. The value cannot be a negative number. For example, if this parameter is set to 1 and limit is set to 10, only the 11th to 20th records on the 2nd page are displayed.
limit	No	Integer	Number of records displayed on each page. Value range: 1 to 100. Default value: 10.

Request Parameters

None

Response Parameters

**Table 2** Parameter description
Parameter	Type	Description
database_schemas	Array of objects	Database schema. Each element in the list indicates a database schema. For details, see Table 3.
total_count	Integer	Total number of database schemas.

**Table 3** database_schemas field data structure description
Parameter	Type	Description
schema_name	String	Schema name.
owner	String	Schema owner.

Example Request

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/schemas?db_name=dbname

Example Response

{ 
  "database_schemas" : [ { 
    "owner" : "root",
    "schema_name" : "rds-test"
  }, { 
    "owner" : "root",
    "schema_name" : "testdb1" 
  } ], 
  "total_count" : 2 
}