API overview-Quick BI(Quick BI)-阿里云帮助中心

API standards and multilingual preset SDKs

The OpenAPI of this product (quickbi-public/2022-01-01) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Organization management

API	Title	Description
Organization user management	Organization user management
DeleteUser	Delete Organization User	Delete the specified organization user.
CheckOrganizationMember	CheckOrganizationMember	Checks if a user is a member of an organization.
AddUser	Add Organization Member	Add organization members.
BatchAddFeishuUsers	Batch add lark users	Adds Lark users in batches.
UpdateUser	Update organization member information	Updates the information of a specified member in an organization.
QueryUserList	Query organization member list	Queries the list of organization members.
QueryUserInfoByUserId	Query user information by user ID	Queries user information by user ID.
QueryUserInfoByAccount	Query user information by account	Queries user information by Alibaba Cloud ID or Alibaba Cloud account name.
QueryUserByMobileAccount	Query userId by bound third-party account ID	Queries a UserId by the bound third-party account ID.
Organization user group management	Organization user group management
UpdateUserGroup	UpdateUserGroup	Updates information about a specified user group in an organization.
DeleteUserGroup	DeleteUserGroup	Deletes a user group in an organization.
CreateUserGroup	CreateUserGroup	Create a user group. You can specify a parent user group.
AddUserGroupMember	AddUserGroupMember	Adds an organization member to a specified user group.
AddUserGroupMembers	AddUserGroupMembers	Add users to a specified user group at a time.
DeleteUserGroupMember	DeleteUserGroupMember	Deletes a specified member from a specified user group.
DeleteUserGroupMembers	DeleteUserGroupMembers	Batch remove specified users from user groups.
WithdrawAllUserGroups	WithdrawAllUserGroups	Make the user exit all user groups. This process is irreversible. Exercise caution when performing this operation.
GetUserGroupInfo	Get User Group Information by Keyword	Search for user group information based on the keyword of the user group name.
ListByUserGroupId	ListByUserGroupId	Queries user group information at a time by user group ID.
ListUserGroupsByUserId	ListUserGroupsByUserId	Queries all user groups to which a user belongs based on the user ID.
QueryUserGroupListByParentId	QueryUserGroupListByParentId	You can this operation to obtain information about child user groups under a specified parent user group.
QueryUserGroupMember	Query User Group Member List	Retrieve the list of members under a user group.
TransferUsergroup	Migrate a user group	Migrates a user group.
User tag management	User tag management
AddUserTagMeta	Add Organization Member Tag Metadata	Add organization member tag metadata.
DeleteUserTagMeta	DeleteUserTagMeta	Deletes the tag metadata of an organization member.
UpdateUserTagValue	Update Organization Member Tag Value	Update the tag value of an organization member.
QueryUserTagMetaList	QueryUserTagMetaList	Queries the metadata list of member tags in an organization.
QueryUserTagValueList	QueryUserTagValueList	Query the list of specific user tag values.
UpdateUserTagMeta	UpdateUserTagMeta	Used for updating the metadata of organization member tags
ListDynamicTag	Retrieve the dynamic label list for the current organization	Retrieves the list of dynamic labels for the current organization.
ClearDynamicTagCache	Delete the cache of a specified dynamic tag	Deletes the cached tag value for a single configuration.
Role management	Role management
ListWorkspaceUserRolesByUserId	ListWorkspaceUserRolesByUserId	Queries all workspace roles of a user.
ListWorkspaceRoleUsers	ListWorkspaceRoleUsers	Get user list under the specified workspace role.
QueryWorkspaceRoleConfig	QueryWorkspaceRoleConfig	Get Configuration Information for a Specified Workspace Role
QueryOrganizationRoleConfig	QueryOrganizationRoleConfig	Gets the configuration of the specified organization role.
ListWorkspaceRoles	ListWorkspaceRoles	Get the list of workspace roles.
ListOrganizationRoles	Get Organization Role List	Retrieve the list of custom roles at the organization level.
ListOrganizationRoleUsers	ListOrganizationRoleUsers	Get user list under the specified organization role.

Permission management

API	Title	Description
Access control management	Access control management
IpWhiteListConfig	Configure IP whitelist for data security	Configures the IP whitelist for data security.
Report sharing authorization management	Report sharing authorization management
ListAuthConfigByResource	Query collaborative authorization records for a resource	Queries the list of collaborative authorization records for a resource.
AddShareReport	Add data work sharing configuration	Add a sharing configuration for data works.
CancelReportShare	CancelReportShare	Delete a share authorization for a data work.
QuerySharesToUserList	QuerySharesToUserList	You can call this operation to query the list of works authorized to a user.
QueryShareList	Query the Sharing Records of a Work	Query the list of objects to which a work has been shared, returning only the sharing configurations that are still within their validity period.
AddWorksAuthorization	AddWorksAuthorization	Adds an authorization for a work.
DeleteAuthorizationByUserId	Delete the collaborative authorization record of a specified user	Deletes the collaborative authorization record of a specified user.
Data portal menu authorization management	Data portal menu authorization management
AuthorizeMenu	AuthorizeMenu	Batch authorization of BI portal menu will be skipped automatically.
CancelAuthorizationMenu	Batch Cancel Data Portal Menu Authorization	Cancel the authorization records for specified users and user groups based on the portal menu ID.
ChangeVisibilityModel	ChangeVisibilityModel	Modifies the visibility mode of the BI portal menu and whether the menu is only authorized to be visible.
ListPortalMenus	ListPortalMenus	Gets a hierarchical list of menus under a specific BI portal.
ListPortalMenuAuthorization	ListPortalMenuAuthorization	Retrieves a list of authorization details for the menus in a BI portal.
ListWhitePortalMenu	ListWhitePortalMenu	Retrieves the whitelist for a BI portal menu.
Row-level permission management	Row-level permission management
SetDataLevelPermissionRuleConfig	Set Single Dataset Row and Column Permission Configuration Information	Set single dataset row and column permission configuration information (addition and update)
AddDataLevelPermissionRuleUsers	AddDataLevelPermissionRuleUsers	Adds specified users and user groups to a row-level permission rule.
AddDataLevelPermissionWhiteList	AddDataLevelPermissionWhiteList	Modifies the whitelist for row-level and column-level permissions of a specified dataset.
DeleteDataLevelRuleConfig	DeleteDataLevelRuleConfig	Deletes a row-level permission rule.
DeleteDataLevelPermissionRuleUsers	DeleteDataLevelPermissionRuleUsers	Deletes specified users from a row-level permission rule.
UpdateDataLevelPermissionStatus	UpdateDataLevelPermissionStatus	Updates the row-level and column-level permission status for a dataset.
SetDataLevelPermissionExtraConfig	SetDataLevelPermissionExtraConfig	Set extra configuration for row and column permissions.
SetDataLevelPermissionWhiteList	SetDataLevelPermissionWhiteList	Sets the whitelist for the specified row-level permissions.
QueryDatasetSwitchInfo	QueryDatasetSwitchInfo	Get the row-level permission switch status for a specified dataset.
ListCubeDataLevelPermissionConfig	ListCubeDataLevelPermissionConfig	You can this operation to obtain a list of row and column permission configurations for a specified dataset.
ListDataLevelPermissionWhiteList	Get Dataset Row and Column Permission Whitelist	Retrieve the whitelist for dataset row and column permissions based on the type of permission.
Open approval	Open approval
QueryApprovalInfo	QueryApprovalInfo	Get approval flow information based on the approver.
ResultCallback	ResultCallback	You can customize the callback interface for approval processes to process Quick BI approval processes.

Resource management

API	Title	Description
Report resource management	Report resource management
UpdateEmbeddedStatus	UpdateEmbeddedStatus	Change the embedding status of a report, turn on embedding, or turn off embedding.
QueryWorksByOrganization	Query All Works Under the Organization	Query all works under the entire organization, with the option to specify the type of work.
QueryWorksByWorkspace	QueryWorksByWorkspace	Queries all works in a workspace under an organization. You can specify the type of work.
QueryReadableResourcesListByUserIdV2	Query List of Works User Has Permission to View (New)	Query list of works user has permission to view (new)
QueryReadableResourcesListByUserId	QueryReadableResourcesListByUserId	Queries the list of works that a user has the permission to view, including the statements that are authorized to share in a space.
CheckReadable	CheckReadable	Queries whether a user has permissions to view data works, such as dashboards and workbooks.
QueryEmbeddedInfo	QueryEmbeddedInfo	Obtain the embedding configuration in the organization, including the maximum number of embeddings and the number of embeddings.
QueryEmbeddedStatus	QueryEmbeddedStatus	Queries whether embedding is enabled for a report.
QueryWorks	Query data work information	Queries the information of a specified data work.
QueryWorksBloodRelationship	QueryWorksBloodRelationship	Obtains the kinship of a data work, including the datasets referenced by each component and query field information. Currently, only supported data works include dashboards, workbooks, and self-service data retrieval.
QueryComponentPerformance	QueryComponentPerformance	Queries component performance logs.
QueryReportPerformance	QueryReportPerformance	Queries report performance logs.
GetWorksEmbedList	Get Embedded Reports	Query the list of embedded reports
Dataset resource management	Dataset resource management
UpdateDataSource	UpdateDataSource	Modifies a data source configuration.
CreateDataset	CreateDataset	Creates a dataset from a physical table.
CheckDatasetExisted	CheckDatasetExisted	Checks whether a dataset with the specified CubeId exists.
CreateCubeBySql	Create a dataset based on custom SQL	Creates a dataset based on a custom SQL statement.
AddDataSource	AddDataSource	Adds a data source.
UpdateCubeBySql	Update a custom SQL dataset	Updates a custom SQL dataset.
QueryLastAccelerationEngineJob	QueryLastAccelerationEngineJob	Query the Most Recent Acceleration Task by Dataset ID
ListDataSource	ListDataSource	Query all data sources under the specified space
DataSetBlood	DataSetBlood	Query works information under the specified dataset.
DataSourceBlood	Query dataset information under the specified data source	Query dataset information under the specified data source
ModifyApiDatasourceParameters	ModifyApiDatasourceParameters	Modifies the configurations of a specified API data source.
ListApiDatasource	ListApiDatasource	Queries API data sources.
QueryDatasetInfo	QueryDatasetInfo	Indicates whether the table is a custom SQL table. Valid values: \\* true: custom SQL table \\* false: non-custom SQL table
QueryDatasetDetailInfo	QueryDatasetDetailInfo	Retrieves the details of a specified dataset, including its data source, directory, and dataset model.
QueryDatasetList	QueryDatasetList	Queries the datasets in a specified workspace. The results are sorted in descending order by creation time.
AllotDatasetAccelerationTask	AllotDatasetAccelerationTask	Trigger the collection acceleration of the Quick engine for datasets.
QueryCubePerformance	QueryCubePerformance	Queries the performance logs of a dataset.
QueryCubeOptimization	QueryCubeOptimization	Queries dataset optimization suggestions.
GetDataSourceConnectionInfo	GetDataSourceConnectionInfo	Get Data Source Information
ListAccelerationOfWorkspace	ListAccelerationOfWorkspace	Retrieves information about acceleration tasks in a workspace.
QueryAccelerationLogByCubeId	QueryAccelerationLogByCubeId	Queries the run logs of acceleration tasks for a specified dataset.
Workspace management	Workspace management
CreateWorkspace	CreateWorkspace	Creates a workspace.
AddUserToWorkspace	Add Member to Workspace	Adds a member to a specified workspace.
AddWorkspaceUsers	Batch Add Members to Workspace	Batch add members to the workspace.
DeleteUserFromWorkspace	Remove Workspace Member	Delete a member from the specified workspace.
UpdateWorkspaceUsersRole	Batch Update Workspace Member Roles	Batch update the role information of workspace members, existing roles will be overwritten
UpdateWorkspaceUserRole	Modify Workspace Member Role	Modify the role of a specified member under the workspace, existing roles will be overwritten.
QueryWorkspaceUserList	List Members Under a Workspace	Query the list of members under a specified workspace.
QueryOrganizationWorkspaceList	Get workspace list in an organization	Retrieves the list of workspaces in the current organization.
QueryUserRoleInfoInWorkspace	Query Preset Roles of Workspace Members	Get the preset workspace role information for a specified workspace member.
Favorite management	Favorite management
SaveFavorites	Add Work to Favorites	Add a user's favorite work
CancelCollection	CancelCollection	Cancel the data works from the user's collection.
Homepage management	Homepage management
ListCollections	ListCollections	Retrieve the list of works that a user has favorited.
ListFavoriteReports	Favorite Reports List on Home Dashboard	Overview
ListRecentViewReports	ListRecentViewReports	You can call this operation to obtain a list of the most frequently viewed and footsteps displayed in the homepage dashboard for a specified user.
ListSharedReports	ListSharedReports	You can this operation to obtain the list of authorized works displayed on the homepage of a specified user.
Subscription management	Subscription management
ManualRunMailTask	ManualRunMailTask	Manually Execute Email Task
GetMailTaskStatus	GetMailTaskStatus	Check the running status of mail tasks within an organization
GetMailTaskList	GetMailTaskList	Retrieves a list of tracking tasks. Note: If the caller's AccessKey (AK) does not have permission to view tracking tasks of other users, this operation returns only the tasks that the caller is authorized to access.

Data management

API	Title	Description
Data service	Data service
QueryData	QueryData	Calls a DataService Studio API to query data.
QueryDataServiceList	QueryDataServiceList	Query Data Service API List
QueryDataService	Invoke Data Service API	Invoke an already created API in the data service.

Embedded analytics

API	Title	Description
Report embedding	Report embedding
CreateTicket	Generate an embedded report ticket	Generates a ticket required for embedded report access.
DeleteTicket	Delete Embedded Ticket	Delete Third-Party Embedded Ticket
DelayTicketExpireTime	DelayTicketExpireTime	Update the expiration time of the ticket embedded in the report.
UpdateTicketNum	UpdateTicketNum	Update the ticket quantity on the specified ticket used for the exemption embedded report.
QueryTicketInfo	QueryTicketInfo	Obtains the details of a specified ticket for a report that is not embedded in the report.

Statistical analysis

API	Title	Description
Resource analysis	Resource analysis
QueryAuditLog	Query Audit Log Information	Queries audit log information.

AI chat

API	Title	Description
AI chat embedding	AI chat embedding
CreateTicket4Copilot	Generate Smart Q Embedding Ticket	Generates a ticket to embed Copilot.
ModifyCopilotEmbedConfig	Modify Intelligent Query Embedding Configuration	Modify Intelligent Query Embedding Configuration
QueryCopilotEmbedConfig	Get the List of Configurations for Activating XiaoQ Embedding	Get the List of Configurations for Activating XiaoQ Embedding
QueryDataRange	Get Data Range Catalog List	Get Data Range Catalog List
AI chat management	AI chat management
ModifyDashboardNl2sqlStatus	ModifyDashboardNl2sqlStatus	Modifies the Q-Assistant status for multiple dashboards.
QueryDashboardNl2sql	QueryDashboardNl2sql	Query Dashboard's Question Resource Information
SmartqAuthorize	Batch Management of Smart Q\\\\\\&A Authorizations	Manages authorizations for Intelligent Q&A in batches.
QueryLlmCubeWithThemeListByUserId	Check which datasets and analysis themes the user has question authorization for	Check which datasets and analysis themes the user has question authorization for
SmartqAuthTransfer	Synchronize the question count permissions of a specified user to other users	Synchronize the question count permissions of a specified user to other users
QuerySmartqPermissionByCubeId	Check if a user has permission for a specific smart question dataset	Queries the permissions of a user on a Smart Q&A dataset.
QueryDatasetSmartqStatus	Check if the Dataset has Enabled Smart Query	Checks whether Intelligent Q&A is enabled for a dataset.
SmartqQueryAbility	Smart Q&A query	Queries data by using the Smart Q&A feature.