Updated on 2026-02-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.

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>

-

-

Constraints

  • This operation cannot be performed when the instance is in the abnormal or frozen 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.
  • For databases authorized using the SQL statement GRANT ALL ON *.* TO `user`@`host`, no result will be returned after this API is called. You can run the show grants for command to query the authorized databases instead.

    You are advised to authorize a database by specifying it: GRANT ALL ON db1.* TO `user`@`host`.

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

    Definition

    Project ID of a tenant in a region.

    Constraints

    The value cannot be empty.

    Range

    To obtain the value, see Obtaining a Project ID.

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    The value cannot be empty.

    Range

    You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances.

    Default Value

    N/A

    user-name

    Yes

    Definition

    Specifies the database username.

    Constraints

    N/A

    Range

    You can obtain the value of this parameter from name in Table 3 by calling the API for querying database users.

    Default Value

    N/A

    page

    Yes

    Definition

    Specifies the page number. The value starts from 1.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    limit

    Yes

    Definition

    Specifies the number of records on each page.

    Constraints

    N/A

    Range

    [1, 100]

    Default Value

    N/A

Request

  • Request parameters

    None

  • URI example

    GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/db_user/database?user-name=rds&page=1&limit=10

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    databases

    Array of objects

    Definition

    Each element in the list indicates a database.

    For details, see Table 3.

    total_count

    Integer

    Definition

    Total number of databases.

    Range

    N/A

    Table 3 databases element structure description

    Parameter

    Type

    Description

    name

    String

    Definition

    Indicates the database name.

    Range

    N/A

    readonly

    Boolean

    Definition

    Indicates whether the permission is read-only.

    Range

    • true: read-only
    • false: read/write
  • 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.