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 /v3/{project_id}/instances/{instance_id}/schemas?db_name={db_name}

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
db_name	Yes	String	Definition Database name. Constraints It must be different from template databases. Template databases include postgres, template0, template1. Range N/A Default Value N/A
offset	No	Integer	Definition Offset for pagination. The query starts from the next piece of data indexed by this parameter. For example, if this parameter is set to 1 and limit is set to 10, only the 11th to 20th records are displayed. Constraints N/A Range [0,2^31-1] Default Value 0: The query starts from the first data record.
limit	No	Integer	Definition Number of records displayed per page. Constraints N/A Range [1, 100] Default Value 10

Request Parameters

None

Response Parameters

**Table 2** Parameter description
Parameter	Type	Description
database_schemas	Array of objects	Definition Database schema information. Each element in the list indicates a database schema. For details, see Table 3.
total_count	Integer	Definition Total number of database schemas. Range [1, 2^31 – 1]

**Table 3** database_schemas field data structure description
Parameter	Type	Description
schema_name	String	Definition Schema name. Range N/A
owner	String	Definition Schema owner. Range N/A

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 
}