Querying Databases

Function

This API is used to query databases of a specified DB instance.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about request header parameters.

Constraints

This operation cannot be performed when the DB instance is in the abnormal or frozen state.
The details about databases of read replicas cannot be queried.

URI

URI format
GET /v3/{project_id}/instances/{instance_id}/database/detail?db={db}&page={page}&limit={limit}

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	Definition Instance ID. Constraints N/A Range N/A Default Value N/A
db	No	Definition Database name, which is case-insensitive for fuzzy search. Constraints N/A Range N/A Default Value N/A
page	Yes	Definition Page number. Constraints N/A Range The value starts from 1. Default Value N/A
limit	Yes	Definition Number of records on each page. Constraints N/A Range [1, 100] Default Value N/A

Request

Request parameters
None

URI example
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/database/detail?page=1&limit=10

Response

Normal response

**Table 2** Parameters
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 Indicates the total number of databases. Range N/A

**Table 3** databases element structure description
Parameter	Type	Description
name	String	Definition Indicates the database name. Range N/A
owner	String	Definition Indicates the database owner. Range N/A
character_set	String	Definition Indicates the character set used by the database, such as UTF8. Range N/A
collate_set	String	Definition Indicates the database collation, such as en_US.UTF-8. Range N/A
size	Integer	Definition Indicates the database size, in bytes. Range N/A

Example normal response

{
    "databases": [
        {
            "name": "rds_test",
            "owner": "root",
            "character_set": "UTF8",
            "collate_set":"en_US.UTF-8",
            "size":10777247
        },
       {
           "name": "rds_test2",
           "owner":"root",
           "character_set": "UTF8",
           "collate_set":"en_US.UTF-8",
           "size":1055623
        },
       {
           "name": "rds_test3",
           "owner":"root",
           "character_set": "UTF8",
           "collate_set":"en_US.UTF-8",
           "size":107772488
       }
    ],
    "total_count": 3
}