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	Explanation: Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Restrictions: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None
instance_id	Yes	String	Explanation: Instance ID, which is the unique identifier of an instance. Restrictions: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None
db_name	Yes	String	Explanation: Database name. Restrictions: It must be different from template databases. Template databases include postgres, template0, template1. Value range: None Default value: None
offset	No	Integer	Explanation: 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. Restrictions: None Value range: [0, 2^31-1] Default value: 0 (indicating that the query starts from the first data record.)
limit	No	Integer	Explanation: Number of records displayed per page. Restrictions: None Value range: [1, 100] Default value: 10

Request Parameters

None

Response Parameters

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

**Table 3** database_schemas field data structure description
Parameter	Type	Description
schema_name	String	Explanation: Schema name. Value range: None
owner	String	Explanation: Schema owner. Value range: None

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 
}