Updated on 2024-04-11 GMT+08:00

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.

Constraints

  • Databases cannot be queried when the DB instance is in the abnormal 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}

  • Example

    https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/database/detail?page=1&limit=10

  • 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).

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 utf8, gbk, and ascii.

  • Example normal response
    {
        "databases": [
            {
                "name": "rds-test",
                "character_set": "utf8"
            },
            {
                "name": "testdb1",
                "character_set": "utf8"
            },
            {
                "name": "tt",
                "character_set": "utf8"
            }
        ],
        "total_count": 3
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.