Querying Databases

Function

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

Before calling an API, you need to understand the API in Authentication.

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** Parameter description
Name	Mandatory	Description
project_id	Yes	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	Instance ID.
db	No	Database name, which is case-insensitive for fuzzy search.
page	Yes	Page number. The value starts from 1.
limit	Yes	Number of records on each page. The value ranges from 1 (inclusive) to 100 (inclusive).

Request

Request parameters
None

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

Response

Normal response

**Table 2** Parameter description
Name	Type	Description
databases	Array of objects	Each element in the list indicates a database. For details, see Table 3.
total_count	Integer	Indicates the total number of databases.

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

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
}