Help Center/ Data Lake Insight/ API Reference (Kuala Lumpur Region)/ Permission-related APIs/ Querying Database Users
Updated on 2022-12-07 GMT+08:00
View PDF
Share

Querying Database Users

Function

This API is used query names of all users who have permission to use or access the database.

URI

  • URI format

    GET /v1.0/{project_id}/databases/{database_name}/users

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

    database_name

    Yes

    Name of the database to be queried.

Request

None

Response

Table 2 Response parameters

Parameter

Mandatory

Type

Description

is_success

No

Boolean

Whether the request is successfully executed. Value true indicates that the request is successfully executed.

message

No

String

System prompt. If execution succeeds, the parameter setting may be left blank.

database_name

No

String

Name of the database to be queried.

privileges

No

Array of objects

Permission information. For details, see Table 3.
Table 3 privileges parameters

Parameter

Mandatory

Type

Description

is_admin

No

Boolean

Whether the database user is an administrator.

user_name

No

String

Name of the user who has permission on the current database.

privileges

No

Array of Strings

Permission of the user on the database.

Example Request

None

Example Response

{
  "is_success": true,
  "message": "",
  "database_name": "dsstest",
  "privileges": [
    {
      "is_admin": true,
      "privileges": [
        "ALL"
      ],
      "user_name": "test"
    },
    {
      "is_admin": false,
      "privileges": [
        "ALTER_TABLE_ADD_PARTITION"
      ],
      "user_name": "scuser1"
    },
    {
      "is_admin": false,
      "privileges": [
        "CREATE_TABLE"
      ],
      "user_name": "scuser2"
    }
  ]
}

If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.

Parent topic: Permission-related APIs