SmartqQueryAbility_Quick BI_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

特别说明:当使用者被授权调用该 API 时,默认使用者有权限通过传入 userId 以该用户身份查询对应的数据

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
quickbi-public:SmartqQueryAbility
Get
全部资源
*

请求参数

字段名称字段详情
UserIdstring

用户 ID。展开详情

示例值:7c7223ae-****-3c744528014b参考取值来源:
    AddUser
    QueryUserList
UserQuestionstring

问题文本。

示例值:今年销售额数据
CubeIdstring

数据集 ID。

示例值:7c7223ae-****-3c744528014b

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:D787E1A3-A************2B05DF8D885
Resultobject

返回结果。

Successboolean

是否成功。

示例值:true

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
Internal.System.Error
An internal system error occurred.诊断
400
Query.Auth.Error
Query is not permitted.诊断
400
Instance.Expired
Your instance has expired.诊断
400
Instance.Not.Exist
The specified instance does not exist.诊断
400
Invalid.Organization
The specified organizational unit does not exist.诊断
400
User.Not.In.Organization
The specified user is not in the organizational unit.诊断
400
Invalid.Parameter
An error occurred while verifying parameters.诊断
400
Invalid.Parameter.Error
The parameter is invalid:%s.诊断
400
Invalid.Param.Error
The parameter is invalid.诊断
400
Invalid.User.Admin
You are not an administrator of this organization.诊断
400
System.Param.Empty
You must specify the %s parameter.诊断
400
Access.Forbidden
Your instance version or access key is not allowed to call the API operation, only professional version supports calling.诊断
400
UserInfo.Error
The personal information is invalid.诊断
400
ApiUser.Not.Exists
The specified user does not exist.诊断
400
User.Not.WorkspaceAdmin
Only administrators of the group workspace can perform this operation.诊断
400
Application.Object.NotExist
The object you are operating does not exist or has been deleted.诊断
400
Not.ApiCall.AuthUser
You are not an administrator or API call auth user of this organization.诊断
400
UserRoleConfig.NotContain.Function
The user %s does not have permission to operate.诊断
400
RobotNl2sql.Moudle.NotPurchase
Please purchase Nl2sql module first.诊断
500
Invalid.User.Organization
The user is not in your organization.诊断

变更历史

变更时间变更内容概要操作
2025-04-14
变更错误码400
变更返回参数
2024-11-26
新增OpenAPI,智能问数查询

相关示例