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 /v3/{project_id}/instances/{instance_id}/databases

**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 DB instance ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. 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 on the 2nd page are displayed. Constraints The value must be a non-negative integer. Range [0,2^31-1] Default Value 0 (indicating that 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
databases	Array of objects	Definition Each element in the list indicates a database. For details, see Table 3.
total_count	Integer	Definition Total number of records. Range [0, 2^31 - 1]. The actual value depends on the number of instances.

**Table 3** databases field data structure description
Parameter	Type	Description
name	String	Definition Database name. Range N/A
owner	String	Definition Database owner. Range N/A
character_set	String	Definition Character set used by the database, such as UTF8. Range N/A
collate_set	String	Definition Database collation, such as en_US.UTF-8. Range N/A
size	String	Definition Database size, in MB. Range N/A
datctype	String	Definition Character set used by the database, for example, en_US.UTF-8. Range N/A
compatibility_type	String	Definition Database compatibility type, for example, GaussDB and M. Range N/A

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": "gaussdb_test",
            "owner": "root",
            "size": "25 MB",
            "datctype": "en_US.UTF-8",
            "character_set": "UTF8",
            "collate_set": "en_US.UTF-8",
            "compatibility_type": "GaussDB"
        },
        {
            "name": "gaussdb_test1",
            "owner": "root",
            "size": "25 MB",
            "datctype": "en_US.UTF-8",
            "character_set": "UTF8",
            "collate_set": "en_US.UTF-8",
            "compatibility_type": "GaussDB"
        },
        {
            "name": "gaussdb_test2",
            "owner": "root",
            "size": "25 MB",
            "datctype": "en_US.UTF-8",
            "character_set": "UTF8",
            "collate_set": "en_US.UTF-8",
            "compatibility_type": "GaussDB"
        }
    ],
    "total_count": 3
}