QueryData_Quick BI_API文档

2022-01-01

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

前提条件

您需先通过 Quick BI 的数据服务，创建数据服务的 API，具体请参见：数据服务。

使用限制

数据服务功能仅针对专业版客户开放。
数据服务 API 调用，接口超时时间为 60s，单个 API 的 QPS 为 10 次/秒。
数据服务 API 所引用数据集，如果开启了行级权限，API 调用的时候也会被行级权限策略拦截。

流控信息

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

授权信息

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

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

quickbi-public:QueryData	Get	全部资源 *	无	无

请求参数

字段名称	字段详情
ApiIdstring	数据服务中的 API ID，请参见：数据服务。示例值:f4cc43bc3***
UserIdstring	Quick BI 中的 userId。如何获取 userId，请参见：根据账号查询用户信息接口展开详情示例值:b5d8fd9348cc4327****afb604参考取值来源: AddUser QueryUserList
Conditionsstring	数据服务的查询条件，以 Key 和 Value 的形式传入。map 类型的字符串。其中，Key 为请求参数的参数名，Value 为请求参数的参数值。Key 和 Value 必须成对出现。展开详情示例值:{ "area": ["华东", "华北"], "shopping_date": "2019Q1", }
ReturnFieldsstring	返回参数的参数名列表，List 类型字符串。示例值:["area", "city", "price", "date"]

返回参数

字段名称	字段详情
Successboolean	是否请求成功。取值范围：展开详情示例值:true
RequestIdstring	请求 ID。示例值:a4d1a221d-41za1-****
Resultobject	返回接口执行结果。取值范围：展开详情

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	API.No.Permission	You are not authorized to call the data service API operation.	诊断
400	API.Not.Exist	The data service API operation does not exist.	诊断
400	Cube.Not.Exist	The Cube does not exist.	诊断
400	Invalid.Parameter.Conditions	The specified Conditions is invalid. %s is not defined.	诊断
400	Invalid.Parameter.ReturnFields	The specified returnFields is invalid. %s is not defined.	诊断
400	Missing.Conditions	The specified Conditions is invalid. You must specify %s.	诊断
400	Missing.Dimension.Measure	The dimension or measure %s does not exist in Cube.	诊断
400	Rowlevel.Permission.Forbbiden	The request is denied by row level permission. The dataset is %s, %s %s.	诊断
400	Datasource.Sql.ExecuteFailed	Failed to execute the SQL statement in the data source.	诊断

变更历史

	变更时间	变更内容概要	操作
	2024-10-18	变更错误码400

相关示例