阿里云OpenAPI开发者门户

Quick BI - OpenAPI 概览2022-01-01
插件下载了解更多
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.
组织管理
OpenAPI 名称描述操作
组织用户管理
AddUserhot添加组织成员查看文档去调试
deprecatedBatchAddFeishuUsers批量添加飞书用户查看文档去调试
QueryUserListhot查询组织成员列表信息查看文档去调试
QueryUserInfoByUserId根据用户ID查询用户信息查看文档去调试
QueryUserInfoByAccounthot根据阿里云ID或阿里云账户名查询用户信息查看文档去调试
UpdateUser更新组织下指定成员的信息查看文档去调试
DeleteUser删除指定组织用户查看文档去调试
组织用户组管理
CreateUserGroup新建用户组,可以指定父用户组查看文档去调试
AddUserGroupMember将组织成员添加到指定的用户组查看文档去调试
AddUserGroupMembers将用户批量添加到指定的用户组中查看文档去调试
GetUserGroupInfo根据用户组名称关键字搜索用户组信息查看文档去调试
ListByUserGroupId根据用户组ID批量查询用户组信息查看文档去调试
ListUserGroupsByUserId根据用户的UserID,查询该用户所属的所有用户组信息查看文档去调试
QueryUserGroupListByParentId获取指定父用户组下的子用户组信息查看文档去调试
QueryUserGroupMember获取用户组下的成员列表信息查看文档去调试
UpdateUserGroup更新组织下指定用户组的信息查看文档去调试
DeleteUserGroup删除组织内的用户组查看文档去调试
DeleteUserGroupMember删除指定用户组下的指定成员查看文档去调试
DeleteUserGroupMembers指定用户批量退出用户组查看文档去调试
WithdrawAllUserGroups使用户退出所有用户组,该过程不可逆,请谨慎操作查看文档去调试
用户标签管理
AddUserTagMeta新增组织成员标签元信息查看文档去调试
QueryUserTagMetaList查询组织内成员标签元信息列表查看文档去调试
QueryUserTagValueList查询特定用户标签值列表查看文档去调试
UpdateUserTagMeta用于更新组织成员标签元信息查看文档去调试
UpdateUserTagValue更新组织成员标签值查看文档去调试
DeleteUserTagMeta删除组织成员的标签元信息查看文档去调试
角色管理
ListWorkspaceRoleUsers获取指定空间角色下的用户列表查看文档去调试
QueryWorkspaceRoleConfig获取指定空间角色的配置查看文档去调试
QueryOrganizationRoleConfig获取指定组织角色的配置查看文档去调试
ListWorkspaceRoles获取空间角色列表查看文档去调试
ListOrganizationRoles获取组织角色列表查看文档去调试
ListOrganizationRoleUsers获取指定组织角色下的用户列表查看文档去调试
权限管理
OpenAPI 名称描述操作
报表分享授权管理
AddShareReport添加数据作品的一个分享配置查看文档去调试
QueryShareList查询作品被分享给哪些对象的列表,只返回仍然在有效期限内的分享配置查看文档去调试
QuerySharesToUserList查询授权给用户的作品列表查看文档去调试
CancelReportShare删除数据作品的一个分享授权查看文档去调试
数据门户菜单授权管理
AuthorizeMenu数据门户菜单的批量授权,已经授权的会自动略过查看文档去调试
ListPortalMenus获取具体数据门户下的分层菜单列表查看文档去调试
ListPortalMenuAuthorization获取数据门户菜单的授权详情列表查看文档去调试
ChangeVisibilityModel修改数据门户菜单的可见方式,是否仅授权可见查看文档去调试
CancelAuthorizationMenu根据门户菜单ID,取消指定用户、用户组的授权记录查看文档去调试
行级权限管理
SetDataLevelPermissionRuleConfig设置单条数据集行列权限配置信息(新增和更新)查看文档去调试
AddDataLevelPermissionRuleUsers针对单条行列权限规则增量添加选定的人群查看文档去调试
AddDataLevelPermissionWhiteList修改指定数据集行列权限的白名单查看文档去调试
QueryDatasetSwitchInfo获取指定数据集的行级权限开关状态查看文档去调试
ListCubeDataLevelPermissionConfig获取指定数据集的行列权限配置列表查看文档去调试
ListDataLevelPermissionWhiteList根据行列权限种类,获取数据集行列权限的白名单列表查看文档去调试
UpdateDataLevelPermissionStatus更新数据集行列权限开关状态查看文档去调试
SetDataLevelPermissionExtraConfig设置行列权限的额外配置查看文档去调试
SetDataLevelPermissionWhiteList设置指定行级权限的白名单列表查看文档去调试
DeleteDataLevelRuleConfig删除单条行列权限规则查看文档去调试
DeleteDataLevelPermissionRuleUsers针对单条行列权限规则删除选定的人群查看文档去调试
开放审批
QueryApprovalInfo根据审批人获取相应的审批流信息查看文档去调试
ResultCallback自定义审批流回调接口,用户自行对Quick BI的审批流进行处理查看文档去调试
资源管理
OpenAPI 名称描述操作
报表资源管理
QueryWorksByOrganizationhot查询整个组织下的所有作品,可指定作品类型查看文档去调试
QueryWorksByWorkspacehot查询组织下某个工作空间下的所有作品,可指定作品类型查看文档去调试
QueryReadableResourcesListByUserId查询用户有权查看的作品列表,包含空间下与分享授权的报表查看文档去调试
CheckReadable查询用户对数据作品(仪表板、电子表格等)是否有权限查看查看文档去调试
QueryEmbeddedInfo获取组织下的嵌入配置,包括最大嵌入数和已经嵌入数等查看文档去调试
QueryEmbeddedStatus查询某个报表是否已经开通嵌入查看文档去调试
QueryWorks查询指定数据作品信息查看文档去调试
QueryWorksBloodRelationshiphot获取数据作品的血缘关系,包括各组件引用的数据集以及查询字段信息。目前仅支持的数据作品包含仪表板、电子表格、自助取数查看文档去调试
QueryComponentPerformance查询组件性能日志查看文档去调试
QueryReportPerformance查询报表性能日志查看文档去调试
GetWorksEmbedList查询已嵌入报表列表查看文档去调试
UpdateEmbeddedStatus更改报表的嵌入状态,开通嵌入、或者关闭嵌入查看文档去调试
数据集资源管理
DataSetBlood查询引用指定数据集下的作品信息查看文档去调试
DataSourceBlood查询引用指定数据源下的数据集信息查看文档去调试
ListApiDatasource查询API数据源列表查看文档去调试
QueryDatasetInfohot查询指定数据集的信息查看文档去调试
QueryDatasetDetailInfohot查询指定数据集的详情,包括所属数据源、目录、以及数据集模型查看文档去调试
QueryDatasetList查询指定工作空间的数据集列表,按照创建时间倒序排列查看文档去调试
QueryCubePerformance查询数据集性能日志查看文档去调试
QueryCubeOptimization查询数据集优化建议查看文档去调试
ModifyApiDatasourceParameters修改指定API数据源的配置查看文档去调试
AllotDatasetAccelerationTask触发数据集Quick引擎的采集加速查看文档去调试
ListDataSource查询指定空间下的所有数据源查看文档去调试
GetDataSourceConnectionInfo获取数据源信息查看文档去调试
工作空间管理
AddUserToWorkspace添加成员到指定工作空间查看文档去调试
AddWorkspaceUsers批量添加成员到工作空间查看文档去调试
QueryWorkspaceUserList查询指定工作空间下的成员列表信息查看文档去调试
QueryOrganizationWorkspaceList获取当前组织下的工作空间列表信息查看文档去调试
QueryUserRoleInfoInWorkspace获取指定工作空间成员的预置空间角色信息查看文档去调试
UpdateWorkspaceUsersRole批量更新工作空间成员的角色信息,已有角色会被覆盖查看文档去调试
UpdateWorkspaceUserRole修改工作空间下指定成员的角色,已有的角色会被覆盖查看文档去调试
DeleteUserFromWorkspace删除指定工作空间的成员查看文档去调试
收藏管理
SaveFavorites添加用户的收藏数据作品查看文档去调试
ListCollections获取用户收藏的作品列表查看文档去调试
CancelCollection取消用户收藏的数据作品查看文档去调试
首页管理
ListFavoriteReports获取指定用户在首页看板中展示的收藏作品列表查看文档去调试
ListRecentViewReports获取指定用户在首页看板中展示的常看和足迹列表查看文档去调试
ListSharedReports获取指定用户在首页看板中展示的被授权的作品列表查看文档去调试
订阅管理
ManualRunMailTask手动执行订阅的邮件任务查看文档去调试
GetMailTaskStatus查看组织内邮件任务运行状态(实时状态非最终状态)查看文档去调试
数据管理
OpenAPI 名称描述操作
数据服务
QueryData对数据服务中已创建的API进行调用查看文档去调试
QueryDataServiceList查询数据服务API列表查看文档去调试
deprecatedQueryDataServicehot对数据服务中已创建的API进行调用查看文档去调试
嵌入分析
OpenAPI 名称描述操作
报表嵌入
CreateTickethot生成报表嵌入需要使用的ticket查看文档去调试
QueryTicketInfo获取免登嵌入报表的指定ticket的详情信息查看文档去调试
DelayTicketExpireTime更新嵌入报表的ticket的失效时间查看文档去调试
UpdateTicketNum对用于免登嵌入报表的指定的ticket进行更新票据数量操作查看文档去调试
DeleteTicket删除免登嵌入报表的指定ticket查看文档去调试
统计分析
OpenAPI 名称描述操作
资源分析
QueryAuditLog查询审计日志信息查看文档去调试
智能问数
OpenAPI 名称描述操作
智能问数嵌入
CreateTicket4Copilot用于生成智能小Q嵌入Ticket查看文档去调试
QueryCopilotEmbedConfig获取开通小Q嵌入的配置列表查看文档去调试
QueryDataRange获取嵌入配置界面的数据范围目录列表查看文档去调试
ModifyCopilotEmbedConfig修改智能问数嵌入配置查看文档去调试
智能问数管理
SmartqQueryAbility智能问数查询查看文档去调试
SmartqAuthorize批量管理智能问数的授权查看文档去调试
QueryLlmCubeWithThemeListByUserId查看用户有哪些数据集和分析主题的问数授权查看文档去调试
SmartqAuthTransfer将指定用户的问数权限同步给其他用户查看文档去调试
QuerySmartqPermissionByCubeId查看用户是否有某个智能问数数据集权限查看文档去调试
QueryDatasetSmartqStatus查看数据集是否开通智能问数查看文档去调试