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 | Check whether a user belongs to an organization | Checks whether a user belongs to an organization. |
| AddUser | Add an organization member | Adds an organization member. |
| BatchAddFeishuUsers | Add multiple lark users | Adds multiple Lark users. |
| 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 user ID by bound third-party account ID | Queries the user ID based on 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 | Add members to a user group | Adds organization members to a specified user group. |
| AddUserGroupMembers | Add multiple members to a user group | Adds multiple users to a specified user group. |
| 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 | Retrieve user group information by keyword | Searches for user group information by user group name keyword. |
| ListByUserGroupId | Query user groups in batch | Queries information about user groups in batch 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 | List members of a user group | Retrieves the list of members in a user group. |
| TransferUsergroup | Migrate a user group | Migrates a user group. |
| User tag management | User tag management | |
| AddUserTagMeta | Create metadata for an organization member tag | Creates metadata for an organization member tag. |
| 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 | Query member tag metadata in an organization | Queries the list of member tag metadata in an organization. |
| QueryUserTagValueList | QueryUserTagValueList | Query the list of specific user tag values. |
| UpdateUserTagMeta | Update organization member tag metadata | Updates the metadata of an organization member tag. |
| ListDynamicTag | Retrieve the dynamic label list for the current organization | Retrieves the list of dynamic labels for the current organization. |
| ClearDynamicTagCache | Delete the cache for a specified dynamic tag | Deletes the tag value cache 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 | |
| UpdateAuthorizationAttributes | Modify permission attributes of resource collaborative authorization | Modifies the permission attributes of resource collaborative authorization. |
| ListAuthConfigByResource | Query collaborative authorization records of a resource | Queries the collaborative authorization records of a resource. |
| AddShareReport | Add a sharing configuration for a data work | Adds a sharing configuration for a data work. |
| CancelReportShare | Delete sharing authorization for a data work | Deletes a sharing 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 | Create a collaborative authorization record for a resource | Creates a collaborative authorization record for a resource. |
| 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 | Grant batch permissions for data portal menus | Grants batch permissions for data portal menus. Already authorized menus are automatically skipped. |
| CancelAuthorizationMenu | Revoke data portal menu authorizations in batches | Revokes authorization records for specified users and user groups based on portal menu IDs. |
| 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 | Add users and user groups to a row-column permission rule | Adds selected users and user groups to a specific row-column permission rule. |
| AddDataLevelPermissionWhiteList | Incrementally update the whitelist for row and column permissions | Modifies the whitelist for row and column 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 | Retrieve the row-level permission switch status of a dataset | Retrieves the status of the row-level permission switch 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 | Retrieve dataset row and column permission whitelist | Retrieves the whitelist of row-level or column-level permissions for a dataset based on the specified permission type. |
| Open approval | Open approval | |
| QueryApprovalInfo | Retrieve approval flow information by approver | Retrieves the 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 in an organization | Queries all works in an organization. You can specify the work type. |
| 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 | Query the list of works that a user has permission to view | Queries the list of works that a user has permission to view, including reports in workspaces and those shared through authorization. |
| 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 | Retrieve data work details | Queries the details of a specified data work. |
| QueryWorksBloodRelationship | Retrieve data work lineage | Retrieves the lineage of a data work, including the datasets referenced by each component and the query field information. Currently, only dashboards, workbooks, and ad hoc queries are supported. |
| QueryComponentPerformance | Query component performance logs | Queries component performance logs. |
| QueryReportPerformance | Query report performance logs | Queries report performance logs. |
| GetWorksEmbedList | Retrieve embedded reports | Queries a 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 | Create a data source connection | Creates a data source connection. |
| 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 | Query API data source list | Queries the list of API data sources. |
| QueryDatasetInfo | Query dataset information | Queries the information of a specified dataset. |
| QueryDatasetDetailInfo | Query dataset details | Queries the details of a specified dataset, including the associated data source, folder, and dataset model. |
| QueryDatasetList | Query workspace dataset list | Queries the list of datasets in a specified workspace, sorted by creation time in descending order. |
| AllotDatasetAccelerationTask | Trigger dataset extraction acceleration | Triggers the extraction acceleration of the Quick engine for a dataset. |
| QueryCubePerformance | Query dataset performance logs | Queries the performance logs of a dataset. |
| QueryCubeOptimization | Query dataset optimization suggestions | Queries optimization suggestions for datasets. |
| GetDataSourceConnectionInfo | GetDataSourceConnectionInfo | Get Data Source Information |
| ListAccelerationOfWorkspace | Retrieve acceleration engine task information in a workspace | Retrieves acceleration engine task information from the management page of a workspace. |
| QueryAccelerationLogByCubeId | Retrieve execution logs of acceleration tasks for a specified dataset | Retrieves the execution logs of acceleration tasks for a specified dataset. |
| Workspace management | Workspace management | |
| CreateWorkspace | CreateWorkspace | Creates a workspace. |
| AddUserToWorkspace | Add a member to a workspace | Adds a member to a specified workspace. |
| AddWorkspaceUsers | Add members to a workspace in batches | Adds members to a workspace in batches. |
| DeleteUserFromWorkspace | Remove Workspace Member | Delete a member from the specified workspace. |
| UpdateWorkspaceUsersRole | Update roles of workspace members in batches | Updates the roles of workspace members in batches. Existing roles are overwritten. |
| UpdateWorkspaceUserRole | Modify workspace member roles | Modifies the role of a specified member in a workspace. Existing roles are overwritten. |
| QueryWorkspaceUserList | List Members Under a Workspace | Query the list of members under a specified workspace. |
| QueryOrganizationWorkspaceList | List workspaces in an organization | Queries 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. |
| Favorites management | Favorites management | |
| SaveFavorites | Add Work to Favorites | Add a user's favorite work |
| CancelCollection | Remove a work from favorites | Removes a data work from a user's favorites. |
| 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 | Retrieve frequently viewed items and footprint list on homepage dashboard | Retrieves the frequently viewed items and footprint list displayed on 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 services | Data services | |
| QueryData | QueryData | Calls a DataService Studio API to query data. |
| QueryDataServiceList | QueryDataServiceList | Query Data Service API List |
| QueryDataService | Call a data service API | Calls an API created in Data Service. |
Embedded analysis
|
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 | Query embedded report ticket details | Retrieves the details of a specified ticket for logon-free embedded reports. |
Statistical analysis
|
API |
Title |
Description |
| Resource analysis | Resource analysis | |
| QueryAuditLog | Query audit log information | Queries audit log information. |
Intelligent Q&A
|
API |
Title |
Description |
| Intelligent Q&A embedding | Intelligent Q&A 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 |
| Intelligent Q&A management | Intelligent Q&A management | |
| ModifyDashboardNl2sqlStatus | ModifyDashboardNl2sqlStatus | Modifies the Q-Assistant status for multiple dashboards. |
| QueryDashboardNl2sql | Query NL2SQL resource information of a dashboard | Queries the NL2SQL resource information of a dashboard. |
| 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. |