文档首页/ 数据湖探索 DLI/ API参考（吉隆坡区域）/ 权限相关API/ 队列赋权
更新时间：2022-12-07 GMT+08:00
查看PDF
分享

队列赋权

功能介绍

该API用于与其他用户共享指定的队列，可以给用户赋使用指定的队列的权限或者收回使用权限。

URI

  • URI格式：

    PUT /v1.0/{project_id}/queues/user-authorization

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    是

    String

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

请求消息

表2 请求参数

参数名称

是否必选

参数类型

说明

queue_name

是

String

队列名称。

user_name

是

String

被赋权用户名称。给该用户赋使用队列的权限，回收其使用权限，或者更新其使用权限。

action

是

String

指定赋权或回收。值为：grant，revoke或update。当用户同时拥有grant和revoke权限的时候才有权限使用update操作。

  • grant：赋权。
  • revoke：回收权限。
  • update：清空原来的所有权限，赋予本次提供的权限数组中的权限。

privileges

是

Array of Strings

待赋权、回收或更新的权限列表。可操作的权限可以是以下权限中的一种或多种。

  • SUBMIT_JOB：提交作业
  • CANCEL_JOB ：取消作业
  • DROP_QUEUE ：删除队列
  • GRANT_PRIVILEGE： 赋权
  • REVOKE_PRIVILEGE：权限回收
  • SHOW_PRIVILEGE：查看其它用户具备的权限
  • RESTART：重启队列
  • SCALE_QUEUE：规格变更
    说明：

    若需更新的权限列表为空，则表示回收用户在该队列的所有权限。

响应消息

表3 响应参数

参数名称

是否必选

参数类型

说明

is_success

否

Boolean

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

message

否

String

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

请求示例

{
    "queue_name": "queue1",
    "user_name": "tenant2",
    "action": "grant",
    "privileges" : ["DROP_QUEUE", "SUBMIT_JOB"]
}

响应示例

{
  "is_success": true,
  "message": ""
}

状态码

状态码如表4所示。

表4 状态码

状态码

描述

200

授权成功。

400

请求错误。

500

内部服务器错误。

错误码

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

父主题： 权限相关API