API標準及多語言預置SDK
本產品（quickbi-public/2022-01-01）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
組織管理
|
API |
標題 |
API概述 |
| 組織使用者管理 | 組織使用者管理 | |
| DeleteUser | 刪除群組織使用者 | 刪除指定組織使用者。 |
| CheckOrganizationMember | 判斷使用者是否屬於組織 | 判斷使用者是否屬於組織。 |
| AddUser | 添加組織成員 | 添加組織成員。 |
| BatchAddFeishuUsers | 批次新增飛書使用者。 | 批次新增飛書使用者。 |
| UpdateUser | 更新群組織成員資訊 | 更新群組織下指定成員的資訊。 |
| QueryUserList | 查詢組織成員列表資訊 | 查詢組織成員列表資訊。 |
| QueryUserInfoByUserId | 根據使用者ID查詢使用者資訊 | 根據使用者ID查詢使用者資訊。 |
| QueryUserInfoByAccount | 根據帳號查詢使用者資訊 | 根據阿里雲ID或阿里雲賬戶名查詢使用者資訊。 |
| 組織使用者群組管理 | 組織使用者群組管理 | |
| UpdateUserGroup | 更新使用者組資訊 | 更新群組織下指定使用者組的資訊。 |
| DeleteUserGroup | 刪除使用者組 | 刪除群組織內的使用者組。 |
| CreateUserGroup | 建立使用者組 | 建立使用者組，可以指定父使用者組。 |
| AddUserGroupMember | 新增成員到使用者組 | 將組織成員添加到指定的使用者組。 |
| AddUserGroupMembers | 大量新增成員到使用者組 | 將使用者大量新增到指定的使用者組中。 |
| DeleteUserGroupMember | 刪除使用者群組成員 | 刪除指定使用者組下的指定成員。 |
| DeleteUserGroupMembers | 使用者批量退出使用者組 | 指定使用者批量退出使用者組。 |
| WithdrawAllUserGroups | 使用者退出所有使用者組 | 使使用者退出所有使用者組，該過程無法復原，請謹慎操作。 |
| GetUserGroupInfo | 根據關鍵字擷取使用者組資訊 | 根據使用者組名稱關鍵字搜尋使用者組資訊。 |
| ListByUserGroupId | 批量查詢使用者組 | 根據使用者組ID批量查詢使用者組資訊。 |
| ListUserGroupsByUserId | 查詢使用者所屬的使用者組資訊列表 | 根據使用者的UserID，查詢該使用者所屬的所有使用者組資訊。 |
| QueryUserGroupListByParentId | 查詢父使用者組下的子使用者組列表 | 擷取指定父使用者組下的子使用者組資訊。 |
| QueryUserGroupMember | 查詢使用者群組成員列表 | 擷取使用者組下的成員列表資訊。 |
| 使用者標籤管理 | 使用者標籤管理 | |
| AddUserTagMeta | 新增組織成員標籤元資訊 | 新增組織成員標籤元資訊。 |
| DeleteUserTagMeta | 刪除群組織成員標籤元資訊 | 刪除群組織成員的標籤元資訊。 |
| UpdateUserTagValue | 更新群組織成員標籤值 | 更新群組織成員標籤值。 |
| QueryUserTagMetaList | 查詢組織成員標籤元資訊列表 | 查詢組織內成員標籤元資訊列表。 |
| QueryUserTagValueList | 查詢組織成員標籤值列表 | 查詢特定使用者標籤值列表。 |
| UpdateUserTagMeta | 更新群組織成員標籤元資訊 | 用於更新群組織成員標籤元資訊。 |
| 角色管理 | 角色管理 | |
| ListWorkspaceUserRolesByUserId | 查詢使用者所有空間角色列表 | 查詢使用者所有空間角色列表。 |
| ListWorkspaceRoleUsers | 擷取指定空間角色下的使用者列表 | 擷取指定空間角色下的使用者列表。 |
| QueryWorkspaceRoleConfig | 擷取指定空間角色的配置資訊 | 擷取指定空間角色的配置。 |
| QueryOrganizationRoleConfig | 擷取指定組織角色的配置資訊 | 擷取指定組織角色的配置。 |
| ListWorkspaceRoles | 擷取空間角色列表 | 擷取空間角色列表。 |
| ListOrganizationRoles | 擷取組織角色列表 | 擷取組織角色列表。 |
| ListOrganizationRoleUsers | 擷取指定組織角色下的使用者列表 | 擷取指定組織角色下的使用者列表。 |
權限管理
|
API |
標題 |
API概述 |
| 報表分享授權管理 | 報表分享授權管理 | |
| AddShareReport | 添加資料作品分享配置 | 添加資料作品的一個分享配置。 |
| CancelReportShare | 刪除資料作品的分享授權 | 刪除資料作品的一個分享授權。 |
| QuerySharesToUserList | 查詢授權給使用者的作品列表 | 查詢授權給使用者的作品列表。 |
| QueryShareList | 查詢作品的分享記錄 | 查詢作品被分享給哪些對象的列表，只返回仍然在有效期間限內的分享配置。 |
| AddWorksAuthorization | 新增作品的協同授權記錄 | 新增作品的協同授權記錄。 |
| 資料入口網站選單授權管理 | 資料入口網站選單授權管理 | |
| AuthorizeMenu | 資料門戶菜單大量授權 | 資料門戶菜單的大量授權，已經授權的會自動略過。 |
| CancelAuthorizationMenu | 批量取消資料門戶菜單授權 | 根據門戶菜單ID，取消指定使用者、使用者組的授權記錄。 |
| ChangeVisibilityModel | 修改資料門戶菜單的可見方式 | 修改資料門戶菜單的可見方式，是否僅授權可見。 |
| ListPortalMenus | 擷取資料門戶菜單列表 | 擷取具體資料門戶下的分層菜單列表。 |
| ListPortalMenuAuthorization | 擷取資料門戶菜單的授權詳情 | 擷取資料門戶菜單的授權詳情列表。 |
| ListWhitePortalMenu | 擷取資料門戶菜單的白名單列表 | 擷取資料門戶菜單的白名單列表。 |
| 列級權限管理 | 列級權限管理 | |
| SetDataLevelPermissionRuleConfig | 設定單條資料集行列許可權配置資訊 | 設定單條資料集行列許可權配置資訊（新增和更新）。 |
| AddDataLevelPermissionRuleUsers | 添加行列許可權規則人群 | 針對單條行列許可權規則增量添加選定的人群。 |
| AddDataLevelPermissionWhiteList | 增量修改行列許可權白名單 | 修改指定資料集行列許可權的白名單。 |
| DeleteDataLevelRuleConfig | 刪除行列許可權規則 | 刪除單條行列許可權規則。 |
| DeleteDataLevelPermissionRuleUsers | 刪除行列規則的人群 | 針對單條行列許可權規則刪除選定的人群。 |
| UpdateDataLevelPermissionStatus | 更新資料集行列許可權開關狀態 | 更新資料集行列許可權開關狀態。 |
| SetDataLevelPermissionExtraConfig | 設定行列許可權額外配置 | 設定行列許可權的額外配置。 |
| SetDataLevelPermissionWhiteList | 設定行級許可權白名單 | 設定指定行級許可權的白名單列表。 |
| QueryDatasetSwitchInfo | 擷取資料集行級許可權開關狀態 | 擷取指定資料集的行級許可權開關狀態。 |
| ListCubeDataLevelPermissionConfig | 擷取資料集行列許可權配置列表 | 擷取指定資料集的行列許可權配置列表。 |
| ListDataLevelPermissionWhiteList | 擷取資料集行列許可權白名單列表 | 根據行列許可權種類，擷取資料集行列許可權的白名單列表。 |
| 開放審批 | 開放審批 | |
| QueryApprovalInfo | 根據審批人擷取相應的審批流資訊 | 根據審批人擷取相應的審批流資訊。 |
| ResultCallback | 自訂審批流回調介面 | 自訂審批流回調介面，使用者自行對Quick BI的審批流進行處理。 |
資源管理
|
API |
標題 |
API概述 |
| 報表資源管理 | 報表資源管理 | |
| UpdateEmbeddedStatus | 更改報表的嵌入狀態 | 更改報表的嵌入狀態，開通嵌入、或者關閉嵌入。 |
| QueryWorksByOrganization | 查詢組織下的所有作品 | 查詢整個組織下的所有作品，可指定作品類型。 |
| QueryWorksByWorkspace | 查詢工作空間下的所有作品 | 查詢組織下某個工作空間下的所有作品，可指定作品類型。 |
| QueryReadableResourcesListByUserIdV2 | 查詢使用者有權查看的作品列表（新） | 查詢使用者有權查看的作品列表(新)。 |
| QueryReadableResourcesListByUserId | 查詢使用者有權查看的作品列表 | 查詢使用者有權查看的作品列表，包含空間下與分享授權的報表。 |
| CheckReadable | 查詢使用者對資料作品的查看許可權 | 查詢使用者對資料作品（儀表板、試算表等）是否有許可權查看。 |
| QueryEmbeddedInfo | 擷取組織嵌入配置 | 擷取組織下的嵌入配置，包括最大嵌入數和已經嵌入數等。 |
| QueryEmbeddedStatus | 查詢報表嵌入狀態 | 查詢某個報表是否已經開通嵌入。 |
| QueryWorks | 查詢資料作品資訊 | 查詢指定資料作品資訊。 |
| QueryWorksBloodRelationship | 查詢資料作品的血緣資訊 | 擷取資料作品的血緣關係，包括各組件引用的資料集以及查詢欄位資訊。目前僅支援的資料作品包含儀表板、試算表、自助取數。 |
| QueryComponentPerformance | 查詢組件效能日誌 | 查詢組件效能日誌。 |
| QueryReportPerformance | 查詢報表效能日誌 | 查詢報表效能日誌。 |
| GetWorksEmbedList | 擷取已經嵌入的報表 | 查詢已嵌入報表列表。 |
| 資料集資源管理 | 資料集資源管理 | |
| UpdateDataSource | 修改資料來源配置 | 修改資料來源配置。 |
| CreateDataset | 根據物理表名稱建立資料集 | 根據物理表名稱建立資料集。 |
| CheckDatasetExisted | 檢查給定的cubeId是否存在 | 檢查給定的cubeId是否存在。 |
| CreateCubeBySql | 根據自訂 SQL 建立資料集。 | 根據自訂 SQL 建立資料集。 |
| AddDataSource | 新增資料來源串連 | 新增資料來源串連資訊。 |
| UpdateCubeBySql | 更新自訂 SQL 資料集。 | 更新自訂 SQL 資料集。 |
| QueryLastAccelerationEngineJob | 通過資料集ID查詢最近一次加速任務 | 通過資料集ID查詢最近一次加速任務。 |
| ListDataSource | 查詢指定空間下的所有資料來源 | 查詢指定空間下的所有資料來源。 |
| DataSetBlood | 查詢引用指定資料集下的作品資訊 | 查詢引用指定資料集下的作品資訊。 |
| DataSourceBlood | 查詢引用指定資料來源下的資料集資訊 | 查詢引用指定資料來源下的資料集資訊。 |
| ModifyApiDatasourceParameters | 修改API資料來源配置 | 修改指定API資料來源的配置。 |
| ListApiDatasource | 查詢API資料來源列表 | 查詢API資料來源列表。 |
| QueryDatasetInfo | 查詢資料集資訊 | 查詢指定資料集的資訊。 |
| QueryDatasetDetailInfo | 查詢資料集詳情 | 查詢指定資料集的詳情，包括所屬資料來源、目錄、以及資料集模型。 |
| QueryDatasetList | 查詢工作空間資料集列表 | 查詢指定工作空間的資料集列表，按照建立時間倒序排列。 |
| AllotDatasetAccelerationTask | 觸發資料集抽取加速 | 觸發資料集Quick引擎的採集加速。 |
| QueryCubePerformance | 查詢資料集效能日誌 | 查詢資料集效能日誌。 |
| QueryCubeOptimization | 查詢資料集最佳化建議 | 查詢資料集最佳化建議。 |
| GetDataSourceConnectionInfo | 擷取資料來源資訊 | 擷取資料來源資訊。 |
| ListAccelerationOfWorkspace | 擷取空間下加速引擎管控頁任務資訊 | 擷取空間下加速引擎管控頁任務資訊。 |
| QueryAccelerationLogByCubeId | 擷取指定資料集的加速任務作業記錄 | 擷取指定資料集的加速任務作業記錄。 |
| 工作空間管理 | 工作空間管理 | |
| CreateWorkspace | 建立工作空間 | 建立工作空間。 |
| AddUserToWorkspace | 新增成員到工作空間 | 新增成員到指定工作空間。 |
| AddWorkspaceUsers | 大量新增成員到工作空間 | 大量新增成員到工作空間。 |
| DeleteUserFromWorkspace | 刪除工作空間成員 | 刪除指定工作空間的成員。 |
| UpdateWorkspaceUsersRole | 批次更新工作空間成員的角色 | 批次更新工作空間成員的角色資訊，已有角色會被覆蓋。 |
| UpdateWorkspaceUserRole | 修改工作空間成員角色 | 修改工作空間下指定成員的角色，已有的角色會被覆蓋。 |
| QueryWorkspaceUserList | 查詢工作空間下的成員列表 | 查詢指定工作空間下的成員列表資訊。 |
| QueryOrganizationWorkspaceList | 擷取組織下的工作空間列表 | 擷取當前組織下的工作空間列表資訊。 |
| QueryUserRoleInfoInWorkspace | 查詢工作空間成員的預置角色 | 擷取指定工作空間成員的預置空間角色資訊。 |
| 收藏管理 | 收藏管理 | |
| SaveFavorites | 添加作品收藏 | 添加使用者的收藏資料作品。 |
| CancelCollection | 取消作品收藏 | 取消使用者收藏的資料作品。 |
| 首頁管理 | 首頁管理 | |
| ListCollections | 擷取使用者收藏作品列表 | 擷取使用者收藏的作品列表。 |
| ListFavoriteReports | 首頁看板收藏列表 | 擷取指定使用者在首頁看板中展示的收藏作品列表。 |
| ListRecentViewReports | 擷取首頁看板常看和足跡列表 | 擷取指定使用者在首頁看板中展示的常看和足跡列表。 |
| ListSharedReports | 擷取首頁看板被授權的作品列表 | 擷取指定使用者在首頁看板中展示的被授權的作品列表。 |
| 訂閱管理 | 訂閱管理 | |
| ManualRunMailTask | 手動執行郵件任務 | 手動執行訂閱的郵件任務。 |
| GetMailTaskStatus | 查看郵件任務運行狀態 | 查看組織內郵件任務運行狀態（即時狀態非最終狀態）。 |
| GetMailTaskList | 擷取訂閱工作清單資訊 | 擷取訂閱工作清單資訊，注意：當調用者ak的許可權不能查看其他人的訂閱任務時，則只能返回當前調用者有許可權的列表。 |
資料管理
|
API |
標題 |
API概述 |
| 資料服務 | 資料服務 | |
| QueryData | 查詢資料 | 對資料服務中已建立的API進行調用。 |
| QueryDataServiceList | 資料服務列表API | 查詢資料服務API列表。 |
| QueryDataService | 調用資料服務API | 對資料服務中已建立的API進行調用。 |
嵌入分析
|
API |
標題 |
API概述 |
| 報表嵌入 | 報表嵌入 | |
| CreateTicket | 產生報表嵌入 ticket。 | 產生報表嵌入需要使用的 ticket。 |
| DeleteTicket | 刪除嵌入ticket | 刪除免登嵌入報表的指定ticket。 |
| DelayTicketExpireTime | 更新嵌入ticket的失效時間 | 更新嵌入報表的ticket的失效時間。 |
| UpdateTicketNum | 更新嵌入ticket票據數量 | 對用於免登嵌入報表的指定的ticket進行更新票據數量操作。 |
| QueryTicketInfo | 查詢嵌入報表ticket詳情 | 擷取免登嵌入報表的指定ticket的詳情資訊。 |
統計分析
|
API |
標題 |
API概述 |
| 資源分析 | 資源分析 | |
| QueryAuditLog | 查詢審計日誌資訊 | 查詢審計日誌資訊。 |
智慧問數
|
API |
標題 |
API概述 |
| 智慧問數嵌入 | 智慧問數嵌入 | |
| CreateTicket4Copilot | 產生智能小Q嵌入Ticket | 用於產生智能小Q嵌入Ticket。 |
| ModifyCopilotEmbedConfig | 修改智能問數嵌入配置 | 修改智能問數嵌入配置。 |
| QueryCopilotEmbedConfig | 擷取開通小Q嵌入的配置列表 | 擷取開通小Q嵌入的配置列表。 |
| QueryDataRange | 擷取資料範圍目錄列表 | 擷取嵌入配置介面的資料範圍目錄列表。 |
| 智慧問數管理 | 智慧問數管理 | |
| ModifyDashboardNl2sqlStatus | 大量編輯儀表板的小Q問數狀態 | 大量編輯儀表板的小Q問數狀態。 |
| QueryDashboardNl2sql | 查詢儀表板的問數資源資訊 | 查詢儀表板的問數資源資訊。 |
| SmartqAuthorize | 批量管理小Q問數的授權 | 批量管理小Q問數的授權。 |
| QueryLlmCubeWithThemeListByUserId | 查看使用者有哪些資料集和分析主題的問數授權 | 查看使用者有哪些資料集和分析主題的問數授權。 |
| SmartqAuthTransfer | 將指定使用者的問數許可權同步給其他使用者 | 將指定使用者的問數許可權同步給其他使用者。 |
| QuerySmartqPermissionByCubeId | 查看使用者是否有某個小Q問數資料集許可權 | 查看使用者是否有某個小Q問數資料集許可權。 |
| QueryDatasetSmartqStatus | 查看資料集是否開通小Q問數 | 查看資料集是否開通小Q問數。 |
| SmartqQueryAbility | 小Q問數查詢 | 小Q問數查詢。 |
其他
|
API |
標題 |
API概述 |
| DeleteAuthorizationByUserId | 刪除指定使用者的協同授權記錄。 | 刪除指定使用者的協同授權記錄。 |
| IpWhiteListConfig | 資料安全-IP白名單配置。 | 資料安全-IP白名單配置。 |
| QueryUserByMobileAccount | 根據綁定的第三方帳號ID查詢UserId。 | 根據綁定的第三方帳號ID查詢UserId。 |
| TransferUsergroup | 遷移使用者群組。 | 遷移使用者群組。 |