QuickBI提供哪些SDK版本 - Quick BI

本文介紹了資料視覺效果分析Quick BI提供的SDK語言版本，列舉了最新版本SDK的擷取地址。

SDK概覽

簡介

資料視覺效果分析Quick BI SDK封裝了API，以存取金鑰（AccessKey）識別調用者身份，提供自動簽名等功能，方便您通過API建立和管理資源。

實現資料視覺效果分析Quick BI功能需要您同時安裝Quick BI SDK和阿里雲核心庫。以Java SDK為例，您需要下載aliyun-java-sdk-core以及aliyun-java-sdk-quickbi-public。

注意事項

您需要前往阿里雲 SDK頁面下載SDK並查看使用。
擷取已開放的API介面，請參見API概覽。
擷取阿里雲帳號的AccessKey ID和AccessKey Secret。
請參見建立AccessKey。
對於需要通過SDK調用API介面的使用者，需要同時滿足以下兩個條件才支援使用SDK：
- 其阿里雲賬戶至少登入過一次Quick BI。
- 其阿里雲賬戶需要被授予Quick BI組織管理員的許可權。同時管理員也可以通過開放平台首頁，授予非管理使用者調用所有API的許可權，具體操作請參見概述 > 存取控制。

支援的開發語言

資料視覺效果分析Quick BI支援Java、Python、C#等開發。更多SDK的資訊，請訪問阿里雲開放平台。

版本說明

發布版本	發布時間	變更說明
2.0.0	2022-03-04	開放API V2版本region化輸出，上線介面涵蓋了原開放API列表中的所有介面。說明原開放API列表在開放API V2版本上線後不再維護，後續的新增API介面統一基於V2版本迭代更新。

SDK調用方式

調用時，需要注意以下幾點：

請使用正確的阿里雲賬戶對應的AccessKey ID和AccessKey Secret建立DefaultAcsClient執行個體並初始化，否則會出現code: 404, Specified access key is not found. request id: AA7FE476-F206-5C52-95B3-DF35CD30D468報錯。
阿里雲賬戶對應的accessKey/secretKey，該阿里雲賬戶被授予Quick BI的組織管理員權限，且至少登入過一次Quick BI，根據實際情況填寫。

調用方式詳情請參見SDK文檔。

API介面的流控說明

重要

以下API介面的Version版本為2022-01-01。
Quick BI公用雲和金融雲使用者均支援調用以下API介面。
僅專業版及以上版本開放API介面調用許可權。

分類	API名稱	API描述	QPS（次/秒）	逾時時間（秒）
組織使用者管理	AddUser	添加組織成員。	50	10
	UpdateUser	更新群組織下指定成員的資訊。	50	10
	QueryUserList	擷取組織成員列表資訊。	30	10
	DeleteUser	刪除指定組織使用者。	50	10
	QueryUserInfoByUserId	根據使用者ID查詢組織成員資訊。	30	10
	QueryUserInfoByAccount	根據阿里雲帳號ID或阿里雲帳號名稱查詢組織成員資訊。	30	10
使用者標籤管理	AddUserTagMeta	新增組織成員標籤元資訊。	50	10
	DeleteUserTagMeta	刪除群組織成員標籤元資訊。	50	10
	QueryUserTagMetaList	查詢組織內成員標籤元資訊列表。	30	10
	UpdateUserTagValue	更改組織成員的標籤值。	50	10
	QueryUserTagValueList	查詢特定使用者的標籤值列表。	30	10
	UpdateUserTagMeta	更新群組織成員標籤元資訊。	50	10
組織使用者組管理	AddUserGroupMember	添加組織成員到指定使用者組。	50	10
	AddUserGroupMembers	大量新增使用者至指定使用者組。	50	10
	DeleteUserGroupMember	刪除指定使用者組下的指定成員。	50	10
	CreateUserGroup	在指定組織中建立使用者組。	50	10
	DeleteUserGroup	刪除指定組織的使用者組。	50	10
	UpdateUserGroup	更新群組織下指定使用者組的資訊。	50	10
	QueryUserGroupMember	擷取使用者組下的成員列表資訊。	30	10
	QueryUserGroupListByParentId	擷取指定父使用者組下的子使用者組資訊。	30	10
	GetUserGroupInfo	根據使用者組名稱關鍵字搜尋使用者組資訊。	30	10
	ListUserGroupsByUserId	查詢使用者所屬使用者組列表。	30	10
	WithdrawAllUserGroups	使使用者退出所有使用者組。	50	10
	DeleteUserGroupMembers	使用者批量退出使用者組。	50	10
	ListByUserGroupId	根據使用者組ID批量查詢使用者組資訊。	50	10
報表分享授權管理	QueryShareList	擷取授權列表資訊。	30	10
	AddShareReport	為報表添加授權策略。	50	10
	QuerySharesToUserList	擷取授權給使用者的作品列表。	30	10
	CancelReportShare	刪除該報表的授權策略。	50	10
資料門戶菜單授權管理	ListPortalMenus	擷取門戶菜單列表。	30	10
	ListPortalMenuAuthorization	擷取門戶菜單的授權列表。	30	10
	AuthorizeMenu	批量新增資料門戶菜單授權。	50	10
	CancelAuthorizationMenu	批量取消資料門戶菜單授權。	50	10
	ChangeVisibilityModel	修改資料門戶菜單是否僅授權可見。	50	10
行級許可權管理	QueryDatasetSwitchInfo	擷取資料集行級許可權開關狀態。	30	10
	UpdateDataLevelPermissionStatus	開啟/關閉資料集行列許可權。	50	10
	ListCubeDataLevelPermissionConfig	擷取資料集行列許可權配置資訊。	30	10
	SetDataLevelPermissionRuleConfig	設定單條資料集行列許可權配置資訊。	50	10
	DeleteDataLevelRuleConfig	刪除資料集行列許可權單條規則配置資訊。	50	10
	AddDataLevelPermissionRuleUsers	針對單條規則增量添加行級許可權對應的使用者。	50	10
	DeleteDataLevelPermissionRuleUsers	針對單條規則刪除行級許可權對應的使用者。	50	10
	SetDataLevelPermissionExtraConfig	針對行級或列級許可權做額外配置。	50	10
	ListDataLevelPermissionWhiteList	擷取資料集的行列許可權白名單列表。	30	10
	SetDataLevelPermissionWhiteList	全量設定行列許可權白名單。	50	10
	AddDataLevelPermissionWhiteList	增量設定行列許可權白名單。	50	10
工作空間管理	UpdateWorkspaceUsersRole	更改空間成員角色。	50	10
	QueryWorkspaceUserList	擷取指定工作空間下的成員列表資訊。	30	10
	DeleteUserFromWorkspace	刪除指定工作空間的成員。	50	10
	QueryOrganizationWorkspaceList	擷取當前組織下的工作空間列表資訊。	30	10
	AddUserToWorkspace	在指定的工作空間添加單個成員。	50	10
	AddWorkspaceUsers	在指定的工作空間大量新增工作空間成員。	50	10
	QueryUserRoleInfoInWorkspace	擷取指定工作空間下成員角色資訊。	30	10
	UpdateWorkspaceUserRole	批次更新工作空間成員的角色資訊。	50	10
報表資源管理	QueryWorksByOrganization	擷取該組織下的報表列表資訊。	30	10
	QueryWorksByWorkspace	擷取該組織中指定空間下的報表列表資訊。	30	10
	QueryReadableResourcesListByUserId	擷取使用者有許可權查看的報表列表資訊。	30	10
	CheckReadable	校正使用者是否有許可權查看報表。	50	10
	QueryEmbeddedInfo	擷取組織下報表嵌入資訊。	30	10
	UpdateEmbeddedStatus	更改報表的嵌入狀態。	50	10
	QueryWorks	查詢報表的相關資訊。	30	10
	QueryWorksBloodRelationship	查詢指定報表的血緣資訊。	30	10
資料集資源管理	QueryDatasetList	擷取指定工作空間的資料集列表資訊。	30	10
	QueryDatasetDetailInfo	擷取指定資料集的詳情。	30	10
	QueryDatasetInfo	擷取資料集詳情。	30	10
收藏管理	ListCollections	擷取收藏列表。	30	10
	SaveFavorites	添加收藏。	50	10
	CancelCollection	移除最愛。	50	10
首頁管理	ListFavoriteReports	擷取指定使用者首頁我的看板的授權作品列表。	30	10
	ListSharedReports	擷取指定使用者首頁我的看板的收藏作品列表。	30	10
	ListRecentViewReports	擷取指定使用者首頁我的看板的最近瀏覽或常看作品列表。	30	10
資料服務	QueryDataService	調用在資料服務中已建立的API。	10	60
嵌入分析	CreateTicket	產生Ticket三方嵌入時的票據Ticket資訊。	50	10
	QueryTicketInfo	擷取使用者嵌入報表的Ticket詳情。	30	10
	DeleteTicket	刪除使用者嵌入報表的Ticket。	50	10
	DelayTicketExpireTime	更新嵌入報表的Ticket的失效時間。	50	10
	UpdateTicketNum	更新嵌入報表的Ticket票據數量。	50	10
開放審批	ResultCallback	自訂審批流回調介面，使用者自行對Quick BI的審批流進行處理。	30	10

查看SDK版本

pom.xml檔案中version的值以SDK擷取地址中的最新版本為準。

您可以通過https://mvnrepository.com/artifact/com.aliyun/aliyun-java-sdk-quickbi-public查看SDK的版本。

如何限制並發的請求QPS不超過限流閾值？

問題描述：由於效能和安全的問題，公用雲環境上Quick BI已經開放的API，預設都帶有限流配置，在使用並發線程調用Quick BI開放API時，若實際並發請求的QPS超過限流閾值，則介面請求失敗。

解決方案：推薦您使用Google的Guava工具組件中的RateLimiter類，進行介面請求的QPS限制。

如果您使用Maven管理Java專案，可以通過在pom.xml檔案中添加Maven依賴。
```
<dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>${google.guava.version}</version>
</dependency>
```
說明
pom.xml檔案中version的值以擷取地址中的最新版本為準，最新版本請參見Guava: Google Core Libraries For Java。

建立和使用RateLimiter。

可以使用create()Factory 方法建立RateLimiter執行個體，具體請參見https://www.baeldung.com/guava-rate-limiter。

// 建立一個30 QPS的流控RateLimiter。
RateLimiter rateLimiter = RateLimiter.create(30);
// 擷取許可，如果QPS超過30，則阻塞等待。
rateLimiter.acquire();
// 獲得許可，才會進行介面請求。
doSomeAPIRequest();

說明

QPS（Query Per Second）是指，每秒鐘請求或任務的數量。

並發數是指系統同時處理的請求或任務的數量。

QPS=並發數/平均回應時間。

Quick BI：SDK使用指南