文档

API概览

更新时间:
本产品(Quick BI/2022-01-01)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

组织管理

API标题API概述
组织用户管理组织用户管理
AddUser添加组织成员添加组织成员。
BatchAddFeishuUsers批量添加飞书用户批量添加飞书用户。
DeleteUser删除组织用户删除指定组织用户。
UpdateUser更新组织成员信息更新组织下指定成员的信息。
QueryUserList查询组织成员列表信息查询组织成员列表信息。
QueryUserInfoByUserId根据用户ID查询用户信息根据用户ID查询用户信息。
QueryUserInfoByAccount根据账号查询用户信息根据阿里云ID或阿里云账户名查询用户信息。
组织用户组管理组织用户组管理
CreateUserGroup新建用户组新建用户组,可以指定父用户组。
AddUserGroupMember添加成员到用户组将组织成员添加到指定的用户组。
AddUserGroupMembers批量添加成员到用户组将用户批量添加到指定的用户组中。
DeleteUserGroup删除用户组删除组织内的用户组。
DeleteUserGroupMember删除用户组成员删除指定用户组下的指定成员。
DeleteUserGroupMembers用户批量退出用户组指定用户批量退出用户组。
WithdrawAllUserGroups用户退出所有用户组使用户退出所有用户组,该过程不可逆,请谨慎操作。
UpdateUserGroup更新用户组信息更新组织下指定用户组的信息。
GetUserGroupInfo根据关键字获取用户组信息根据用户组名称关键字搜索用户组信息。
ListByUserGroupId批量查询用户组根据用户组ID批量查询用户组信息。
ListUserGroupsByUserId查询用户所属的用户组信息列表根据用户的UserID,查询该用户所属的所有用户组信息。
QueryUserGroupListByParentId查询父用户组下的子用户组列表获取指定父用户组下的子用户组信息。
QueryUserGroupMember查询用户组成员列表获取用户组下的成员列表信息。
用户标签管理用户标签管理
AddUserTagMeta新增组织成员标签元信息新增组织成员标签元信息。
DeleteUserTagMeta删除组织成员标签元信息删除组织成员的标签元信息。
UpdateUserTagValue更新组织成员标签值更新组织成员标签值。
QueryUserTagMetaList查询组织成员标签元信息列表查询组织内成员标签元信息列表。
QueryUserTagValueList查询组织成员标签值列表查询特定用户标签值列表。
UpdateUserTagMeta更新组织成员标签元信息用于更新组织成员标签元信息。
角色管理角色管理
ListWorkspaceRoleUsers获取指定空间角色下的用户列表获取指定空间角色下的用户列表。
QueryWorkspaceRoleConfig获取指定空间角色的配置信息获取指定空间角色的配置。
QueryOrganizationRoleConfig获取指定组织角色的配置信息获取指定组织角色的配置
ListWorkspaceRoles获取空间角色列表获取空间角色列表。
ListOrganizationRoles获取组织角色列表获取组织角色列表。
ListOrganizationRoleUsers获取指定组织角色下的用户列表获取指定组织角色下的用户列表。

权限管理

API标题API概述
报表分享授权管理报表分享授权管理
AddShareReport添加数据作品分享配置添加数据作品的一个分享配置。
CancelReportShare删除数据作品的分享授权删除数据作品的一个分享授权。
QuerySharesToUserList查询授权给用户的作品列表查询授权给用户的作品列表。
QueryShareList查询作品的分享记录查询作品被分享给哪些对象的列表,只返回仍然在有效期限内的分享配置。
数据门户菜单授权管理数据门户菜单授权管理
AuthorizeMenu数据门户菜单批量授权数据门户菜单的批量授权,已经授权的会自动略过。
CancelAuthorizationMenu批量取消数据门户菜单授权根据门户菜单ID,取消指定用户、用户组的授权记录。
ChangeVisibilityModel修改数据门户菜单的可见方式修改数据门户菜单的可见方式,是否仅授权可见。
ListPortalMenus获取数据门户菜单列表获取具体数据门户下的分层菜单列表。
ListPortalMenuAuthorization获取数据门户菜单的授权详情获取数据门户菜单的授权详情列表。
行级权限管理行级权限管理
SetDataLevelPermissionRuleConfig设置单条数据集行列权限配置信息设置单条数据集行列权限配置信息(新增和更新)。
AddDataLevelPermissionRuleUsers添加行列权限规则人群针对单条行列权限规则增量添加选定的人群。
AddDataLevelPermissionWhiteList增量修改行列权限白名单修改指定数据集行列权限的白名单。
DeleteDataLevelRuleConfig删除行列权限规则删除单条行列权限规则。
DeleteDataLevelPermissionRuleUsers删除行列规则的人群针对单条行列权限规则删除选定的人群。
UpdateDataLevelPermissionStatus更新数据集行列权限开关状态更新数据集行列权限开关状态。
SetDataLevelPermissionExtraConfig设置行列权限额外配置设置行列权限的额外配置。
SetDataLevelPermissionWhiteList设置行级权限白名单设置指定行级权限的白名单列表。
QueryDatasetSwitchInfo获取数据集行级权限开关状态获取指定数据集的行级权限开关状态。
ListCubeDataLevelPermissionConfig获取数据集行列权限配置列表获取指定数据集的行列权限配置列表。
ListDataLevelPermissionWhiteList获取数据集行列权限白名单列表根据行列权限种类,获取数据集行列权限的白名单列表。
开放审批开放审批
QueryApprovalInfo根据审批人获取相应的审批流信息根据审批人获取相应的审批流信息。
ResultCallback自定义审批流回调接口自定义审批流回调接口,用户自行对Quick BI的审批流进行处理。

资源管理

API标题API概述
报表资源管理报表资源管理
UpdateEmbeddedStatus更改报表的嵌入状态更改报表的嵌入状态,开通嵌入、或者关闭嵌入。
QueryWorksByOrganization查询组织下的所有作品查询整个组织下的所有作品,可指定作品类型。
QueryWorksByWorkspace查询工作空间下的所有作品查询组织下某个工作空间下的所有作品,可指定作品类型。
QueryReadableResourcesListByUserId查询用户有权查看的作品列表查询用户有权查看的作品列表,包含空间下与分享授权的报表。
CheckReadable查询用户对数据作品的查看权限查询用户对数据作品(仪表板、电子表格等)是否有权限查看。
QueryEmbeddedInfo获取组织嵌入配置获取组织下的嵌入配置,包括最大嵌入数和已经嵌入数等。
QueryEmbeddedStatus查询报表嵌入状态查询某个报表是否已经开通嵌入。
QueryWorks查询数据作品信息查询指定数据作品信息。
QueryWorksBloodRelationship查询数据作品的血缘信息获取数据作品的血缘关系,包括各组件引用的数据集以及查询字段信息。目前仅支持的数据作品包含仪表板、电子表格、自助取数。
QueryComponentPerformance查询组件性能日志查询组件性能日志。
QueryReportPerformance查询报表性能日志查询报表性能日志。
数据集资源管理数据集资源管理
DataSetBlood查询引用指定数据集下的作品信息查询引用指定数据集下的作品信息。
DataSourceBlood查询引用指定数据源下的数据集信息查询引用指定数据源下的数据集信息。
ModifyApiDatasourceParameters修改API数据源配置修改指定API数据源的配置。
ListApiDatasource查询API数据源列表查询API数据源列表。
QueryDatasetInfo查询数据集信息查询指定数据集的信息。
QueryDatasetDetailInfo查询数据集详情查询指定数据集的详情,包括所属数据源、目录、以及数据集模型。
QueryDatasetList查询工作空间数据集列表查询指定工作空间的数据集列表,按照创建时间倒序排列。
AllotDatasetAccelerationTask触发数据集抽取加速触发数据集Quick引擎的采集加速。
QueryCubePerformance查询数据集性能日志查询数据集性能日志。
QueryCubeOptimization查询数据集优化建议查询数据集优化建议。
工作空间管理工作空间管理
AddUserToWorkspace添加成员到工作空间添加成员到指定工作空间。
AddWorkspaceUsers批量添加成员到工作空间批量添加成员到工作空间。
DeleteUserFromWorkspace删除工作空间成员删除指定工作空间的成员。
UpdateWorkspaceUsersRole批量更新工作空间成员的角色批量更新工作空间成员的角色信息,已有角色会被覆盖。
UpdateWorkspaceUserRole修改工作空间成员角色修改工作空间下指定成员的角色,已有的角色会被覆盖。
QueryWorkspaceUserList查询工作空间下的成员列表查询指定工作空间下的成员列表信息。
QueryOrganizationWorkspaceList获取组织下的工作空间列表获取当前组织下的工作空间列表信息。
QueryUserRoleInfoInWorkspace查询工作空间成员的预置角色获取指定工作空间成员的预置空间角色信息。
收藏管理收藏管理
SaveFavorites添加作品收藏添加用户的收藏数据作品。
CancelCollection取消作品收藏取消用户收藏的数据作品。
ListCollections获取用户收藏作品列表获取用户收藏的作品列表。
首页管理首页管理
ListFavoriteReports首页看板收藏列表获取指定用户在首页看板中展示的收藏作品列表。
ListRecentViewReports获取首页看板常看和足迹列表获取指定用户在首页看板中展示的常看和足迹列表。
ListSharedReports获取首页看板被授权的作品列表获取指定用户在首页看板中展示的被授权的作品列表。

数据管理

API标题API概述
数据服务数据服务
QueryDataServiceList数据服务列表API查询数据服务API列表。
QueryDataService调用数据服务API对数据服务中已创建的API进行调用。

嵌入分析

API标题API概述
智能问数模块嵌入智能问数模块嵌入
CreateTicket4Copilot生成智能小Q嵌入Ticket用于生成智能小Q嵌入Ticket。
报表嵌入报表嵌入
CreateTicket生成报表嵌入ticket生成报表嵌入需要使用的ticket。
DeleteTicket删除嵌入ticket删除免登嵌入报表的指定ticket。
DelayTicketExpireTime更新嵌入ticket的失效时间更新嵌入报表的ticket的失效时间。
UpdateTicketNum更新嵌入ticket票据数量对用于免登嵌入报表的指定的ticket进行更新票据数量操作。
QueryTicketInfo查询嵌入报表ticket详情获取免登嵌入报表的指定ticket的详情信息。

统计分析

API标题API概述
资源分析资源分析
QueryAuditLog查询审计日志信息查询审计日志信息。