Updated on 2024-03-28 GMT+08:00

Querying Details About a Database

Function

This API is used to query details about a database on 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 state.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/database

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

Request

  • Request parameters

    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.

    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.

    users

    Array of objects

    Each element in the list indicates an account associated with the database.

    For details, see Table 4.

    Table 4 users element structure description

    Name

    Type

    Description

    name

    String

    Account name.

    readonly

    Boolean

    Whether the permission is read-only.

    • true: read-only
    • false: read/write
  • Example normal response
    {
        "databases": [
            {
                "name": "rds-test",
                "character_set": "utf8",
                "users": [
                    {
                        "name": "rds",
                        "readonly": false
                    }
                ]
            },
            {
                "name": "testdb1",
                "character_set": "utf8",
                "users": []
            },
            {
                "name": "tt",
                "character_set": "utf8",
                "users": []
            }
        ]
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.