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.
  • Authorized users of a specified database for 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

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    db-name

    Yes

    Definition

    Specifies the database name.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    page

    Yes

    Definition

    Page number.

    Constraints

    N/A

    Range

    The value is a positive integer starting from 1.

    Default Value

    N/A

    limit

    Yes

    Definition

    Number of records on each page.

    Constraints

    N/A

    Range

    The value is a positive integer ranging from 1 to 100.

    Default Value

    N/A

Request

  • Request parameters

    None

  • URI example

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

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    users

    Array of objects

    Definition

    Each element in the list indicates a database account.

    For details, see Table 3.

    total_count

    Integer

    Definition

    Indicates the total number of database users.

    Range

    N/A

    Table 3 users element structure description

    Parameter

    Type

    Description

    name

    String

    Definition

    Account name.

    Range

    N/A

  • Example normal response
    {
        "users": [
            {
                "name": "rds"
    
            },
            {
                "name": "rds001"
    
            }
        ],
        "total_count": 3
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.