What SDK versions does Quick BI provide - Quick BI - Alibaba Cloud Documentation Center

This topic describes the SDK language versions Quick BI offers for data visualization analytics and provides links to obtain the latest SDK version.

SDK overview

Introduction

The Quick BI SDK for data visualization analytics provides a suite of encapsulated APIs, uses an AccessKey pair for identity verification, and offers features like automatic signing for convenient resource creation and management via APIs.

To utilize Quick BI's data visualization analytics features, you must install both the Quick BI SDK and the Alibaba Cloud core library. For instance, the Java SDK requires downloading aliyun-java-sdk-core and aliyun-java-sdk-quickbi-public.

Precautions

To download the SDK and review its usage, visit the Alibaba Cloud SDK page.
For a list of available API interfaces, see List of operations by function.
Retrieve the AccessKey ID and AccessKey Secret for your Alibaba Cloud account.
For more information, see Obtain an AccessKey pair.
To call API interfaces through the SDK, users must satisfy two conditions:
- They must have logged into Quick BI with their Alibaba Cloud account at least once.
- They must have Quick BI organization administrator permissions. Administrators can grant non-administrator users API calling permissions through the open platform's homepage. For instructions, see Overview > Access Control.

Supported programming languages

Quick BI supports SDK development in Java, Python, C#, and other languages. For SDK details, visit the Alibaba Cloud Open Platform.

Version description

Release version	Release date	Change description
2.0.0	2022-03-04	The API V2 version is regionally output. The online interface covers all interfaces in the original API list. Note The original API list will no longer be maintained after the API V2 version is published. Subsequent new API interfaces will be iteratively updated based on the V2 version.

SDK invocation methods

When invoking the SDK, consider the following:

Use the correct AccessKey ID and AccessKey Secret associated with your Alibaba Cloud account to create and initialize the DefaultAcsClient instance. Failure to do so will result in the error code: 404, Specified access key is not found. request id: AA7FE476-F206-5C52-95B3-DF35CD30D468.
The AccessKey/SecretKey must be associated with an Alibaba Cloud account with Quick BI organization administrator permissions and must have been used to log into Quick BI at least once. Fill in the details as appropriate.

For detailed invocation methods, refer to the SDK Documentation.

Flow control description of API interfaces

Important

The version for the following API interfaces is 2022-01-01.
Both Quick BI public cloud and Alibaba Finance Cloud users can call the following API interfaces.
Only Professional Edition and higher versions allow API interface calling permissions.

Classification	API name	API description	QPS (times/second)	Timeout (seconds)
User management	AddUser	Add organization members.	50	10
	UpdateUser	Update information of specified members in the organization.	50	10
	QueryUserList	Retrieve the list of organization members.	30	10
	DeleteUser	Delete specified organization users.	50	10
	QueryUserInfoByUserId	Query organization member information by user ID.	30	10
	QueryUserInfoByAccount	Query organization member information by Alibaba Cloud account ID or Alibaba Cloud account name.	30	10
User label management	AddUserTagMeta	Add metadata for organization member tags.	50	10
	DeleteUserTagMeta	Delete metadata for organization member tags.	50	10
	QueryUserTagMetaList	Query the list of metadata for member tags within the organization.	30	10
	UpdateUserTagValue	Change the tag value of organization members.	50	10
	QueryUserTagValueList	Query the list of tag values for specific users.	30	10
	UpdateUserTagMeta	Update metadata for organization member tags.	50	10
User group management	AddUserGroupMember	Add organization members to a specified user group.	50	10
	AddUserGroupMembers	Batch add users to a specified user group.	50	10
	DeleteUserGroupMember	Delete specified members from a specified user group.	50	10
	CreateUserGroup	Create a new user group in a specified organization.	50	10
	DeleteUserGroup	Delete a user group from a specified organization.	50	10
	UpdateUserGroup	Update information of a specified user group in the organization.	50	10
	QueryUserGroupMember	Retrieve the list of members in a user group.	30	10
	QueryUserGroupListByParentId	Retrieve information about sub-user groups under a specified parent user group.	30	10
	GetUserGroupInfo	Search for user group information by user group name keyword.	30	10
	ListUserGroupsByUserId	Query the list of user groups to which a user belongs.	30	10
	WithdrawAllUserGroups	Remove a user from all user groups.	50	10
	DeleteUserGroupMembers	Batch remove users from user groups.	50	10
	ListByUserGroupId	Batch query user group information by user group ID.	50	10
Report sharing authorization management	QueryShareList	Retrieve the authorization list information.	30	10
	AddShareReport	Add an authorization policy for the report.	50	10
	QuerySharesToUserList	Retrieve the list of works authorized to users.	30	10
	CancelReportShare	Delete the authorization policy for the report.	50	10
BI portal menu authorization management	ListPortalMenus	Retrieve the list of portal menus.	30	10
	ListPortalMenuAuthorization	Retrieve the authorization list of portal menus.	30	10
	AuthorizeMenu	Batch add BI portal menu authorizations.	50	10
	CancelAuthorizationMenu	Batch cancel BI portal menu authorizations.	50	10
	ChangeVisibilityModel	Modify whether the BI portal menu is visible only to authorized users.	50	10
Row-level permissions management	QueryDatasetSwitchInfo	Retrieve the switch status of row-level permissions for datasets.	30	10
	UpdateDataLevelPermissionStatus	Enable or disable row and column permissions for datasets.	50	10
	ListCubeDataLevelPermissionConfig	Retrieve configuration information for row and column permissions of datasets.	30	10
	SetDataLevelPermissionRuleConfig	Set configuration information for a single row and column permission rule of a dataset.	50	10
	DeleteDataLevelRuleConfig	Delete configuration information for a single row and column permission rule of a dataset.	50	10
	AddDataLevelPermissionRuleUsers	Incrementally add users corresponding to row-level permissions for a single rule.	50	10
	DeleteDataLevelPermissionRuleUsers	Delete users corresponding to row-level permissions for a single rule.	50	10
	SetDataLevelPermissionExtraConfig	Make additional configurations for row-level or column-level permissions.	50	10
	ListDataLevelPermissionWhiteList	Retrieve the whitelist of row and column permissions for datasets.	30	10
	SetDataLevelPermissionWhiteList	Set the whitelist of row and column permissions in full.	50	10
	AddDataLevelPermissionWhiteList	Incrementally set the whitelist of row and column permissions.	50	10
Workspace management	UpdateWorkspaceUsersRole	Change the roles of workspace members.	50	10
	QueryWorkspaceUserList	Retrieve the list of members in a specified workspace.	30	10
	DeleteUserFromWorkspace	Delete members from a specified workspace.	50	10
	QueryOrganizationWorkspaceList	Retrieve the list of workspaces in the current organization.	30	10
	AddUserToWorkspace	Add a single member to a specified workspace.	50	10
	AddWorkspaceUsers	Batch add workspace members to a specified workspace.	50	10
	QueryUserRoleInfoInWorkspace	Retrieve role information of members in a specified workspace.	30	10
	UpdateWorkspaceUserRole	Batch update role information of workspace members.	50	10
Report resource management	QueryWorksByOrganization	Retrieve the list of reports in the organization.	30	10
	QueryWorksByWorkspace	Retrieve the list of reports in a specified space within the organization.	30	10
	QueryReadableResourcesListByUserId	Retrieve the list of reports that the user has permission to view.	30	10
	CheckReadable	Verify whether the user has permission to view the report.	50	10
	QueryEmbeddedInfo	Retrieve embedded information of reports in the organization.	30	10
	UpdateEmbeddedStatus	Change the embedded status of the report.	50	10
	QueryWorks	Query related information of the report.	30	10
	QueryWorksBloodRelationship	Query lineage information of a specified report.	30	10
Dataset resource management	QueryDatasetList	Retrieve the list of datasets in a specified workspace.	30	10
	QueryDatasetDetailInfo	Retrieve details of a specified dataset.	30	10
	QueryDatasetInfo	Retrieve dataset details.	30	10
Management of favorites	ListCollections	Retrieve the list of favorites.	30	10
	SaveFavorites	Add to favorites.	50	10
	CancelCollection	Remove from favorites.	50	10
Homepage management	ListFavoriteReports	Retrieve the list of authorized works on the My Dashboard of the specified user's homepage.	30	10
	ListSharedReports	Retrieve the list of favorite works on the My Dashboard of the specified user's homepage.	30	10
	ListRecentViewReports	Retrieve the list of recently viewed or frequently viewed works on the My Dashboard of the specified user's homepage.	30	10
Data services	QueryDataService	Call APIs created in data services.	10	60
Embedding analytics	CreateTicket	Generate ticket information for third-party embedding.	50	10
	QueryTicketInfo	Retrieve ticket details for user-embedded reports.	30	10
	DeleteTicket	Delete the ticket for user-embedded reports.	50	10
	DelayTicketExpireTime	Update the expiration time of the ticket for embedded reports.	50	10
	UpdateTicketNum	Update the number of tickets for embedded reports.	50	10
Enable approval	ResultCallback	Custom approval flow callback interface. Users handle the approval flow of Quick BI by themselves.	30	10

Query the version of oss sdk for go

The pom.xml file's version value should reflect the latest version available at the SDK download address.

To check the SDK version, visit https://mvnrepository.com/artifact/com.aliyun/aliyun-java-sdk-quickbi-public.

How to limit concurrent request QPS not to exceed the throttling threshold?

Problem Description: The Quick BI public cloud environment's open APIs are configured with default throttling for performance and security reasons. If the actual concurrent request QPS exceeds the throttling threshold when using concurrent threads to call these APIs, the request will fail.

Solution: To manage QPS, consider using the RateLimiter class from Google's Guava library.

If managing Java projects with Maven, include the Maven dependencies in the pom.xml file.
```
<dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>${google.guava.version}</version>
</dependency>
```
Note
The pom.xml file's version value should be based on the latest version available at the download address. For the most recent version, see Guava: Google Core Libraries For Java.

Create and utilize RateLimiter.

Create a RateLimiter instance using the create() factory method. For more details, see https://www.baeldung.com/guava-rate-limiter.

// Create a RateLimiter with a flow control of 30 QPS.
RateLimiter rateLimiter = RateLimiter.create(30);
// Acquire permission. If QPS exceeds 30, block and wait.
rateLimiter.acquire();
// Obtain permission before making an API request.
doSomeAPIRequest();

Note

QPS (Queries Per Second) indicates the number of requests or tasks processed per second.

Concurrency is the number of requests or tasks the system processes simultaneously.

QPS = Concurrency / Average Response Time.

Quick BI:SDK User Guide