Updated on 2025-08-20 GMT+08:00

Querying Authorized Users of a Specified Database

Function

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

Constraints

  • This operation cannot be performed when the DB instance is in the abnormal or frozen state.
  • The accounts of read replicas cannot be queried.

URI

  • URI format

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

    db-name

    Yes

    Specifies the database name.

    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/db_user?db-name=rds&page=1&limit=10

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    users

    Array of objects

    Each element in the list indicates a database account.

    For details, see Table 3.

    total_count

    Integer

    Indicates the total number of database users.

    Table 3 users element structure description

    Parameter

    Type

    Description

    name

    String

    Account name.

    readonly

    Boolean

    Whether the permission is read-only.

    • true: read-only
    • false: read/write
  • Example normal response
    {
        "users": [
            {
                "name": "rds",
                "readonly": false
            },
            {
                "name": "rds001",
                "readonly": false
            }
        ],
        "total_count": 2
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.