Updated on 2024-06-07 GMT+08:00

Querying Database Users

Function

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

  • 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 or frozen state.
  • The database user list of read replicas cannot be queried.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/db_user/detail?page={page}&limit={limit}

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    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.

    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/a8abe84a41364097be7c233c39275087in04/db_user/detail?page=1&limit=10

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.

    state

    String

    Indicates the database user status.

    • unavailable: The database user is unavailable.
    • available: The database user is available.
  • Example normal response
    {
     "users": [
        {
         "name": "rdsuser",
         "state": "available"
        },
       {
        "name": "login001",
        "state": "available"
        }
     ],
     "total_count": 2
     }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.