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, frozen, or switchover in progress state.
The databases of read replicas cannot be queried.

URI

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

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
page	Yes	Definition Page number. Constraints N/A Range The value is a positive integer starting from 1. Default Value N/A
limit	Yes	Definition Specifies the number of records on each page. Constraints N/A Range The value is a positive integer ranging from 1 to 100. Default Value N/A
db-name	No	Definition Specifies the database name. Constraints When this parameter is specified, the page and limit parameters need to be specified but do not take effect. Range N/A Default Value N/A
recover_model	No	Definition Specifies recovery models of databases. Constraints N/A Range FULL: full recovery model SIMPLE: simple recovery model BULK_LOGGED: bulk-logged recovery model Default Value N/A

Request

Request parameters
None
URI example
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/a8abe84a41364097be7c233c39275087in04/database/detail?page=1&limit=10&db-name=testdb1

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 Database name. Range N/A
character_set	String	Definition Character set used by the database. Range For details about the character sets supported by RDS for SQL Server, see Table 2. Example value: Chinese_PRC_CI_AS
state	String	Definition Indicates the database status. Range Creating: The database is being created. Running: The database is running. Deleting: The database is being deleted. Not Exists: The database does not exist.

Example normal response

{
    "databases": [
        {
            "name": "master",
            "character_set": "Chinese_PRC_CI_AS",
            "state": "Running"
        },
        {
            "name": "msdb",
            "character_set": "Chinese_PRC_CI_AS",
            "state": "Running"
        },
        {
            "name": "model",
            "character_set": "Chinese_PRC_CI_AS",
            "state": "Running"
        },
        {
            "name": "tempdb",
            "character_set": "Chinese_PRC_CI_AS",
            "state": "Running"
        },
        {
            "name": "rdsadmin",
            "character_set": "Chinese_PRC_CI_AS",
            "state": "Running"
        },
        {
            "name": "rds-test",
            "character_set": "Chinese_PRC_CI_AS",
            "state": "Running"
        }
    ],
    "total_count": 6
}