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.

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/instances/{instance_id}/db-users

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. For details about how to obtain the instance ID, see Querying DB Instances. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A
offset	No	Integer	Definition Offset for pagination. The query starts from the next piece of data indexed by this parameter. For example, if this parameter is set to 1 and limit is set to 10, only the 11th to 20th data records are displayed. Constraints N/A Range [0, 2147483647] Default Value 0: The query starts from the first data record.
limit	No	Integer	Definition Number of records displayed per page. Constraints N/A Range [1, 100] Default Value 10

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. After a response is returned, the value of X-Subject-Token in the response header is the token. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn: Chinese en-us: English Default Value en-us

Response Parameters

**Table 3** Parameter description
Parameter	Type	Description
users	Array of objects	Definition Each element in the list indicates a database user. For details, see Table 4.
total_count	Integer	Definition Total number of database users. Range [0,2147483647], depending on the actual query size.

**Table 4** users field data structure description
Parameter	Type	Description
name	String	Definition Username. Range N/A
attribute	Object	Definition Permission attributes of a user. For details, see Table 5.
memberof	String	Definition Default permissions of a user. Range N/A
lock_status	Boolean	Definition Whether the user is locked. Range true: The user is locked. false: The user is not locked.

**Table 5** attribute field data structure description
Parameter	Type	Description
rolsuper	Boolean	Definition Check whether the user has the administrator permissions. Range true: The user has the administrator permissions. false: The user does not have the administrator permissions.
rolinherit	Boolean	Definition Whether the user automatically inherits permissions of roles to which the user belongs. Range true: The user automatically inherits the permissions of the role that the user belongs to. false: The user does not automatically inherit the permissions of the role that the user belongs to.
rolcreaterole	Boolean	Definition Whether the user can create other sub-users. Range true: The user can create other sub-users. false: The user cannot create other sub-users.
rolcreatedb	Boolean	Definition Whether the user has the permissions to create databases. Range true: The user can create databases. false: The user cannot create databases.
rolcanlogin	Boolean	Definition Whether the user has the permissions to log in to a database. Range true: The user has the permissions to log in to a database. false: The user does not have the permissions to log in to a database.
rolconnlimit	Integer	Definition Maximum number of concurrent connections to an instance. The value -1 indicates that there are no limitations on the number of concurrent connections. Range N/A
rolreplication	Boolean	Definition Whether the user is a replication role. Range true: The user is a replication role. false: The user is not a replication role.
rolbypassrls	Boolean	Definition Whether the user bypasses each row-level security policy. Range true: The user bypasses each row-level security policy. false: The user does not bypass each row-level security policy.
rolpassworddeadline	String	Definition Password expiration time. Range N/A

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",
            "attribute": {
                "rolsuper": false,
                "rolinherit": true,
                "rolcreaterole": true,
                "rolcreatedb": true,
                "rolcanlogin": true,
                "rolconnlimit": -1,
                "rolreplication": false,
                "rolbypassrls": false,
                "rolpassworddeadline": ""
            },
            "memberof": "{gs_role_copy_files,gs_role_signal_backend,gs_role_tablespace,gs_role_replication,gs_role_account_lock}",
            "lock_status": false
        }
    ],
    "total_count": 1
}