Querying Databases

Function

This API is used to query databases of a specified instance. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/databases

**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.
offset	No	Integer	Page number. If offset is set to N, the resource query starts from the N+1 page. The value is 0 by default, indicating that the query starts from the first piece of data in 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 in 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
databases	Array of objects	Each element in the list indicates a database. For details, see Table 3.
total_count	Integer	Total number of records.

**Table 3** databases field data structure description
Parameter	Type	Description
name	String	Database name.
owner	String	Database owner.
character_set	String	Character set used by the database, such as UTF8.
collate_set	String	Database collation, such as en_US.UTF-8.
size	String	Database size.

Example Request

Querying databases

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/databases

Example Response

Databases queried.

{ 
  "databases" : [ { 
    "name" : "rds-test", 
    "character_set" : "utf8", 
    "owner" : "root", 
    "collate_set" : "en_US.UTF-8", 
    "size" : 10777247 
 
  }, { 
    "name" : "testdb1", 
    "character_set" : "utf8", 
    "owner" : "root", 
    "collate_set" : "en_US.UTF-8", 
    "size" : 10777247 
  }, { 
    "name" : "tt", 
    "character_set" : "utf8", 
    "owner" : "root", 
    "collate_set" : "en_US.UTF-8", 
    "size" : 10777247 
  } ], 
  "total_count" : 3 
}