Updated on 2025-09-04 GMT+08:00

Querying Authorized Databases of a Specified User

Function

This API is used to query authorized databases of a specified database user.

Constraints

  • This operation cannot be performed when the instance is in the abnormal state.
  • If you delete a database using SQL statements, the deleted database will be displayed when you query the authorized databases through the API or RDS console.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/db_user/database?user-name={user-name}&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.

    user-name

    Yes

    Specifies the database username.

    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

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.

    readonly

    Boolean

    Indicates the read-only permission.

    • true: indicates the database is read-only.
    • false: indicates the database is readable and writable.
  • Example normal response
    {
        "databases": [
            {
                "name": "rds-test",
                "readonly": false
            },
            {
                "name": "testdb1",
                "readonly": true
            },
            {
                "name": "tt",
                "readonly": false
            }
        ],
        "total_count": 3
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.