Querying Databases

Function

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

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
rds:database:list	list	instance	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:database:list

list

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

Constraints

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

URI

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

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Project ID of a tenant in a region. To obtain the value, 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).

Request

Request parameters
None

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

Response

Normal response

**Table 2** Parameters
Parameter	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
Parameter	Type	Description
name	String	Indicates the database name.
character_set	String	Indicates the character set used by the database, such as utf8, gbk, and ascii.
comment	String	Specifies the database remarks. NOTE: If you did not specify this parameter during instance creation, this parameter cannot be queried.

Example normal response

{
    "databases": [
        {
            "name": "rds-test",
            "character_set": "utf8",
            "comment":"comment"
        },
        {
            "name": "testdb1",
            "character_set": "utf8",
            "comment":"comment"
        },
        {
            "name": "tt",
            "character_set": "utf8",
            "comment":"comment"
        }
    ],
    "total_count": 3
}