SmartqAuthorize - 批量管理小Q问数的授权

批量管理小Q问数的授权。

接口说明

用于批量管理智能问数的授权,重复新增授权会视为新增操作;重复删除授权会默认跳过,也不会记录审计日志。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quickbi-public:SmartqAuthorize

update

*全部资源

*

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

OperationType

integer

操作类型。取值如下:

  • 0:新增授权

  • 1:删除授权

枚举值:

  • 0 :

    新增授权

  • 1 :

    删除授权

0

UserIds

string

用户 ID 数组,以英文逗号分隔。

重要 单次请求的用户 id 数 * (问数资源数 + 分析主题数)不能大于 100。

wasdasd*******1235235sd,ASDAS*********ASDAW123

LlmCubes

string

问数资源 ID 数组,以英文逗号分隔。

wasdasd*******1235235sd,ASDAS*********ASDAW123

LlmCubeThemes

string

分析主题 ID 数组,以英文逗号分隔。

wasdasd*******1235235sd,ASDAS*********ASDAW123

ExpireDay

string

过期时间,默认七天。 格式:2099-12-31

2099-12-31

CubeIds

string

数据集 ID 数组,以英文逗号分隔。

重要 该参数会转换为对应的问数资源 ID 进行授权,所以当传入的 cubeId 不存在对应的问数资源时,会报错问数资源不存在,请确保 cubeId 正确性

wasdasd*******1235235sd,ASDAS*********ASDAW123

返回参数

名称

类型

描述

示例值

object

返回结果。

RequestId

string

请求 ID。

617277C****************ABA47E31

Result

array<object>

失败的用户信息数组。

object

失败的用户信息。

UserId

string

用户 ID。

617277C****************ABA47E31

LlmCube

string

问数资源 ID。

617277C****************ABA47E31

LlmCubeTheme

string

分析主题 ID。

617277C****************ABA47E31

DetailMessage

string

失败原因。

INVALID_FILE_FORMAT

Success

boolean

是否请求成功。取值范围:

  • true:请求成功

  • false:请求失败

true

示例

正常返回示例

JSON格式

{
  "RequestId": "617277C****************ABA47E31",
  "Result": [
    {
      "UserId": "617277C****************ABA47E31",
      "LlmCube": "617277C****************ABA47E31",
      "LlmCubeTheme": "617277C****************ABA47E31",
      "DetailMessage": "INVALID_FILE_FORMAT"
    }
  ],
  "Success": true
}

错误码

HTTP status code

错误码

错误信息

描述

400 Internal.System.Error An internal system error occurred. 系统内部异常。
400 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。
400 Date.Format.Error Date format conversion error. 日期格式转换错误
400 Date.Exceed.Error The start date must be within 90 days from the current date. 开始日期不能早于当前日期90
400 UserRoleConfig.NotContain.Function The user %s does not have permission to operate. 此用户%s没有权限操作。
400 User.Not.In.Organization The specified user is not in the organizational unit. 该用户不在组织中。
400 Query.Auth.Error Query is not permitted. 没有查询权限。
400 ApiUser.Not.Exists The specified user does not exist. 用户不存在。
400 Share.ExpireDate.Error The expire date is illegal. 设置的过期时间不合法。
400 RobotNl2sql.Moudle.NotPurchase Please purchase Nl2sql module first. 请先购买智能问数模块。
400 API.Not.Exist The data service API operation does not exist. 数据服务 API 不存在。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情