Function

This API is used to query details about database users for a specified DB instance.

• Before calling an API, you need to understand the API in Authentication.
• Before calling this API, obtain the required region and endpoint.

Constraints

Databases cannot be created when the DB instance is in any of the following statuses: creating, changing instance class, changing port, frozen, or abnormal.

URI

• URI format

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

• Example

  https://rds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/db_user/detail?page=1&limit=10

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.
  attributes	Object	Indicates permission attributes of a user. For details, see Table 4.
  memberof	Array of strings	Indicates default rights of a user.

  Table 4 attributes element structure description

  Name	Type	Description
  rolsuper	Boolean	Indicates whether a user has the super user permission. The value can be true or false.
  rolinherit	Boolean	Indicates whether a user automatically inherits the permissions of the role to which the user belongs. The value can be true or false.
  rolcreaterole	Boolean	Indicates whether a user can create other sub-users. The value can be true or false.
  rolcreatedb	Boolean	Indicates whether a user can create a database. The value can be true or false.
  rolcanlogin	Boolean	Indicates whether a user can log in to the database. The value can be true or false.
  rolconnlimit	Integer	Indicates the maximum number of concurrent connections to a DB instance. The value -1 indicates that there are no limitations on the number of concurrent connections.
  rolreplication	Boolean	Indicates whether the user is a replication role. The value can be true or false.
  rolbypassrls	Boolean	Indicates whether a user bypasses each row-level security policy. The value can be true or false.

• Example normal response

  {
  "users": [
  {
    "name": "rdsuser",
    "attributes": {
      "rolsuper": false,
      "rolinherit": true,
      "rolcreaterole": true,
      "rolcreatedb": true,
      "rolcanlogin": true,
      "rolconnlimit": -1,
      "rolreplication": true,
      "rolbypassrls": false
     },
    "memberof": ["pg_monitor", "pg_read_all_stats", "pg_stat_scan_tables", "pg_signal_backend"]
  }, 
  {
    "name": "rdsuser1",
    "attributes": {
      "rolsuper": false,
      "rolinherit": true,
      "rolcreaterole": true,
      "rolcreatedb": true,
      "rolcanlogin": true,
      "rolconnlimit": -1,
      "rolreplication": true,
      "rolbypassrls": false
  },
    "memberof": []
  }],
  "total_count": 2
  }

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.