Querying Details About Databases

Function

This API is used to query details about databases on a specified DB instance.

Before calling an API, you need to understand the API in Authentication.
Before calling this API, obtain the required region and endpoint.

Constraints

Databases cannot be queried when the DB instance is in the abnormal state.
The database user list of read replicas cannot be queried.

URI

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

Parameter description

**Table 1** Parameter description
Name	Mandatory	Description
project_id	Yes	Specifies the 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	Specifies the DB instance ID.
page	Yes	Specifies the page number. The value starts from 1.
limit	Yes	Specifies the number of records on each page. The value ranges from 1 (inclusive) to 100 (inclusive).
db-name	No	Specifies the database name. When this parameter is specified, the page and limit parameters need to be specified but do not take effect.

Request

None

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.
character_set	String	Indicates the character set used by the database, such as Chinese_PRC_CI_AS.
state	String	Indicates the database status. Its value can be any of the following: 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
}