Querying Database Users

Function

This API is used to query database users for a specified instance. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-users

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	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	String	DB instance ID.
offset	No	Integer	Page number. If offset is set to N, the resource query starts from the N+1 page. The value is 0 by default, indicating that the query starts from the first piece of data in the first page. The value cannot be a negative number. For example, if this parameter is set to 1 and limit is set to 10, only the 11th to 20th records in the 2nd page are displayed.
limit	No	Integer	Number of records displayed on each page. Value range: 1 to 100. Default value: 10.

Request Parameters

None

Response Parameters

**Table 2** Parameter description
Parameter	Type	Description
users	Array of objects	Each element in the list indicates a database user. For details, see Table 3.
total_count	Integer	The total number of database users.

**Table 3** users field data structure description
Parameter	Type	Description
name	String	Username.
attributes	Object	Permission attributes of a user. For details, see Table 4.
memberof	String	Default permissions of a user.

**Table 4** attributes field data structure description
Parameter	Type	Description
rolsuper	Boolean	Whether the user has the administrator permissions. The value can be true or false.
rolinherit	Boolean	Whether the user automatically inherits the permissions of the role to which the user belongs. The value can be true or false.
rolcreaterole	Boolean	Whether the user can create other sub-users. The value can be true or false.
rolcreatedb	Boolean	Whether the user can create a database. The value can be true or false.
rolcanlogin	Boolean	Whether the user can log in to the database. The value can be true or false.
rolconnlimit	Integer	Maximum number of concurrent connections to an instance. The value -1 indicates that there are no limitations on the number of concurrent connections.
rolreplication	Boolean	Whether the user is a replication role. The value can be true or false.
rolbypassrls	Boolean	Whether the user bypasses each row-level security policy. The value can be true or false.

Example Request

Querying database users

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/db-users

Example Response

Database users queried.

{
    "users": [
        {
            "name": "root",
            "attributes": {
                "rolsuper": false,
                "rolinherit": true,
                "rolcreaterole": true,
                "rolcreatedb": true,
                "rolcanlogin": true,
                "rolconnlimit": -1,
                "rolreplication": false,
                "rolbypassrls": false
            },
            "memberof": "{gs_role_copy_files,gs_role_signal_backend,gs_role_tablespace,gs_role_replication,gs_role_account_lock}"
        }
    ],
    "total_count": 1
}