本文为您介绍Quick BI提供的API接口。

重要
  • 仅Quick BI公共云用户支持调用API接口,金融云和政务云用户暂不支持。
  • 仅专业版及以上版本开放API接口调用权限。
一级分类二级分类Version版本API名称API描述QPS(次/秒)超时时间(秒)
组织管理组织用户管理2020-08-01AddUser添加组织成员。5010
UpdateUser更新组织下指定成员的信息。5010
QueryUserList获取组织成员列表信息。3010
DeleteUser删除指定组织用户。5010
QueryUserInfoByUserId根据用户ID查询组织成员信息。3010
QueryUserInfoByAccount根据阿里云账号ID或阿里云账号名称查询组织成员信息。3010
用户标签管理2020-08-02AddUserTagMeta新增组织成员标签元信息。5010
DeleteUserTagMeta删除组织成员标签元信息。5010
QueryUserTagMetaList查询组织内成员标签元信息。3010
UpdateUserTagValue更改组织成员的标签值。5010
QueryUserTagValueList查询特定用户的标签值。3010
UpdateUserTagMeta更新组织成员标签元信息。5010
组织用户组管理2020-07-31AddUserGroupMember添加组织成员到指定用户组。5010
AddUserGroupMembers批量添加用户至指定用户组。5010
DeleteUserGroupMember删除指定用户组下的指定成员。5010
CreateUserGroup在指定组织中新建用户组。5010
DeleteUserGroup删除指定组织的用户组。5010
UpdateUserGroup更新组织下指定用户组的信息。5010
QueryUserGroupMember获取组织用户组成员列表信息。3010
QueryUserGroupListByParentId获取指定父用户组下的子用户组信息。3010
GetUserGroupInfo搜索用户组关键字。3010
ListUserGroupsByUserId查询用户所属用户组列表。3010
WithdrawAllUserGroups使用户退出所有用户组。5010
DeleteUserGroupMembers用户批量退出用户组。5010
ListByUserGroupId根据用户组ID批量查询用户组信息。5010
权限管理报表分享授权管理2020-08-04QueryShareList获取授权列表信息。3010
AddShareReport为报表添加授权策略。5010
QuerySharesToUserList获取授权给用户的作品列表。3010
CancelReportShare删除该报表的授权策略。5010
数据门户菜单授权管理2020-08-08ListPortalMenus获取门户菜单列表。3010
ListPortalMenuAuthorization获取门户菜单的授权列表。3010
AuthorizeMenu批量新增数据门户菜单授权。5010
CancelAuthorizationMenu批量取消数据门户菜单授权。5010
ChangeVisibilityModel修改数据门户菜单是否仅授权可见。5010
行级权限管理2020-11-11QueryDatasetSwitchInfo获取数据集行级权限开关状态。3010
UpdateDataLevelPermissionStatus开启/关闭数据集行列权限。5010
ListCubeDataLevelPermissionConfig获取数据集行列权限配置信息。3010
SetDataLevelPermissionRuleConfig设置单条数据集行列权限配置信息。5010
DeleteDataLevelRuleConfig删除数据集行列权限单条规则配置信息。5010
AddDataLevelPermissionRuleUsers针对单条规则增量添加行级权限对应的人群。5010
DeleteDataLevelPermissionRuleUsers针对单条规则删除行级权限对应的人群。5010
SetDataLevelPermissionExtraConfig针对行级或列级权限做额外配置。5010
ListDataLevelPermissionWhiteList获取数据集的行列权限白名单列表。3010
SetDataLevelPermissionWhiteList全量设置行列权限白名单。5010
AddDataLevelPermissionWhiteList增量设置行列权限白名单。5010
资源管理工作空间管理2020-08-03UpdateWorkspaceUserRole更改空间成员角色。5010
QueryWorkspaceUserList获取指定工作空间下的成员列表信息。3010
DeleteUserFromWorkspace删除指定工作空间的成员。5010
QueryOrganizationWorkspaceList获取当前组织下的工作空间列表信息。3010
AddUserToWorkspace在指定的工作空间添加单个成员。5010
AddWorkspaceUsers在指定的工作空间添加多个成员。5010
QueryUserRoleInfoInWorkspace获取指定工作空间下成员角色信息。3010
UpdateWorkspaceUsersRole批量更新工作空间成员的角色信息。5010
报表资源管理2020-08-07QueryWorksByOrganization获取该组织下的报表列表信息。3010
QueryWorksByWorkspace获取该组织中指定空间下的报表列表信息。3010
QueryReadableResourcesListByUserId获取用户有权限查看的报表列表信息。3010
CheckReadable校验用户是否有权限查看报表。5010
QueryEmbeddedInfo获取组织下报表嵌入信息。3010
UpdateEmbeddedStatus更改报表的嵌入状态。5010
QueryWorks查询报表的相关信息。3010
QueryWorksBloodRelationship查询指定报表的血缘信息。3010
数据集资源管理2020-08-06QueryDatasetList获取指定工作空间的数据集列表信息。3010
QueryDatasetDetailInfo获取指定数据集的详情。3010
QueryDatasetInfo获取数据集详情。3010
收藏管理2020-08-09ListCollections获取收藏列表。3010
SaveFavorites添加收藏。5010
CancelCollection取消收藏。5010
首页管理2020-08-09ListSharedReports获取指定用户首页我的看板的授权作品列表。3010
ListFavoriteReports获取指定用户首页我的看板的收藏作品列表。3010
ListRecentViewReports获取指定用户首页我的看板的最近浏览或常看作品列表。3010
数据管理数据服务2020-07-30QueryDataService调用在数据服务中已创建的API。1060
嵌入分析Token机制2021-03-25CreateEmbedToken生成用于报表嵌入的token接口。5010
QueryEmbedTokenInfo获取用户报表嵌入的Token详情。3010
DelayEmbedToken对用于报表嵌入的Token进行续期。5010
DeleteEmbedToken删除指定的Token。5010
Ticket机制(安全增强方案)2021-03-25CreateTicket生成Ticket三方嵌入时的票据Ticket信息。5010
QueryTicketInfo获取用户嵌入报表的Ticket详情。3010
DeleteTicket删除用户嵌入报表的Ticket。5010
DelayTicketExpireTime更新嵌入报表的Ticket的失效时间。5010
UpdateTicketNum更新嵌入报表的Ticket票据数量。5010

接口调用说明

仅专业版及以上版本开放API接口调用权限。

查看SDK版本

pom.xml文件中version的值以SDK获取地址中的最新版本为准。

您可以通过https://mvnrepository.com/artifact/com.aliyun/aliyun-java-sdk-quickbi-public查看SDK的版本。

如何限制并发的请求QPS不超过限流阈值?

问题描述:由于性能和安全的问题,公共云环境上Quick BI已经开放的API,默认都带有限流配置,在使用并发线程调用Quick BI开放API时,若实际并发请求的QPS超过限流阈值,则接口请求失败。

解决方案:推荐您使用Google的Guava工具组件中的RateLimiter类,进行接口请求的QPS限制。
  1. 如果您使用Maven管理Java项目,可以通过在pom.xml文件中添加Maven依赖。
    <dependency>
        <groupId>com.google.guava</groupId>
        <artifactId>guava</artifactId>
        <version>${google.guava.version}</version>
    </dependency>
    说明 pom.xml文件中version的值以获取地址中的最新版本为准,最新版本请参见Guava: Google Core Libraries For Java
  2. 创建和使用RateLimiter。
    可以使用create()工厂方法创建RateLimiter实例,具体请参见https://www.baeldung.com/guava-rate-limiter
    // 创建一个30 QPS的流控RateLimiter。
    RateLimiter rateLimiter = RateLimiter.create(30);
    // 获取许可,如果QPS超过30,则阻塞等待。
    rateLimiter.acquire();
    // 获得许可,才会进行接口请求。
    doSomeAPIRequest();
说明 QPS(Query Per Second)是指,每秒钟请求或任务的数量。

并发数是指,系统同时处理的请求或任务的数量。

QPS=并发数/平均响应时间。