API標準及多語言預置SDK
本產品（MaxCompute/2022-01-04）的OpenAPI採用ROA簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
配額管理
|
API |
標題 |
API概述 |
| CreateQuota | 建立 Quota。 | 建立 Quota，首次開通 MaxCompute 必須先建立後付費類型的 Quota，如果建立的是預付費類型的 Quota，會進行自動扣款。 |
| ListQuotas | 擷取Quota列表 | 擷取Quota列表。 |
| QueryQuota | 擷取指定一級Quota組資訊 | 擷取指定一級Quota組資訊。 |
| GetQuota | 擷取指定一級Quota組資訊 | 擷取指定一級Quota組資訊。 注意warning: 該介面會在2024年7月31日下線，我們會提供QueryQuota的介面替代，入參，出參，功能完全一樣。 |
| 運算配額設定 | 運算配額設定 | |
| CreateComputeQuotaPlan | 建立計算Quota計劃 | 建立計算Quota計劃。 |
| UpdateComputeSubQuota | 更新計算Quota基礎配置 | 更新MaxCompute的基礎配置，包括增加和刪除二級Quota，定義二級Quota的基礎屬性和當前生效的Quota計劃的CU配置。 |
| GetComputeQuotaPlan | 擷取計算Quota計劃詳細資料 | 擷取單個計算Quota計劃的詳細資料。 |
| ListComputeQuotaPlan | 列舉計算Quota計劃 | 列舉計算Quota計劃。 |
| UpdateComputeQuotaPlan | 更新Quota計劃 | 更新Quota計劃。 |
| DeleteComputeQuotaPlan | 刪除計算Quota計劃 | 刪除MaxCompute計算Quota計劃。 |
| ApplyComputeQuotaPlan | 立即生效Quota計劃 | 立即生效Quota計劃。 |
| GetComputeQuotaSchedule | 擷取計算Quota分時計劃 | 擷取計算Quota分時計劃。 |
| UpdateComputeQuotaSchedule | 更新計算Quota分時計劃 | 更新計算Quota分時計劃。 |
| GetComputeEffectivePlan | 擷取當前生效的計算Quota計劃 | 擷取當前生效的計算Quota計劃。 |
| Tunnel 配額分時設定 | Tunnel 配額分時設定 | |
| 運算配額設定（舊版，不建議使用） | 運算配額設定（舊版，不建議使用） | |
| CreateQuotaPlan | 建立Quota計劃 | 新增Quota計劃。 |
| GetQuotaPlan | 擷取Quota計劃資訊 | 擷取Quota計劃資訊。 |
| UpdateQuotaPlan | 更新Quota計劃 | 更新Quota計劃。 |
| ListQuotasPlans | 擷取Quota計劃列表 | 擷取Quota計劃列表。 |
| DeleteQuotaPlan | 刪除Quota計劃 | 刪除Quota計劃。 |
| UpdateQuotaSchedule | 更新Quota時間計劃 | 更新Quota時間計劃資訊。 |
| GetQuotaSchedule | 擷取Quota時間計劃資訊 | 擷取Quota時間計劃資訊。 |
專案管理
|
API |
標題 |
API概述 |
| 基礎管理（Project） | 基礎管理（Project） | |
| UpdateProjectBasicMeta | 修改專案基本資訊 | 修改專案基本資訊 |
| UpdateProjectDefaultQuota | 修改專案預設計算Quota | 修改專案預設計算Quota |
| UpdateProjectIpWhiteList | 修改專案IP白名單 | 修改MaxCompute專案IP白名單。 |
| UpdateProjectModelTier | 升級專案到支援Schema層級 | 將project的二層模型升級為三層模型 |
| GetTrustedProjects | 擷取受信任專案列表 | 擷取當前專案的TrustedProject（受信任專案）列表。 |
| 角色權限（Role、User） | 角色權限（Role、User） | |
| DeleteRole | 刪除角色 | 刪除MaxCompute專案級角色 |
| ListProjectUsers | 擷取專案使用者列表 | 擷取專案使用者列表。 |
| CreateRole | 建立專案級角色 | 建立MaxCompute專案級角色。 |
| GetRoleAcl | 擷取專案級角色ACL授權資訊 | 擷取專案級角色ACL授權資訊。 |
| GetRoleAclOnObject | 擷取角色對某對象的ACL授權 | 擷取專案級角色對某對象的ACL授權資訊。 |
| GetRolePolicy | 擷取角色Policy授權內容 | 擷取專案級角色Policy授權內容。 |
| ListUsersByRole | 擷取綁定某專案級角色的使用者列表 | 擷取綁定某專案級角色的使用者列表。 |
| UpdateUsersToRole | 專案角色添加或刪除使用者 | 專案角色添加或刪除使用者 |
| Package | Package | |
| ListPackages | 擷取Package列表 | 擷取MaxCompute專案下的Package列表。 |
| UpdatePackage | 更新Package | 更新Package內的對象及允許安裝的專案列表。 |
| CreatePackage | 建立package | 通過調用該介面建立package。 |
| GetPackage | 擷取Package資訊 | 擷取package資訊。 |
| 資料表（Table） | 資料表（Table） | |
| GetTableInfo | 擷取表資訊 | 查看MaxCompute內部表、視圖、外部表格、聚簇表或Transactional表的資訊。 |
資源觀測
|
API |
標題 |
API概述 |
| QueryQuotaMetric | 計算資源消耗資訊 | 查看quota資源消耗的時序資訊 |
| QueryTunnelMetricDetail | Tunnel資源觀測詳情資料 | 用於查詢指定時間範圍內的TunnelData Transmission Service相關詳情資料。 |
| QueryTunnelMetric | Tunnel資源觀測時序資料 | 用於查詢指定時間範圍內的TunnelData Transmission Service相關指標資料。 |
| GetQuotaUsage | 擷取Quota資源消耗資訊 | 擷取Quota資源消耗資訊 |
| ListJobMetric | 擷取作業效能指標 | 擷取運行結束的作業的效能指標。 |
| QueryStorageMetric | 儲存資源觀測時序資料 | 查看儲存資料的時序指標。 |
| ListStorageTablesInfo | 擷取表格儲存體明細 | 擷取某個MaxCompute專案內的表格儲存體明細。 |
| ListStoragePartitionsInfo | 擷取分區儲存明細 | 擷取某個MaxCompute專案內分區表的各分區儲存明細。 |
| GetStorageSizeSummary | 擷取儲存用量資訊 | 擷取儲存用量資訊。 |
| GetStorageAmountSummary | 擷取儲存總量資訊 | 擷取儲存總量資訊。 |
| GetStorageSummaryCompared | 儲存趨勢同比變化 | 擷取儲存趨勢同比變化。 |
| ListStorageProjectsInfo | 擷取專案儲存明細 | 擷取專案儲存明細。 |
作業維運
|
API |
標題 |
API概述 |
| ListJobInfos | 查看作業列表 | 查看作業列表 |
| ListJobSnapshotInfos | 擷取作業快照列表 | 擷取某個時間點的作業快照資料。 |
| GetJobInfo | 查看作業的基礎資訊 | 查看單個作業的基礎資訊。 |
| GetRunningJobs | 擷取運行態的作業列表 | 指定時間範圍內，所有仍處於“運行中”的作業的運行態資料展示。 |
| KillJobs | 終止作業 | 終止正在啟動並執行作業。 |
| GetJobResourceUsage | 獲得作業執行者層級的資源使用列表 | 指定時間範圍內，針對已結束的全部作業進行統計，以“天”為層級展示作業執行者層級的資源使用總量。 |
資料移轉
|
API |
標題 |
API概述 |
| RetryMmsTask | 重試資料移轉任務 | RetryMmsTask |
| CreateMmsDataSource | 建立資料來源 | 建立資料來源，通過MMA將資料來源的資料移轉到MaxCompute。 |
| GetMmsDataSource | 擷取單個資料來源詳情 | 擷取單個MMA資料來源詳情 |
| ListMmsDataSources | 列出資料來源 | 列出MMA資料來源 |
| UpdateMmsDataSource | 更新資料來源配置、啟/停資料來源執行個體 | 重新拉取MMA資料來源的中繼資料 |
| DeleteMmsDataSource | 刪除資料來源 | 刪除MMA資料來源，包括資料來源的遷移計劃、中繼資料 |
| CreateMmsFetchMetadataJob | 建立“同步資料來源中繼資料”任務 | “拉取資料來源中繼資料”任務會將資料來源的中繼資料拉取出來 |
| GetMmsFetchMetadataJob | 擷取“同步中繼資料”任務詳情 | 擷取單個MMA“擷取中繼資料”任務詳情 |
| ListMmsDbs | 擷取資料來源內的"資料庫"列表 | 列出MMA資料來源內的庫 |
| GetMmsDb | 擷取資料來源內的某個庫 | 擷取MMA資料來源內的某個庫 |
| ListMmsTables | 列出資料來源內的表 | 列出MMA資料來源內的表 |
| GetMmsTable | 擷取MMA資料來源內的某張表 | 擷取MMA資料來源內的某張表 |
| ListMmsPartitions | 列出資料來源內的分區 | 列出MMA資料來源內的分區 |
| GetMmsPartition | 擷取資料來源內的某個分區 | 擷取MMA資料來源內的某個分區 |
| CreateMmsJob | 建立資料移轉任務 | 建立資料移轉任務 |
| ListMmsJobs | 擷取遷移作業列表 | 擷取遷移作業列表 |
| GetMmsJob | 擷取單個遷移作業詳情 | 擷取單個MMA遷移計劃詳情 |
| GetMmsAsyncTask | 擷取資料移轉相關的單個非同步任務詳情 | 擷取MMA單個非同步任務 |
| DeleteMmsJob | 刪除資料移轉作業 | 刪除MMA的資料移轉計劃 |
| StartMmsJob | 啟動資料移轉作業 | 開啟資料移轉作業 |
| StopMmsJob | 停止資料移轉作業 | 停止資料移轉作業 |
| RetryMmsJob | 重試資料移轉作業 | 重試資料移轉作業 |
| ListMmsTasks | 取得資料遷移任務列表。 | 取得遷移任務列表。 |
| GetMmsTask | 擷取單個遷移任務詳情 | 擷取單個遷移任務詳情。 |
| ListMmsTaskLogs | 列出單個遷移任務的執行日誌 | 列出單個遷移任務的執行日誌。 |
| CreateMmsTimer | 建立資料移轉定時任務 | CreateMmsTimer |
| UpdateMmsTimer | 更新定時任務 | UpdateMmsTimer |
| UpdateMmsTables | 批次更新表目的、狀態 | 更新表中繼資料 |
| UpdateMmsTable | 更新MMS表目的、狀態 | 更新表中繼資料 |
| UpdateMmsDb | 更新MMS庫的目的、狀態 | 功能： |
| ListMmsTimers | 列出資料移轉定時任務 | ListMmsTimers |
| ListMmsTimerLogs | 列出定時任務日誌 | ListMmsTimerLogs |
| ListMmsDataSourceConfigItems | 列出MMA資料來源配置項 | ListMmsDataSourceConfigItems |
| GetMmsTimer | 擷取資料移轉定時任務 | GetMmsTimer |
| DeleteMmsTimer | 刪除定時任務 | DeleteMmsTimer |
成本分析
|
API |
標題 |
API概述 |
| ListInstances | 擷取需要進行成本分析的執行個體列表 | 擷取需要對某個時間段進行成本分析的執行個體列表 |
| SumStorageMetricsByType | 按儲存類型統計儲存使用量 | 按儲存類型統計儲存使用量 |
| ListComputeMetricsBySignature | 按Signature查看作業使用量明細 | 按Signature查看作業計算使用量明細 |
| SumComputeMetricsByUsage | 統計掃描量計算類的使用量或者CU時計算類使用量 | 統計掃描量計算類的使用量或者CU時計算類使用量 |
| SumComputeMetricsByRecord | 統計用量記錄數 | 統計用量記錄數 |
| SumDailyBillsByItem | 按執行個體或者費用項逐日統計費用明細資訊 | 按執行個體或者費用項逐日統計費用明細 |
| SumBills | 按執行個體或者計費項目統計費用資訊 | 按執行個體或者計費項目統計費用資訊 |
| SumBillsByDate | 按執行個體或者費用項逐日統計費用 | 按執行個體或者費用項逐日統計費用 |
| SumStorageMetricsByDate | 儲存用量匯總 | 指定日期查看各個類別的儲存資訊或各個project的儲存資訊。 |
| ListComputeMetricsByInstance | 列出instance維度作業計算用量 | 列出instance維度作業計算用量。 |
其他
|
API |
標題 |
API概述 |
| TriggerMmsTimer | 立即觸發資料移轉定時任務 | TriggerMmsTimer |
| CreateProject | 建立專案 | 建立MaxCompute專案。 |
| DeleteProject | 刪除專案 | 刪除MaxCompute專案。此操作無法復原，請謹慎調用此API |
| GetProject | 獲取專案資訊 | 查詢MaxCompute專案的基本資訊。 |
| ListFunctions | 擷取函數列表 | 擷取MaxCompute函數列表。 |
| ListProjects | 擷取專案列表 | 擷取MaxCompute專案列表。 |
| ListResources | 擷取資源清單 | 擷取MaxCompute專案內的資源清單。 |
| ListRoles | 擷取專案級角色列表 | 擷取MaxCompute專案級角色列表。 |
| ListTables | 擷取表列表 | 擷取MaxCompute專案內的表列表。 |
| ListUsers | 擷取使用者列表 | 擷取租戶下的所有使用者列表。 |