Querying Database Roles

Function

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

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

URI

GET /v3.1/{project_id}/instances/{instance_id}/db-role

**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. 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,2^31-1] 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

None

Response Parameters

**Table 2** Parameter description
Parameter	Type	Description
roles	Array of objects	Definition Each element in the list indicates a database user or role. For details, see Table 3.
total_count	Integer	Definition Total number of records. Range [0, 2^31 – 1]

**Table 3** roles field data structure description
Parameter	Type	Description
name	String	Definition User or role name. Range N/A
attribute	Object	Definition Permission attribute of the user or role. For details, see Table 4.
memberof	String	Definition Default permission of the user or role. Range N/A
lock_status	Boolean	Definition Whether the user or role is locked. Range true or false

**Table 4** attribute field data structure description
Parameter	Type	Description
rolsuper	Boolean	Definition Whether the user or role has the administrator permissions. Range true or false
rolinherit	Boolean	Definition Whether the user or role automatically inherits permissions of roles to which the user belongs. Range true or false
rolcreaterole	Boolean	Definition Whether the user or role can create other sub-users. Range true or false
rolcreatedb	Boolean	Definition Whether the user or role has the permissions to create databases. Range true or false
rolcanlogin	Boolean	Definition Whether the user or role has the permissions to log in to a database. Range true or false
rolconnlimit	Integer	Definition Maximum number of concurrent connections for a user or role 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 or role is a replication role. Range true or false
rolbypassrls	Boolean	Definition Whether the user or role bypasses each row-level security policy. Range true or false
rolpassworddeadline	String	Definition Password expiration time of the user or role. Range N/A

Example Request

Querying database roles

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

Example Response

Database roles queried.

{
    "roles": [
        {
            "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
}