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 https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/db-role

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. For details about how to obtain the value, see Obtaining a Project ID. Restrictions: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None
instance_id	Yes	String	Explanation: Instance ID, which is the unique identifier of an instance. Restrictions: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None
offset	No	Integer	Explanation: Offset. 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. Restrictions: None Value range: [0, 2^31-1] Default value: 0 (indicating that the query starts from the first data record.)
limit	No	Integer	Explanation: Number of records displayed per page. Restrictions: None Value range: [1, 100] Default value: 10

Request Parameters

None

Response Parameters

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

**Table 3** roles field data structure description
Parameter	Type	Description
name	String	Explanation: User or role name. Value range: None
attribute	Object	Explanation: Permission attribute of the user or role. For details, see Table 4.
memberof	String	Explanation: Default permission of the user or role. Value range: None
lock_status	Boolean	Explanation: Whether the user or role is locked. Value range: true or false

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

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
}