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

Querying Database Users of a DB Instance (Discarded)

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

  • Databases cannot be queried when the DB instance is in the abnormal or frozen state.
  • The database list of read replicas cannot be queried.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/db_user

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

Request

  • Request parameters

    None

  • URI example

    GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/db_user

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.

    Table 3 users element structure description

    Name

    Type

    Description

    name

    String

    Account name.

    databases

    Array of objects

    Each element in the list indicates a database associated with the account.

    For details, see Table 4.

    Table 4 databases element structure description

    Name

    Type

    Description

    name

    String

    Indicates a database name.

    readonly

    Boolean

    Indicates the read-only permission.

    • true: indicates the read-only permission.
    • false: indicates the read and write permission.
  • Example normal response
    {
        "users": [
            {
                "name": "rds",
                "comment": "user comment",
                "databases": [
                    {
                        "name": "rds-test",
                        "readonly": false
                    }
                ]
            },
            {
                "name": "rds001",
                "comment": "user comment",
                "databases": null
            }
        ]
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.