API標準及多語言預置SDK
本產品(dataworks-public/2024-05-18)的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK,開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜,需花費 5個工作日左右。因此建議加入我們的服務DingTalk群(147535001692),在專家指導下進行簽名對接。
在使用API前,您需要準備好身份帳號及存取金鑰(AccessKey),才能有效通過用戶端工具(SDK、CLI等)訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求,需通過自簽名方式對接 API,建議優先諮詢我們的支援人員團隊(服務DingTalk群:147535001692),擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露,所有相關資源都將面臨未經授權訪問的風險。為確保安全,建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey,同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下,才使用阿里雲帳號。
Data Agent
|
API |
標題 |
API概述 |
| MCP 服務管理 / MCP Server | MCP 服務管理 / MCP Server | |
| CreateMcpServer | 建立 MCP Server。 | 建立 MCP Server。 |
| DeleteMcpServer | 刪除MCP Server | 刪除 MCP Server |
| UpdateMcpServer | UpdateMcpServer-更新 MCP Server | 更新 MCP Server。 |
| GetMcpServer | 讀取 MCP Server 詳情 | 讀取 MCP Server 詳情 |
| ListMcpServers | 分頁列出 MCP Server | 分頁列出 MCP Server |
| 技能管理 / Skill | 技能管理 / Skill | |
| CreateSkill | 建立 Skill。 | 用於在 DataWorks 中建立一個新的 Skill。 |
| UpdateSkill | 更新 Skill。 | 用於更新指定的 Skill 並產生新版本。 |
| DeleteSkill | 刪除 Skill | 刪除 Skill |
| GetSkill | 讀取Skill詳情 | 根據名稱讀取單個Skill的詳細資料,包括SKILL.md本文與bundle下載連結。 |
| ListSkills | 列出Skill | 分頁查詢當前帳號下的Skill列表。 |
| 智能體管理 / Agent | 智能體管理 / Agent | |
| CreateAgent | 建立 Agent。 | 建立 Agent。 |
| ListCustomAgents | 分頁列出 自訂 Agent | 分頁列出 自訂 Agent |
| DeleteAgent | 刪除 Agent。 | 刪除 Agent。 |
| GetAgent | 讀取 Agent 詳情 | 根據名稱讀取單個 Agent 的詳細資料。 |
| ListAgents | 查詢 Agent 清單。 | 查詢目前租戶可用的 Agent 清單,支援按名稱篩選和分頁。 |
| 會話管理 / Agent Session | 會話管理 / Agent Session | |
| PromptAgentSession | 傳送會話 Prompt。 | 向現有會話傳送使用者 Prompt 並以串流方式傳回 Agent 回應。 |
| LoadAgentSession | 載入恢複Agent會話詳情 | 載入已存在會話的歷史訊息,以 SSE 流式返回。會話不存在時會通過 SSE 輸出一條 code 為 400 的 JSONRPCResponse.error。Content-Type 為 text/event-stream。適用於恢複會話上下文情境。 |
| ListAgentSessions | 查詢工作階段清單。 | 載入 Agent Session 對話歷史清單。 |
| ListAgentSessionArtifacts | 查詢工作階段 Artifact 清單。 | 查詢指定工作階段產出的 Artifact 檔案清單。 |
| GetAgentSessionTokenUsage | 查詢會話Token用量 | 按SessionId彙總查詢該會話累計的AIToken用量 |
| GetAgentSessionArtifactMeta | 查詢 Artifact 元資訊與內容 | 根據會話ID和檔案路徑擷取Artifact的元資訊及本文內容。 |
| CreateAgentSession | 建立新會話。 | 建立一個新的 Agent 會話並回傳會話 ID。 |
| CancelAgentSession | 取消會話。 | 用於中斷指定會話的 Agent 呼叫,支援串流回應中斷。 |
空間管理
|
API |
標題 |
API概述 |
| 工作空間 | 工作空間 | |
| CreateProject | 新建工作空間。 | 建立工作空間。 |
| DeleteProject | 移除工作空間。 | 呼叫 DeleteProject 介面,刪除 DataWorks 工作空間。 |
| UpdateProject | 更新工作空間 | 該介面用於更新DataWorks工作空間。 |
| ListProjects | 擷取工作空間詳情列表 | 該介面用於查詢使用者所在租戶下的DataWorks工作空間列表。 |
| GetProject | 取得工作空間詳情。 | 此介面用於查詢一個 DataWorks 工作空間的詳細資訊。 |
| 空間角色 | 空間角色 | |
| CreateProjectRole | 建立工作空間自訂角色 | 建立工作空間自訂角色 |
| DeleteProjectRole | 刪除工作空間自訂角色 | 刪除空間自訂角色 |
| UpdateProjectRole | 更新工作空間自訂角色。 | 更新空間自訂角色權限。 |
| GetProjectRole | 擷取工作空間角色詳情 | 查詢工作空間角色詳情。 |
| ListProjectRoles | 擷取工作空間角色詳情列表 | 分頁查詢工作空間角色詳情。 |
| 空間成員 | 空間成員 | |
| CreateProjectMember | 建立工作空間成員。 | 新增工作空間成員同時授予工作空間角色。 |
| DeleteProjectMember | 移除工作區成員。 | 移除工作區成員及其獲授予的工作區角色。 |
| GrantMemberProjectRoles | 授予工作空間成員新的空間角色 | 授予工作空間成員角色。 |
| RevokeMemberProjectRoles | 撤銷工作區成員的工作區角色。 | 撤銷工作區成員的角色。 |
| GetProjectMember | 查詢工作空間成員詳情 | 查詢工作空間成員詳情。 |
| ListProjectMembers | 查詢工作空間成員列表 | 分頁查詢工作空間成員詳情。 |
資料來源
|
API |
標題 |
API概述 |
| UpdateDataSource | 修改資料來源 | 根據資料來源ID,修改指定的資料來源。 |
| TestDataSourceConnectivity | 測試資料來源的連通性 | 測試資料來源在資源群組上的連通性。 |
| CreateDataSource | 建立資料來源。 | 在指定專案空間建立一筆資料來源,可以是開發環境或生產環境。 |
| DeleteDataSource | 刪除資料來源 | 根據資料來源ID,刪除指定的資料來源。 |
| CloneDataSource | 複製資料來源。 | 根據現有的資料來源,複製一條新的資料來源。 |
| ListDataSources | 擷取資料來源列表 | 根據資料來源商務資訊,查詢符合的資料來源列表。 |
| 資料來源分享規則 | 資料來源分享規則 | |
| CreateDataSourceSharedRule | 建立資料來源分享規則 | 建立一條資料來源分享規則,即將資料來源分享給其他空間或者子帳號使用。 |
| DeleteDataSourceSharedRule | 刪除資料來源分享規則 | 根據資料來源分享規則ID,刪除一條資料來源分享規則。 |
| ListDataSourceSharedRules | 查詢資料來源分享規則列表 | 查詢某個資料來源配置的規則列表。 |
運算資源
|
API |
標題 |
API概述 |
| DeleteComputeResource | 刪除計算資源 | 根據計算資源ID,刪除指定的計算資源。 |
| GetComputeResource | 查看計算資源詳情 | 根據計算資源ID,查詢指定的計算資源。 |
| UpdateComputeResource | 修改計算資源 | 根據計算資源ID,修改指定的計算資源。 |
| ListComputeResources | 擷取計算資源清單 | 根據計算資源商務資訊,查詢符合的計算資源清單。 |
| CreateComputeResource | 建立運算資源。 | 在指定的工作區中建立運算資源。該運算資源可位於開發環境或生產環境。 |
| GetComputeResourceAuthUserMappings | 取得運算資源帳號映射資訊。 | 查詢運算資源使用者映射,支援 EMR 和 Serverless Spark 類型資源。 |
| UpdateComputeResourceAuthUserMappings | 更新計算資源帳號映射。 | 更新計算資源帳號映射,目前支援 EMR、Serverless Spark 類型資源。 |
資源群組管理
|
API |
標題 |
API概述 |
| 資源群組 | 資源群組 | |
| CreateResourceGroup | 建立資源群組。 | 建立資源群組。 |
| DeleteResourceGroup | 刪除通用資源群組 | 刪除通用資源群組。 |
| UpdateResourceGroup | 更新資源群組基本資料 | 更新資源群組基本資料。 |
| GetResourceGroup | 根據 ID 取得資源群組資訊。 | 根據 ID 取得指定資源群組的資訊。 |
| ListResourceGroups | 擷取資源群組列表 | 擷取資源群組列表。 |
| DissociateProjectFromResourceGroup | 將資源群組和某個工作空間解除綁定 | 將資源群組和某個工作空間解除綁定。 |
| AssociateProjectToResourceGroup | 綁定資源群組到某个工作空間。 | 綁定資源群組到某个工作空間。 |
| ListResourceGroupAssociateProjects | 擷取資源群組綁定工作空間列表 | 擷取資源群組綁定工作空間列表。 |
| ListResourceGroupMetricData | 查詢資源群組指標資料 | 查詢資源群組指標資料。 |
| 路由 | 路由 | |
| CreateRoute | 建立網路資源的路由 | 建立網路資源的路由。 |
| DeleteRoute | 刪除網路資源的路由 | 刪除網路資源的路由。 |
| UpdateRoute | 更新路由資訊 | 更新路由資訊。 |
| GetRoute | 根據ID擷取指定路由資訊 | 根據ID擷取指定路由資訊。 |
| ListRoutes | 取得網路資源的路由清單。 | 取得網路資源的路由清單。 |
| 網路 | 網路 | |
| CreateNetwork | 建立資源群組網路 | 建立並綁定通用資源群組網路資源。 |
| DeleteNetwork | 從通用資源群組中解除關聯並刪除網路資源。 | 從通用資源群組中解除關聯並刪除網路資源。 |
| GetNetwork | 擷取某個網路資源詳細資料 | 擷取某個網路資源詳細資料。 |
| ListNetworks | 擷取資源群組網路資源列表 | 擷取資源群組網路資源列表。 |
映像管理
|
API |
標題 |
API概述 |
| CreateImage | 建立映像。 | 建立映像。 |
| UpdateImage | 更新映像。 | 更新映像。 |
| RunImageTest | 執行映像測試。 | 執行映像測試。 |
| ListImageTestResults | 取得映像測試結果清單。 | 取得映像測試結果清單。 |
| GetImageTestResult | 取得指定映像測試任務結果。 | 取得映像測試結果詳情。 |
| CancelImageTest | 取消映像測試。 | 取消映像測試。 |
| PublishImage | 發佈映像。 | 發佈映像。 |
| BuildImage | 建構映像。 | 建構映像。 |
| RollbackImage | 復原映像。 | 復原映像。 |
| EnableImage | 啟用映像。 | 啟用映像。 |
| DisableImage | 停用映像。 | 停用映像。 |
| GetImage | 根據 ID 取得指定映像詳細資訊。 | 根據映像 ID 取得指定映像詳細資訊。 |
| ListImages | 擷取鏡像列表 | 擷取鏡像列表。 |
| ListImageVersions | 擷取指定鏡像版本詳情 | 擷取指定鏡像版本詳情。 |
| DeleteImage | 刪除映像。 | 刪除映像。 |
| AssociateProjectToImage | 關聯映像到工作空間。 | 關聯映像到工作空間。 |
| DissociateProjectFromImage | 解除鏡像與工作空間的關聯 | 解除鏡像與工作空間的關聯。 |
| ListImageAssociatedProjects | 查詢鏡像關聯的工作空間列表 | 查詢鏡像關聯的工作空間列表。 |
資料開發(新版)
|
API |
標題 |
API概述 |
| 快照 | 快照 | |
| GetSnapshot | 取得版本快照詳細資訊。 | 取得版本快照詳細資訊。 |
| ListSnapshots | 取得版本快照清單。 | 取得版本快照清單。 |
| 元件 | 元件 | |
| CreateComponent | 建立元件。 | 建立元件。 |
| DeleteComponent | 刪除元件。 | 刪除元件。 |
| GetComponent | 擷取組件詳情 | 擷取組件資訊。 |
| UpdateComponent | 更新群組件 | 更新群組件。 |
| ListComponents | 擷取組件列表 | 擷取組件列表。 |
| 節點 | 節點 | |
| CreateNode | 建立資料開發節點。 | 呼叫此介面,會在新版資料開發中建立一個資料開發節點。 |
| DeleteNode | 刪除資料開發節點。 | 呼叫此介面,可以刪除指定的資料開發節點。 |
| UpdateNode | 更新資料開發節點資訊 | 調用此介面,可以更新資料開發節點資訊。更新通過累加式更新的方式進行,更新的資訊通過FlowSpec進行描述。 |
| MoveNode | 移動資料開發節點路徑 | 調用此介面,可以將指定的資料開發節點的路徑移動到指定位置。 |
| RenameNode | 重新命名資料開發節點 | 調用此介面,可以重新命名資料開發節點。 |
| GetNode | 擷取資料開發節點詳情 | 擷取指定的資料開發節點詳細資料。 |
| ListNodes | 取得資料開發節點清單。 | 分頁取得資料開發節點清單,也可以透過篩選條件對清單進行篩選查詢。 |
| ListNodeDependencies | 取得資料開發節點的相依節點。 | 分頁取得指定資料開發節點的相依節點。 |
| 工作流程定義 | 工作流程定義 | |
| CreateWorkflowDefinition | 建立資料開發工作流程。 | 呼叫此介面,在資料開發指定目錄下建立一個工作流程。 |
| ImportWorkflowDefinition | 匯入資料開發工作流。 | 呼叫此介面,可以將透過 FlowSpec 定義的工作流節點和其內部的子節點都匯入到資料開發中。 |
| DeleteWorkflowDefinition | 刪除資料開發工作流程。 | 呼叫此介面,在資料開發中刪除指定的工作流程。 |
| UpdateWorkflowDefinition | 更新資料開發工作流程資訊 | 調用此介面,可以更新資料開發工作流程基本資料。更新以累加式更新的方式進行,更新資訊以FlowSpec格式描述。 |
| MoveWorkflowDefinition | 移動資料開發工作流程路徑 | 調用此介面,可以將指定的資料開發工作流程移動到資料開發目錄的目標路徑。 |
| RenameWorkflowDefinition | 重新命名資料開發工作流程 | 調用此介面,可以重新命名資料開發工作流程。 |
| GetWorkflowDefinition | 擷取資料開發工作流程詳情 | 調用該介面,可以擷取指定工作流程的詳細資料。 |
| ListWorkflowDefinitions | 擷取資料開發工作流程列表 | 分頁擷取資料開發工作流程列表,也可以根據篩選條件對工作流程進行篩選。 |
| 資源 | 資源 | |
| CreateResource | 建立資料開發檔案資源。 | 建立資料開發的檔案資源。檔案資源資訊以 FlowSpec 格式定義。 |
| DeleteResource | 刪除資料開發檔案資源 | 調用此介面,可以刪除指定的資料開發檔案資源。 |
| UpdateResource | 更新資料開發檔案資源資訊 | 調用此介面,可以更新資料開發檔案資源的基本資料。更新以累加式更新的方式進行,更新資訊以FlowSpec格式描述。 |
| GetResource | 擷取資料開發檔案資源詳情 | 擷取指定檔案資源的詳細資料。 |
| ListResources | 取得資料開發檔案資源清單。 | 呼叫此介面,可以分頁取得資源檔案,也可以對資源進行篩選。 |
| MoveResource | 移動資料開發檔案資源路徑 | 調用此介面,可以將指定資料開發檔案資源移動到指定的資料開發目錄中。 |
| RenameResource | 重新命名資料開發檔案資源 | 調用此介面,可以對資料開發檔案資源進行重新命名。 |
| 函數 | 函數 | |
| CreateFunction | 建立資料開發函數。 | 呼叫此介面,可以在資料開發中建立一個 UDF 函數。UDF 函數資訊以 FlowSpec 格式描述。 |
| DeleteFunction | 刪除資料開發函數 | 調用該介面,在資料開發中刪除指定的udf函數。 |
| UpdateFunction | 更新資料開發函數資訊 | 調用此介面,可以更新udf函數資訊。更新以累加式更新的方式進行,更新資訊通過FlowSpec格式描述。 |
| MoveFunction | 移動資料開發函數路徑 | 調用此介面,可以將指定udf函數移動到資料開發目錄的目標路徑。 |
| RenameFunction | 重新命名資料開發函數 | 調用此介面,可以對指定的udf函數進行重新命名。 |
| GetFunction | 擷取資料開發函數詳情 | 擷取指定資料開發udf函數的詳細資料。 |
| ListFunctions | 取得資料開發函式清單。 | 呼叫此介面,可以分頁取得資料開發中的 UDF 函式清單,也可以使用篩選條件篩選 UDF 函式。 |
| 發佈流程 | 發佈流程 | |
| CreatePipelineRun | 建立發佈流程。 | 呼叫此介面,可以對新版資料開發中的實體建立一個發佈流程。 |
| AbolishPipelineRun | 終止發佈流程。 | 呼叫此介面會將指定發佈流程的狀態變更為終止狀態,但不會刪除此發佈流程,仍可透過查詢介面查詢到。 |
| ExecPipelineRunStage | 執行發佈流程的指定階段。 | 執行發佈流程的指定階段。 |
| GetPipelineRun | 取得發佈流程詳細資訊。 | 呼叫此介面,取得發佈流程詳細資訊。 |
| ListPipelineRuns | 擷取發布流程列表 | 分頁擷取發布流程列表,也可以使用篩選條件對發布流程進行篩選。 |
| ListPipelineRunItems | 擷取發布內容 | 通過發布流程的ID擷取發布內容。 |
| 個人開發環境 | 個人開發環境 | |
| ListServerIdeInstances | 查詢個人開發環境執行個體列表。 | 分頁查詢個人開發環境執行個體列表。 |
| GetServerIdeInstance | 查詢個人開發環境執行個體。 | 查詢指定個人開發環境執行個體的詳細資訊。 |
| ListServerIdeImages | 查詢個人開發環境映像清單。 | 分頁查詢個人開發環境可用的映像清單。 |
| ListServerIdeEcsSpecs | 查詢個人開發環境規格清單。 | 查詢個人開發環境可用的 ECS 規格清單。 |
| CreateServerIdeInstance | 建立個人開發環境執行個體。 | 建立個人開發環境執行個體。 |
| UpdateServerIdeInstance | 更新個人開發環境執行個體。 | 更新指定個人開發環境執行個體的設定。 |
| StopServerIdeInstance | 停止個人開發環境執行個體。 | 停止指定的個人開發環境執行個體。 |
| StartServerIdeInstance | 啟動個人開發環境執行個體。 | 啟動指定的個人開發環境執行個體。 |
| DeleteServerIdeInstance | 刪除個人開發環境執行個體。 | 刪除指定的個人開發環境執行個體。 |
資料開發(舊版)
|
API |
標題 |
API概述 |
| 檔案 | 檔案 | |
| CreateFile | 在資料開發中建立一個檔案。 | 呼叫 CreateFile,在資料開發中建立一個檔案。目前不支援呼叫該介面建立資料整合節點任務。 |
| CreateResourceFile | 建立資源檔 | 支援使用者指定自己的檔案(比如jar,py,arhive,file等)建立資料開發資源檔。 |
| CreateUdfFile | 在資料開發中建立函數類型檔案 | 調用CreateUdfFile,在資料開發中建立函數類型檔案。 |
| UpdateFile | 更新已有的檔案節點 | 調用UpdateFile更新已建立的檔案。 |
| UpdateUdfFile | 更新函數的檔案資訊 | 調用UpdateUdfFile更新函數的檔案資訊。 |
| GetFile | 擷取檔案的詳情 | 該介面用於擷取檔案的詳情。 |
| ListFiles | 查詢檔案清單。 | 透過呼叫 ListFiles 查詢檔案清單。 |
| SubmitFile | 提交檔案至調度系統開發環境 | 提交檔案至調度系統的開發環境,產生對應的任務。 |
| DeployFile | 部署檔案。 | 將檔案部署至生產環境。 |
| 資料夾 | 資料夾 | |
| CreateFolder | 建立檔案夾 | 調用CreateFolder建立檔案夾。 |
| DeleteFolder | 刪除資料開發頁面的檔案夾 | 調用DeleteFolder刪除資料開發頁面的檔案夾。 |
| UpdateFolder | 更新檔案夾的資訊 | 調用UpdateFolder更新檔案夾的資訊。 |
| GetFolder | 擷取檔案夾的詳情 | 調用GetFolder擷取檔案夾的詳情。 |
| ListFolders | 查詢資料夾的清單。 | 呼叫 ListFolders 查詢資料夾的清單。 |
| 業務流程 | 業務流程 | |
| CreateBusiness | 建立業務流程。 | 呼叫 CreateBusiness,建立資料開發(DataStudio)的業務流程。 |
| DeleteBusiness | 刪除商務程序 | 調用DeleteBusiness刪除商務程序。 |
| UpdateBusiness | 更新商務程序 | 該介面用於更新商務程序。 |
| GetBusiness | 查詢業務流程的詳細資訊。 | 呼叫 GetBusiness 查詢業務流程的詳細資訊。 |
| ListBusiness | 查詢商務程序的列表 | 調用ListBusiness查詢商務程序的列表。 |
| 發佈套件 | 發佈套件 | |
| GetDeploymentPackage | 取得發佈包的詳細資訊。 | 呼叫 GetDeploymentPackage 取得發佈包的詳細資訊。 |
| ListDeploymentPackages | 查詢發佈包清單資訊。 | 查詢發佈包清單。 |
| ListDeploymentPackageFiles | 取得待發布的檔案版本清單。 | 取得待發布的檔案版本清單。 |
| 檔案版本 | 檔案版本 | |
| GetFileVersion | 取得檔案版本詳細資訊。 | 取得檔案的版本詳細資訊。 |
| ListFileVersions | 查詢檔案版本。 | 查詢檔案的版本清單。 |
| 擴充點事件 | 擴充點事件 | |
| UpdateIDEEventResult | 更新擴充點事件的檢查結果。 | 回呼擴充點訊息的檢查結果。 |
| GetIDEEventDetail | 查詢觸發擴充點事件時的資料快照 | 根據DataWorks開放訊息的訊息ID,查詢觸發擴充點事件時的擴充點資料快照。 |
| 資料表 | 資料表 | |
| EstablishRelationTableToBusiness | 匯入表至商務程序 | 相當於在資料開發頁面按右鍵商務程序,選擇匯入表的操作。 |
資料整合
|
API |
標題 |
API概述 |
| 同步任務 | 同步任務 | |
| CreateDIJob | 建立資料整合同步任務。 | 建立資料整合新版任務。 |
| UpdateDIJob | 更新Data Integration同步任務 | 更新Data Integration任務。 |
| DeleteDIJob | 刪除Data Integration同步任務 | 刪除Data Integration新版任務。 |
| StopDIJob | 停止資料整合同步任務。 | 中止資料整合任務。 |
| StartDIJob | 啟動Data Integration同步任務 | 啟動Data Integration新版任務。 |
| GetDIJob | 查看Data Integration同步任務配置詳情 | 查看Data Integration任務。 |
| GetDIJobLog | 檢視資料整合同步任務的執行日誌。 | 取得資料整合任務日誌。 |
| ListDIJobs | 擷取Data Integration同步任務配置列表 | 查詢Data Integration新版工作清單,包括整庫同步即時任務,整庫同步離線任務,單表同步即時任務等Data Integration任務。 |
| ListDIJobRunDetails | 擷取Data Integration同步任務啟動並執行執行進展 | 擷取Data Integration運行資訊。 |
| ListDIJobMetrics | 查看Data Integration同步任務運行指標 | 擷取Data Integration任務指標。 |
| ListDIJobEvents | 擷取Data Integration同步任務的運行事件列表 | 擷取Data Integration任務事件。 |
| 任務警示 | 任務警示 | |
| CreateDIAlarmRule | 建立資料整合同步任務警示規則。 | 建立資料整合警示規則。 |
| UpdateDIAlarmRule | 更新Data Integration同步任務警示規則 | 更新Data Integration警示規則。 |
| DeleteDIAlarmRule | 刪除Data Integration同步任務警示規則 | 刪除Data Integration警示規則。 |
| ListDIAlarmRules | 擷取Data Integration同步任務警示規則列表 | 查看Data Integration警示規則。 |
資料地圖
|
API |
標題 |
API概述 |
| 語意分析 | 語意分析 | |
| ListSemanticJobs | 查詢語意任務清單。 | 分頁查詢目前租戶的語意任務定義。清單項目中的 Name、ProjectId 和 Source 可分別複用於執行/刪除、執行詳情查詢和核對輸入範圍。 |
| CreateSemanticJob | 建立語義任務。 | 儲存可重複使用的語義任務定義。若使用單一檔案來源,請先申請並完成附件上傳;建立成功後使用回傳的 Name 呼叫 RunSemanticJob。 |
| DeleteSemanticJob | 刪除語意任務。 | 按已建立任務的 Name 刪除任務定義。當任務正在執行時,請先使用該執行中的 ExecutorJobId 呼叫 KillSemanticJob 並確認停止。 |
| DownloadSemanticResults | 取得語意任務結果下載地址。 | 在執行結束後,按任務名稱和可選執行識別碼返回產物下載地址;不傳 JobRunId 時返回該任務最新一次執行的結果。 |
| GetSemanticJobDetail | 查詢語意任務執行詳情。 | 使用 RunSemanticJob 或 ListSemanticJobRuns 返回的 ExecutorJobId 查詢執行器狀態與執行配置。 |
| RunSemanticJob | 執行語意任務。 | 按已建立任務的 Name 提交執行並回傳本次執行與執行器識別碼。呼叫成功表示已提交,不代表語意模型結果已經產生。 |
| ListSemanticJobRuns | 查詢語意任務執行記錄。 | 按已建立任務的 Name 分頁查詢其執行記錄;記錄中的 JobRunId 可用於取得指定執行的結果,ExecutorJobId 可用於詳細資訊、日誌與停止。 |
| GetSemanticJobLog | 查詢語意任務執行日誌。 | 使用 RunSemanticJob 或 ListSemanticJobRuns 返回的 ExecutorJobId 查詢執行日誌。目前 POP 合約僅公開任務與工作空間識別碼,並返回預設日誌片段。 |
| KillSemanticJob | 停止語意任務執行。 | 使用 RunSemanticJob 或 ListSemanticJobRuns 返回的 ExecutorJobId 停止指定執行。呼叫成功僅表示停止請求已受理,最終狀態請透過 GetSemanticJobDetail 查詢。 |
| UploadSemanticFile | 申請語義任務附件上傳地址。 | 申請臨時 OSS PUT 上傳地址後,先在有效期內完成 PUT 上傳,再將返回的 FileId 填入 CreateSemanticJob 的 ReferenceFileIds。 |
| 自訂屬性 | 自訂屬性 | |
| ListCustomAttributes | 查詢自訂屬性清單。 | 查詢自訂屬性定義清單。 |
| GetCustomAttribute | 擷取自訂屬性 | 擷取自訂屬性定義詳情。 |
| CreateCustomAttribute | 建立自訂屬性。 | 建立自訂屬性定義。 |
| UpdateCustomAttribute | 更新自訂屬性 | 更新自訂屬性定義。 |
| DeleteCustomAttribute | 刪除自訂屬性 | 刪除自訂屬性定義。 |
| 自訂中繼資料實體定義 | 自訂中繼資料實體定義 | |
| ListMetaEntityDefs | 查詢中繼資料實體定義清單。 | 查詢自訂實體定義清單(包括自訂實體類型和擴充表類型) |
| GetMetaEntityDef | 擷取中繼資料實體定義 | 擷取自訂實體定義詳情。 |
| CreateMetaEntityDef | 建立中繼資料實體類型定義。 | 建立中繼資料實體定義(包括純自訂類型和擴充表類型) |
| UpdateMetaEntityDef | 更新中繼資料實體定義。 | 更新中繼資料實體定義(包含純自訂類型和擴充表類型) |
| DeleteMetaEntityDef | 刪除中繼資料實體定義。 | 刪除中繼資料實體定義(包含純自訂類型和擴充表類型) |
| 中繼資料採集器 | 中繼資料採集器 | |
| ListCrawlerTypes | 擷取資料地圖中繼資料採集器類型列表 | 查詢資料地圖支援的中繼資料採集器類型列表,其中包含中繼資料採集器類型,及給定類型支援的子類型和子類型之間的層級關係資訊。 |
| GetCrawlerTypeCapabilities | 查詢採集器類型能力。 | 查詢目前地域支援建立的採集器類型及其採集範圍、排程和擴充設定能力。 |
| CreateCrawler | 建立中繼資料採集器。 | 建立一個中繼資料採集器,並設定資料來源、採集範圍、資源群組及排程方式。 |
| ListCrawlers | 查詢中繼資料採集器清單。 | 分頁查詢中繼資料採集器,並可按工作空間、資料來源、類型、環境、負責人和名稱篩選。 |
| GetCrawler | 查詢中繼資料採集器詳情。 | 查詢指定中繼資料採集器的設定、狀態和最近一次執行資訊。 |
| UpdateCrawler | 更新中繼資料採集器。 | 更新指定中繼資料採集器的資源群組、採集範圍、排程和擴充配置。 |
| RunCrawler | 執行中繼資料採集器。 | 觸發指定中繼資料採集器執行,並傳回受理狀態及關聯的工作執行個體資訊。 |
| StopCrawler | 停止中繼資料採集器執行。 | 停止指定中繼資料採集器目前正在執行的執行任務。 |
| ListCrawlerRuns | 查詢採集器執行記錄。 | 分頁查詢指定中繼資料採集器的執行記錄,並可按時間範圍和執行狀態篩選。 |
| DeleteCrawler | 刪除中繼資料採集器。 | 刪除指定的中繼資料採集器。 |
| 中繼資料實體 | 中繼資料實體 | |
| 自訂實體 | 自訂實體 | |
| ListMetaEntities | 查詢中繼資料實體清單。 | 查詢中繼資料實體清單-目前僅支援純自訂類型。 |
| GetMetaEntity | 擷取中繼資料實體詳情 | 擷取中繼資料實體詳情,當前僅支援純自訂類型 |
| BatchCreateMetaEntities | 批次建立中繼資料實體。 | 批次建立中繼資料實體,同一批次需要為同一種類型,目前僅支援純自訂類型和擴充表類型(對應 Database/Table)。 |
| UpdateMetaEntity | 更新中繼資料實體 | 更新中繼資料實體,支援更新建立的自訂類型對象或者擴充表對象(Database/Table/Column) |
| BatchDeleteMetaEntities | 批次刪除中繼資料實體。 | 批次刪除中繼資料實體物件。支援刪除自訂實體及擴充表類型物件(資料庫/資料表)。不支援單獨刪除欄位。您可以透過刪除資料表來刪除關聯的欄位物件。 |
| 資料目錄 | 資料目錄 | |
| ListCatalogs | 查詢資料地圖資料目錄列表 | 查詢資料地圖下的資料目錄列表,當前支援dlf與starrocks類型。 dlf類型返回支援的所有資料目錄列表,starrocks類型返回特定執行個體下的資料目錄列表。 |
| GetCatalog | 取得資料地圖資料目錄詳情。 | 取得資料地圖中指定資料目錄的詳細資訊,目前支援 dlf 與 starrocks 類型。 |
| 資料庫 | 資料庫 | |
| ListDatabases | 查詢資料地圖資料庫列表 | 查詢資料地圖中給定執行個體/叢集/資料目錄下的資料庫列表。 對於dlf/starrocks類型,查詢給定資料目錄下的資料庫列表,其中starocks類型僅支援查詢Internal Catalog; 對於其他類型,查詢給定執行個體/叢集下的資料庫列表。 |
| GetDatabase | 擷取資料地圖資料庫詳情 | 擷取資料地圖給定資料庫的詳情資訊。 |
| 結構描述 | 結構描述 | |
| ListSchemas | 查詢資料地圖資料庫模式列表 | 查詢資料地圖中給定資料庫或maxcompute專案下的模式列表,當前支援maxcompute和holo類型。 |
| GetSchema | 擷取資料地圖資料庫模式資訊 | 擷取資料地圖中給定模式的詳細資料,當前支援MaxCompute和Hologres類型。 |
| 資料表 | 資料表 | |
| ListTables | 查詢資料地圖資料表清單。 | 查詢資料地圖中的資料表清單。 對於不支援 schema 層級的類型,支援查詢指定資料庫下的資料表清單; 對於支援 schema 層級的類型,支援查詢指定資料庫/MaxCompute 專案/模式下的資料表清單。 返回結果中僅包含資料表基礎資訊,不包含技術中繼資料與業務中繼資料資訊。 |
| GetTable | 取得資料地圖資料表詳細資訊。 | 取得資料地圖中指定資料表的詳細資訊。是否傳回業務中繼資料為選用項目。 |
| UpdateTableBusinessMetadata | 更新資料地圖資料表的業務中繼資料。 | 更新資料地圖資料表的業務中繼資料,目前僅支援更新表的使用說明和自訂屬性。 |
| SubmitBatchChangeTableOwner | 批次修改表負責人。 | 提交批次轉交表 Owner。 |
| GetBatchChangeTableOwnerStatus | 取得批次轉交表負責人狀態。 | 查詢批次轉交表 Owner 狀態。 |
| 欄位 | 欄位 | |
| ListColumns | 查詢資料地圖資料表欄位清單。 | 查詢資料地圖指定資料表的欄位清單。 |
| GetColumn | 取得資料地圖資料表欄位資訊。 | 取得資料地圖資料表給定欄位的詳細資訊。 |
| UpdateColumnBusinessMetadata | 更新資料地圖資料表欄位的業務中繼資料 | 更新資料地圖資料表給定欄位的業務中繼資料,當前僅支援更新欄位的業務描述和自訂屬性。 |
| 資料集 | 資料集 | |
| ListDatasets | 查詢資料集列表 | 查詢資料集列表,當前支援DataWorks資料集與PAI資料集。 |
| GetDataset | 擷取資料集詳情 | 擷取資料集的詳細資料。 |
| CreateDataset | 建立資料集。 | 建立資料集,僅支援在使用者已加入的工作空間建立資料集,且目前僅支援建立 DataWorks 資料集,單租戶下限制資料集最大數量為 2000。 |
| UpdateDataset | 更新資料集 | 更新資料集資訊,僅支援DataWorks資料集,要求操作者為資料集的建立者或資料集所在工作空間的管理員 |
| DeleteDataset | 刪除資料集。 | 刪除資料集,僅支援刪除 DataWorks 資料集,並會級聯刪除對應的資料集版本,要求操作者為資料集的建立者或資料集所在工作空間的管理員。 |
| 資料集版本 | 資料集版本 | |
| ListDatasetVersions | 擷取資料集版本列表 | 查詢給定資料集的版本列表。 |
| GetDatasetVersion | 擷取資料集版本資訊 | 擷取給定資料集版本資訊 |
| CreateDatasetVersion | 建立資料集版本。 | 建立資料集版本,目前僅支援 DataWorks 資料集,支援最大版本數為 20 |
| UpdateDatasetVersion | 更新資料集版本資訊 | 更新資料集版本資訊,僅支援DataWorks資料集,要求操作者為資料集的建立者或資料集所在工作空間的管理員 |
| DeleteDatasetVersion | 刪除資料集版本。 | 刪除資料集版本,僅支援刪除 DataWorks 非 v1 版本資料集,v1 版本資料集需透過 DeleteDataset 介面完成刪除。 要求操作者為資料集的建立者或資料集所在工作空間的管理員。 |
| PreviewDatasetVersion | 預覽資料集版本內容 | 預覽指定版本資料集內容,當前僅支援OSS類型資料集下文字檔預覽 當前支援的MIME類型有 1\. application/json 2\. application/xml 3\. text/html 4\. text/plain 5\. application/octet-stream。 |
| 分區 | 分區 | |
| ListPartitions | 查詢資料地圖資料表的分割區清單。 | 查詢資料地圖指定資料表的分割區清單,目前支援 MaxCompute 和 HMS(EMR 叢集)類型。 |
| GetPartition | 擷取資料地圖資料表的分區詳情 | 擷取資料地圖資料表的分區詳情,當前僅支援MaxCompute和hms(EMR叢集)類型。 |
| 血緣關係 | 血緣關係 | |
| ListLineageRelationships | 查詢資料地圖中的資料血緣關係清單。 | 查詢 DataWorks 資料地圖中兩個指定實體(資料表、欄位、OSS 檔案等)之間的資料血緣關係清單。 |
| GetLineageRelationship | 取得資料地圖血緣關係。 | 取得資料地圖中指定的血緣關係詳細資訊。 |
| DeleteLineageRelationship | 刪除資料地圖血緣關係。 | 刪除指定的資料地圖血緣關係。 |
| CreateLineageRelationship | 註冊資料地圖血緣關係 | 註冊資料地圖的血緣關係。透過此介面,可以在 DataWorks 納管元資料實體之間建立血緣關係,包括表與表、欄位與欄位、表與欄位、資料集與表等場景;也可以在納管實體與使用者自行註冊的自訂實體物件之間建立血緣關係。介面相容非納管自訂物件,但該方式已不再推薦。呼叫前需確保參與血緣註冊的納管實體已存在於 DataWorks 平台。 |
| ListLineages | 查詢資料地圖實體的資料血緣清單。 | 查詢 DataWorks 資料地圖中指定實體的上游與下游血緣實體,並可選擇是否包含詳細的血緣關係資訊。 |
| 中繼資料集合 | 中繼資料集合 | |
| ListMetaCollections | 查詢資料地圖集合清單。 | 查詢資料地圖集合清單,支援查詢資料地圖類目以及資料專輯兩種類型。 |
| CreateMetaCollection | 建立資料地圖集合對象 | 建立資料地圖集合對象,支援建立資料地圖類目(包括多級子類目)、資料專輯(專輯子類目)兩種類型的集合對象。 |
| GetMetaCollection | 擷取資料地圖集合資訊 | 擷取資料地圖給定集合的詳細資料,支援查詢資料地圖類目和資料專輯兩種類型。 |
| UpdateMetaCollection | 更新資料地圖集合對象 | 更新資料地圖集合對象,包括資料地圖類目和資料專輯,支援更新集合名稱,描述和管理員資訊。 更新資料專輯時,要求調用者具有AliyunDataWorksFullAccess 許可權,或者為專輯的建立者或管理員。 |
| DeleteMetaCollection | 刪除資料地圖集合對象 | 刪除給定資料地圖中的集合對象,包括資料地圖類目和資料專輯。 刪除資料專輯時,要求調用者具有AliyunDataWorksFullAccess 許可權,或者為專輯的建立者或管理員。 |
| ListEntitiesInMetaCollection | 查詢資料地圖集合中的實體列表 | 查詢資料地圖集合中的實體列表,集合支援資料地圖類目和資料專輯,實體當前僅支援資料表類型。 |
| AddEntityIntoMetaCollection | 向資料地圖集合中新增實體物件。 | 向資料地圖集合中新增指定的實體物件,集合物件支援資料地圖類目與資料專輯兩種類型,實體物件目前僅支援資料表類型。 向資料專輯新增實體時,要求呼叫者具有 AliyunDataWorksFullAccess 權限,或者為專輯的建立者或管理員。 |
| RemoveEntityFromMetaCollection | 從資料地圖集合中移除實體物件 | 從資料地圖集合中移除實體物件,集合支援資料地圖類目和資料專輯,實體當前僅支援資料表類型。 從資料專輯移除實體時,要求調用者具有AliyunDataWorksFullAccess 許可權,或者為專輯的建立者或管理員。 |
維運中心
|
API |
標題 |
API概述 |
| 參數 | 參數 | |
| CreateParameter | 建立參數 | 建立一個參數。 |
| DeleteParameter | 刪除參數 | 刪除指定參數。 |
| UpdateParameter | 更新參數 | 更新參數。增量修改,只修改指定的欄位。 |
| RollbackParameter | 復原參數 | 復原指定參數。 |
| GetParameter | 擷取指定參數 | 根據參數ID擷取參數的詳細資料。 |
| ListParameters | 擷取參數列表 | 查詢參數列表。 |
| ListParameterVersions | 擷取參數版本列表 | 查詢參數版本列表。 |
| 監控警示 | 監控警示 | |
| ListAlertRules | 擷取自訂規則列表 | 分頁擷取自訂監控警示規則。 |
| GetAlertRule | 取得自訂監控告警規則。 | 取得自訂監控告警規則。 |
| UpdateAlertRule | 更新自訂監控警示規則 | 更新自訂監控警示規則。 |
| DeleteAlertRule | 刪除自訂規則。 | 刪除自訂監控警報規則。 |
| CreateAlertRule | 建立自訂監控警示規則。 | 建立自訂監控警示規則。 |
| 任務 | 任務 | |
| GetUpdateTaskResult | 取得更新任務的結果。 | 查詢非同步建立工作流程執行個體的結果。 |
| UpdateTaskAsync | 更新任務。 | 更新指定任務,並同步到資料開發新增儲存版本。 |
| DeleteTask | 刪除任務 | 刪除指定的任務。 |
| UpdateTask | 更新任務。 | 更新指定任務。修改的內容會同步到資料開發,資料開發將新增一個儲存版本。 |
| BatchUpdateTasks | 批次更新工作。 | 以增量更新的方式,批次更新多個工作。 |
| GetTask | 擷取任務的詳情 | 擷取指定的任務的詳細資料。 |
| ListTasks | 擷取工作清單 | 分頁擷取工作清單,也可以通過條件進行篩選查詢。 |
| ListUpstreamTasks | 擷取上遊工作清單 | 分頁擷取指定任務的上遊工作清單。 |
| ListDownstreamTasks | 擷取下遊工作清單 | 分頁擷取指定任務的下遊工作清單。 |
| ListTaskOperationLogs | 擷取任務的動作記錄列表 | 分頁擷取指定任務的動作記錄列表。 |
| 任務執行個體 | 任務執行個體 | |
| UpdateTaskInstances | 修改任務執行個體屬性 | 批量修改多個任務執行個體的屬性,包括優先順序、調度資源群組、資料來源等。 |
| GetTaskInstance | 取得任務執行個體的詳情。 | 取得指定的任務執行個體的詳細資訊。 |
| GetTaskInstanceLog | 擷取任務執行個體的作業記錄 | 擷取指定任務執行個體某一次啟動並執行作業記錄。 |
| ListTaskInstances | 取得任務執行個體清單。 | 分頁取得任務執行個體清單,也可以透過條件進行篩選查詢。 |
| ListUpstreamTaskInstances | 取得上游任務執行個體列表。 | 分頁取得指定任務執行個體的上游任務執行個體列表。 |
| ListTaskInstanceOperationLogs | 擷取任務執行個體的動作記錄列表 | 分頁擷取指定任務執行個體的動作記錄列表。 |
| ListDownstreamTaskInstances | 取得下游任務執行個體清單。 | 分頁取得指定任務執行個體的下游任務執行個體清單。 |
| SuspendTaskInstances | 暫停任務執行個體 | 大量暫停多個任務執行個體。 |
| ResumeTaskInstances | 恢複任務執行個體 | 大量復原多個已暫停任務執行個體。 |
| StopTaskInstances | 終止工作執行個體。 | 批次終止多個工作執行個體。 |
| SetSuccessTaskInstances | 置成功任務執行個體 | 批量置成功多個任務執行個體。 |
| RerunTaskInstances | 重新執行工作執行個體。 | 批量重新執行多個工作執行個體。 |
| RemoveTaskInstanceDependencies | 移除任務執行個體的依賴關係 | 大量移除某任務執行個體的多個上遊依賴關係。 |
| TriggerSchedulerTaskInstance | 觸發調度任務執行個體 | 在某個定時時間,觸發指定HTTP觸發器調度任務運行。 |
| 工作流程 | 工作流程 | |
| DeleteWorkflow | 刪除工作流程。 | 刪除指定的工作流程。 |
| 工作流程執行個體 | 工作流程執行個體 | |
| GetRerunWorkflowInstancesResult | 擷取重跑工作流程執行個體結果 | 查詢非同步重跑工作流程執行個體的結果 |
| RerunWorkflowInstances | 重跑工作流程執行個體 | 重跑工作流程執行個體 |
| CreateWorkflowInstances | 建立工作流程執行個體。 | 根據設定建立工作流程執行個體,例如補資料工作流程執行個體。 |
| GetCreateWorkflowInstancesResult | 擷取建立工作流程執行個體結果 | 查詢非同步建立工作流程執行個體的結果。 |
| GetWorkflowInstance | 擷取工作流程執行個體的詳情 | 擷取指定的工作流程執行個體的詳細資料。 |
| ListWorkflowInstances | 取得工作流程執行個體清單。 | 分頁取得工作流程執行個體清單,也可以透過條件進行篩選查詢。 |
| StartWorkflowInstances | 啟動工作流程執行個體。 | 批次啟動多個工作流程執行個體。 |
| StopWorkflowInstances | 終止工作流程執行個體 | 批量終止多個工作流程執行個體。 |
| ExecuteAdhocWorkflowInstance | 執行臨時工作流程執行個體。 | 根據設定建立一個臨時工作流程執行個體。 |
資料品質
|
API |
標題 |
API概述 |
| 資料品質規則範本 | 資料品質規則範本 | |
| CreateDataQualityTemplate | 建立資料品質規則範本。 | 用於在指定專案中建立新的資料品質規則範本。 |
| UpdateDataQualityTemplate | 更新資料品質規則模板 | 用於更新指定專案下的資料品質規則模板配置。 |
| ListDataQualityTemplates | 資料品質規則範本清單查詢。 | 查詢指定專案下的資料品質規則範本清單。 |
| GetDataQualityTemplate | 擷取資料品質規則模板 | 根據ID查詢指定的資料品質規則模板詳情。 |
| DeleteDataQualityTemplate | 刪除資料品質規則模板 | 根據指定ID刪除資料品質規則模板。 |
| 資料品質監控 | 資料品質監控 | |
| CreateDataQualityScan | 建立資料品質監控 | 建立資料品質監控。 |
| UpdateDataQualityScan | 更新資料品質監控 | 更新資料品質監控。 |
| ListDataQualityScans | 資料品質校正工作清單查詢 | 查詢指定專案下的資料品質校正工作清單。 |
| GetDataQualityScan | 擷取資料品質監控詳情 | 擷取資料品質監控詳情 |
| DeleteDataQualityScan | 刪除資料品質監控 | 刪除資料品質監控。 |
| 警示規則 | 警示規則 | |
| CreateDataQualityAlertRule | 建立資料品質警示規則。 | 用於在指定專案中建立資料品質監控警示規則。 |
| UpdateDataQualityAlertRule | 更新資料品質警示規則。 | 用於更新指定的資料品質監控警示規則。 |
| ListDataQualityAlertRules | 資料品質警示規則列表查詢 | 查詢指定專案下的資料品質警示規則列表。 |
| GetDataQualityAlertRule | 擷取資料品質警示規則 | 根據警示規則ID查詢對應的資料品質監控警示規則詳情。 |
| DeleteDataQualityAlertRule | 刪除資料品質警示規則。 | 根據指定的 ID 刪除資料品質監控警示規則。 |
| 資料品質執行 | 資料品質執行 | |
| CreateDataQualityScanRun | 建立資料品質掃描執行。 | 觸發指定資料品質監控任務的執行,並傳回執行個體 ID。 |
| ListDataQualityScanRuns | 資料品質掃描運行記錄查詢 | 查詢指定專案下的資料品質掃描運行記錄。 |
| GetDataQualityScanRunLog | 取得資料品質掃描執行日誌。 | 查詢指定資料品質監控任務執行個體的日誌內容。 |
| GetDataQualityScanRun | 擷取資料品質掃描運行詳情 | 通過指定ID查詢資料品質掃描任務的運行詳情。 |
安全中心
|
API |
標題 |
API概述 |
| 權限申請與簽核 | 權限申請與簽核 | |
| ApplyResourceAccessPermission | 發起資源存取權限申請。 | 用於提交對特定資源的存取權限申請。 |
| StopProcessInstance | 撤回審批次程序執行個體 | 用於撤回或終止指定的審批次程序執行個體。 |
| ApproveProcessInstance | 審批工作流程執行個體。 | 用於對指定的審批流程執行個體進行同意或拒絕操作。 |
| GetApplicationContents | 取得資源權限申請詳情 | 查詢指定流程實例ID下的資源權限申請內容。 |
| GetProcessInstance | 查詢審批次程序執行個體 | 擷取指定審批次程序執行個體的詳細資料,包括審批節點和工作清單。 |
| ListPendingApprovals | 查詢待審批的權限申請單 | 取得目前使用者作為審批人、待處理的權限申請單列表。 |
| ListMyRelatedApprovals | 查詢與我相關的權限申請單 | 查詢當前使用者作為審批人或相關方的所有權限申請單。 |
| ListMyApplications | 查詢我發起的權限申請單 | 用於查詢目前使用者發起的所有資源存取權限申請單。 |
| 查詢結果管控策略 | 查詢結果管控策略 | |
| CreateSecurityStrategy | 建立安全策略 | 用於建立新的安全管控策略,支援多種模組和子模組設定。需要Dataworks 租戶管理員與安全管理員權限。 |
| DeleteSecurityStrategy | 刪除安全性原則 | 根據指定ID刪除一個安全性原則。需要Dataworks 租用戶系統管理員與安全性系統管理員許可權。 |
| UpdateSecurityStrategy | 更新安全性原則 | 用於修改現有安全性原則的配置資訊。需要Dataworks 租用戶系統管理員與安全性系統管理員許可權。 |
| GetSecurityStrategy | 查詢安全性原則詳情 | 根據提供的安全性原則ID,擷取對應的安全性原則詳細資料。需要Dataworks 租用戶系統管理員與安全性系統管理員許可權。 |
| ListSecurityStrategies | 分頁檢索安全性原則 | 根據指定條件分頁查詢系統中的安全性原則列表。需要Dataworks 租用戶系統管理員與安全性系統管理員許可權。 |
| FindBestMatchSecurityStrategy | 比對最佳安全策略 | 根據給定條件查詢最匹配的安全策略。 |
| 簽核策略 | 簽核策略 | |
| CreateProcessDefinition | 建立審批流程定義 | 用於建立新的審批流程定義,支援自訂配置審批規則和通知服務。 |
| DeleteProcessDefinition | 刪除審批次程序定義 | 根據指定的ID刪除一個審批次程序定義。 |
| EnableProcessDefinition | 啟用審批次程序定義 | 用於啟用指定ID的審批次程序定義。 |
| DisableProcessDefinition | 停用審批次程序定義 | 通過指定的流程定義ID來停用一個審批次程序定義。 |
| UpdateProcessDefinition | 更新審批次程序定義 | 用於更新已有的審批次程序定義資訊。 |
| GetProcessDefinition | 查詢審批次程序定義詳情 | 根據給定的流程定義ID,擷取對應的審批策略詳細資料。 |
| ListProcessDefinitions | 審批流程定義列表查詢 | 查詢指定類型的審批流程定義列表 |
| CreateIdentifyCredential | 建立身分憑證。 | 建立身分憑證。 |
標籤管理
|
API |
標題 |
API概述 |
| CreateDataAssetTag | 建立標籤。 | 建立標籤。 |
| DeleteDataAssetTag | 刪除標籤 | 刪除標籤。 |
| UpdateDataAssetTag | 更新標籤。 | 更新標籤。 |
| ListDataAssetTags | 查詢標籤列表 | 查詢標籤列表。 |
| TagDataAssets | 綁定資料資產標籤 | 為資產綁定標籤。 |
| UnTagDataAssets | 解除綁定資料資產標籤 | 為資料資產解除綁定標籤關係。 |
| ListDataAssets | 查詢已關聯標籤的資產清單。 | 分頁查詢已關聯標籤的 DataWorks 資料資產。 |
開放平台
|
API |
標題 |
API概述 |
| GetJobStatus | 取得非同步 API 執行狀態。 | 傳回非同步任務的狀態資訊,呼叫非同步化 API 後,透過輪詢此 API 來取得成功狀態。 |
其他
|
API |
標題 |
API概述 |
| ListDataQualityEvaluationTasks | 查詢品質監控任務清單。 | 品質監控任務清單分頁查詢。 |
| ListDataQualityRules | 列出品質規則。 | 以分頁方式查詢品質監控規則。 |
| ListDataQualityEvaluationTaskInstances | 查詢品質監控任務實例列表 | 品質監控任務實例列表分頁查詢。 |
| ListDataQualityResults | 查詢品質結果清單 | 品質結果清單分頁查詢。 |
| DetachDataQualityRulesFromEvaluationTask | 取消資料品質規則與監控的關聯關係 | 取消資料品質規則和資料品質校驗任務的關聯。 |
| DeleteDataQualityEvaluationTask | 刪除資料品質監控 | 刪除資料品質校驗任務。 |
| GetDataQualityEvaluationTaskInstance | 取得資料品質校驗任務執行個體詳情 | 取得資料品質校驗任務執行個體詳情。 |
| GetDataQualityEvaluationTask | 查詢資料品質監控詳情 | 查詢資料品質校驗任務詳情。 |
| AttachDataQualityRulesToEvaluationTask | 關聯資料品質規則與資料品質監控。 | 將資料品質規則關聯到資料品質校驗任務上。 |
| UpdateDataQualityEvaluationTask | 更新資料品質監控 | 更新資料品質校驗任務。 |
| CreateDataQualityEvaluationTaskInstance | 建立資料品質驗證監控執行個體。 | 建立資料品質驗證任務執行個體。 |
| CreateDataQualityEvaluationTask | 建立資料品質監控。 | 建立 DataWorks 資料品質監控。 |
| DeleteDataQualityRule | 刪除品質規則 | 刪除品質規則。 |
| UpdateDataQualityRuleTemplate | 更新質量規則模板 | 更新質量規則模板。 |
| CreateDataQualityRuleTemplate | 建立品質規則範本。 | 建立規則範本。 |
| DeleteDataQualityRuleTemplate | 刪除自訂品質規則範本 | 刪除自訂品質規則範本。 |
| GetDataQualityRuleTemplate | 查詢品質規則範本詳情 | 查詢品質規則範本詳情。 |
| CreateDataQualityRule | 建立品質規則 | 建立品質規則。 |
| UpdateDataQualityRule | 更新質量規則 | 更新質量規則。 |
| GetDataQualityRule | 查詢品質規則詳情。 | 查詢品質規則詳情。 |
| ListDataQualityRuleTemplates | 查詢品質規則範本清單。 | 查詢品質規則範本清單。 |
| DeleteCertificate | 刪除憑證檔案。 | 刪除憑證檔案。 |
| GetCertificate | 查看認證檔案 | 查看認證檔案。 |
| GetDataSource | 檢視資料來源詳細資訊。 | 根據資料來源 ID 查詢指定的資料來源。 |
| ImportCertificate | 匯入認證檔案 | 匯入認證檔案。 |
| ListCertificates | 查詢認證檔案清單 | 查詢認證檔案清單。 |
| DeleteFile | 刪除資料開發中的檔案 | 調用DeleteFile刪除資料開發中的檔案。如果檔案已經提交過,那麼DeleteFile API會同時觸發一個非同步在調度系統刪除的流程,需要用DeleteFile API返回的DeploymentId繼續調用GetDeployment輪詢被觸發的非同步刪除流程的狀態。 |
| GetWorkflow | 擷取工作流程的詳情 | 擷取指定的工作流程的詳細資料。 |
| ListWorkflows | 擷取工作流程列表 | 分頁擷取工作流程列表,也可以通過條件進行篩選查詢。 |
| UpdateWorkflow | 更新工作流程。 | 以全量更新的方式,更新指定工作流程。支援同步更新到資料開發的欄位:負責人、資料來源、排程資源群組、描述資訊、觸發執行模式(正常、空跑、暫停)。 |
| AbolishCrossProjectPipelineRun | 終止跨空間發布流程。 | 終止跨空間發布流程。 |
| CreateCrossProjectPipelineRun | 建立跨空間發布流程。 | 建立跨空間發布流程。 |
| ExecCrossProjectPipelineRun | 執行跨空間發布流程。 | 執行跨空間發布流程。 |
| GetCrossProjectPipelineRun | 查詢跨空間發布流程詳情。 | 查詢跨空間發布流程詳情。 |
| ListCrossProjectDeploymentCandidates | 查詢跨空間發佈候選物件。 | 查詢跨空間發佈候選物件。 |
| ListCrossProjectDeploymentEnvironments | 查詢跨空間發布環境。 | 查詢跨空間發布環境。 |
| ListCrossProjectPipelineRunItems | 查詢跨空間發佈流程發佈項。 | 查詢跨空間發佈流程發佈項。 |
| ListCrossProjectPipelineRuns | 查詢跨空間發佈流程清單。 | 查詢跨空間發布流程清單。 |
Others
|
API |
標題 |
API概述 |
| ReplyAgentSession | 答覆工作階段的請求輸入。 | 回覆 DataAgent 工作階段中等待處理的使用者互動。 |