更新时间:2022-04-16 GMT+08:00
分享

查看队列的使用者

功能介绍

该API用于查询可以使用的指定队列的所有用户名称。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式:

    GET /v1.0/{project_id}/queues/{queue_name}/users

  • 参数说明
    表1 URI 参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

    queue_name

    String

    队列名称。

    表2 query参数

    参数名称

    是否必选

    参数类型

    说明

    limit

    Integer

    分页查询数量。

    offset

    Integer

    分页查询偏移量。

请求消息

无请求参数。

响应消息

表3 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息可能为空。

queue_name

String

队列名称。

privileges

Array of Object

有权限使用该队列的用户及其对应的权限数组。

具体参数请参考表4。。

表4 privileges参数

参数名称

是否必选

参数类型

说明

is_admin

Boolean

判断用户是否为管理员。

user_name

String

用户名称,即该用户在当前数据库上有权限。

privileges

Array of Strings

该用户在数据库上的权限。

示例

  • 请求样例:
    None
  • 成功响应样例:
    {
      "is_success": true,
      "message": "",
      "privileges": [
        {
          "is_admin": true,
          "privileges": [
            "ALL"
          ],
          "user_name": "tenant1"
        },
        {
          "is_admin": false,
          "privileges": [
            "SUBMIT_JOB"
          ],
          "user_name": "user2"
        }
      ],
      "queue_name": "queue1"
    }

状态码

状态码如表5所示。

表5 状态码

状态码

描述

200

授权成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

分享:

    相关文档

    相关产品

关闭导读