本产品(
Quick BI/2022-01-01
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。在使用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 | 查询报表性能日志 | 查询报表性能日志。 |
GetWorksEmbedList | 获取已经嵌入的报表 | 查询已嵌入报表列表。 |
数据集资源管理 | 数据集资源管理 | |
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 | 获取首页看板被授权的作品列表 | 获取指定用户在首页看板中展示的被授权的作品列表。 |
订阅管理 | 订阅管理 | |
ManualRunMailTask | 手动执行邮件任务 | 手动执行订阅的邮件任务。 |
GetMailTaskStatus | 查看邮件任务运行状态 | 查看组织内邮件任务运行状态(实时状态非最终状态)。 |
数据管理
API | 标题 | API概述 |
---|---|---|
数据服务 | 数据服务 | |
QueryData | 查询数据 | 对数据服务中已创建的API进行调用。 |
QueryDataServiceList | 数据服务列表API | 查询数据服务API列表。 |
QueryDataService | 调用数据服务API | 对数据服务中已创建的API进行调用。 |
嵌入分析
API | 标题 | API概述 |
---|---|---|
报表嵌入 | 报表嵌入 | |
CreateTicket | 生成报表嵌入ticket | 生成报表嵌入需要使用的ticket。 |
DeleteTicket | 删除嵌入ticket | 删除免登嵌入报表的指定ticket。 |
DelayTicketExpireTime | 更新嵌入ticket的失效时间 | 更新嵌入报表的ticket的失效时间。 |
UpdateTicketNum | 更新嵌入ticket票据数量 | 对用于免登嵌入报表的指定的ticket进行更新票据数量操作。 |
QueryTicketInfo | 查询嵌入报表ticket详情 | 获取免登嵌入报表的指定ticket的详情信息。 |
智能问数嵌入 | 智能问数嵌入 | |
CreateTicket4Copilot | 生成智能小Q嵌入Ticket | 用于生成智能小Q嵌入Ticket。 |
ModifyCopilotEmbedConfig | 修改智能问数嵌入配置 | 修改智能问数嵌入配置。 |
QueryCopilotEmbedConfig | 获取开通小Q嵌入的配置列表 | 获取开通小Q嵌入的配置列表。 |
QueryDataRange | 获取数据范围目录列表 | 获取嵌入配置界面的数据范围目录列表。 |
SmartqQueryAbility | 智能问数查询 | 智能问数查询。 |
统计分析
API | 标题 | API概述 |
---|---|---|
资源分析 | 资源分析 | |
QueryAuditLog | 查询审计日志信息 | 查询审计日志信息。 |