Updated on 2024-04-11 GMT+08:00

Querying Authorized Users of a Specified Database

Function

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

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

  • Example

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

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

    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

None

Response

  • Normal response
    Table 2 Parameter description

    Name

    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

    Name

    Type

    Description

    name

    String

    Indicates the account 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
    {
        "users": [
            {
                "name": "rds",
                "readonly": false
            },
            {
                "name": "rds001",
                "readonly": false
            }
        ],
        "total_count": 3
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.