API / SDK / developer guide
REST API
| 目標讀者 TA | API 整合者 |
|---|---|
| 官方文件能力 | 管理與檢視協調資源。 |
| 輸入 → 輸出 | 經驗證 API 請求 → 資源或查詢結果。 |
| 執行環境 | Prefect 3 server 或 Cloud 與已設定執行基礎設施 |
| 本站選型評估 | Cloud workspace URL 不同於自行代管 API URL。 |
| 本站建議驗證 | 驗證目標 workspace 與部署 OpenAPI 綱要。 |
工作流程自動化 · API / SDK
Prefect REST API
Prefect
透過雲端或自建 REST 接口管理流程執行。
PREFECT / DEVELOPER FIELD GUIDE
選對接口，定義可驗證的結果。
公司／專案背景、十個技術入口，以及每份引用的實作分析。
2026-10-08 · 串接尚未實測
公司／專案背景全貌
依官方公司或專案自述撰寫的原創概要；完整原文請見來源。
| 專案 | Prefect 透過 flows、tasks 與追蹤執行狀態協調 Python 工作流程。 |
|---|---|
| API | Cloud 與自行代管 server 提供用戶端及儀表板使用的 REST 介面。 |
| 維運 | Deployments、pools 與 workers 連接流程定義與執行基礎設施。 |
| 適用角色 | 進行 AI 供應商初選的採購、合作夥伴與產品負責人。 |
|---|---|
| 本站評估 | 用定位與公司背景判斷初步適配度；另行取得專案部署、支援與商務條件。 |
已核對官方來源。未呼叫供應商 API 或執行推論；結果為內部契約示意。
十項技術入口比較
依實作決策選出的十個技術文件入口，非十套獨立 SDK 或官方排名。
| 接口 | 用途與 TA |
|---|---|
| 01 · REST APIAPI / SDK / developer guide | 管理與檢視協調資源。API 整合者 |
| 02 · FlowsAPI / SDK / developer guide | 定義 Python 工作流程執行。工作流程工程師 |
| 03 · TasksAPI / SDK / developer guide | 追蹤流程中的工作單元。資料管線工程師 |
| 04 · StatesAPI / SDK / developer guide | 解讀執行生命週期狀態。維運團隊 |
| 05 · DeploymentsAPI / SDK / developer guide | 設定可執行流程部署。版本工程師 |
| 06 · Work poolsAPI / SDK / developer guide | 連接執行與基礎設施。基礎設施維運人員 |
| 07 · WorkersAPI / SDK / developer guide | 輪詢相容 pool 並啟動執行。執行維運人員 |
| 08 · SchedulesAPI / SDK / developer guide | 建立週期 flow run。排程團隊 |
| 09 · RetriesAPI / SDK / developer guide | 依政策重執行失敗流程或任務。可靠性工程師 |
| 10 · EventsAPI / SDK / developer guide | 表達變更以供事件驅動協調。事件自動化團隊 |
逐份文件分析
能力摘要依據官方文件；限制與建議測試為本站工程評估。
API / SDK / developer guide
Flows
| 目標讀者 TA | 工作流程工程師 |
|---|---|
| 官方文件能力 | 定義 Python 工作流程執行。 |
| 輸入 → 輸出 | 參數 → flow run 與回傳結果。 |
| 執行環境 | Prefect 3 server 或 Cloud 與已設定執行基礎設施 |
| 本站選型評估 | 回傳值與例外影響最終狀態。 |
| 本站建議驗證 | 同時檢查業務輸出與協調狀態。 |
API / SDK / developer guide
Tasks
| 目標讀者 TA | 資料管線工程師 |
|---|---|
| 官方文件能力 | 追蹤流程中的工作單元。 |
| 輸入 → 輸出 | Task 輸入 → 已追蹤結果。 |
| 執行環境 | Prefect 3 server 或 Cloud 與已設定執行基礎設施 |
| 本站選型評估 | 重試或快取行為須符合副作用。 |
| 本站建議驗證 | 測試重複工作與相依失敗。 |
API / SDK / developer guide
States
| 目標讀者 TA | 維運團隊 |
|---|---|
| 官方文件能力 | 解讀執行生命週期狀態。 |
| 輸入 → 輸出 | 執行轉移 → 狀態細節。 |
| 執行環境 | Prefect 3 server 或 Cloud 與已設定執行基礎設施 |
| 本站選型評估 | Scheduled、pending 與 running 不是 completed。 |
| 本站建議驗證 | 明確映射各終態及非終態。 |
API / SDK / developer guide
Deployments
| 目標讀者 TA | 版本工程師 |
|---|---|
| 官方文件能力 | 設定可執行流程部署。 |
| 輸入 → 輸出 | 流程參照與執行設定 → 部署。 |
| 執行環境 | Prefect 3 server 或 Cloud 與已設定執行基礎設施 |
| 本站選型評估 | 部署紀錄不證明程式能在目標基礎設施執行。 |
| 本站建議驗證 | 驗證程式取得與執行相依項目。 |
API / SDK / developer guide
Work pools
| 目標讀者 TA | 基礎設施維運人員 |
|---|---|
| 官方文件能力 | 連接執行與基礎設施。 |
| 輸入 → 輸出 | Work-pool 模板 → 執行環境設定。 |
| 執行環境 | Prefect 3 server 或 Cloud 與已設定執行基礎設施 |
| 本站選型評估 | Pool 型別決定基礎設施行為。 |
| 本站建議驗證 | 核對必要憑證與資源限制。 |
API / SDK / developer guide
Workers
| 目標讀者 TA | 執行維運人員 |
|---|---|
| 官方文件能力 | 輪詢相容 pool 並啟動執行。 |
| 輸入 → 輸出 | 排程工作 → 啟動流程基礎設施。 |
| 執行環境 | Prefect 3 server 或 Cloud 與已設定執行基礎設施 |
| 本站選型評估 | Worker 型 pool 需要可用相容 worker。 |
| 本站建議驗證 | 測試 worker 中斷與復原。 |
API / SDK / developer guide
Schedules
| 目標讀者 TA | 排程團隊 |
|---|---|
| 官方文件能力 | 建立週期 flow run。 |
| 輸入 → 輸出 | 排程規則 → 排程執行紀錄。 |
| 執行環境 | Prefect 3 server 或 Cloud 與已設定執行基礎設施 |
| 本站選型評估 | 時區與重複規則影響預期執行時段。 |
| 本站建議驗證 | 檢查下次時點與暫停排程。 |
API / SDK / developer guide
Retries
| 目標讀者 TA | 可靠性工程師 |
|---|---|
| 官方文件能力 | 依政策重執行失敗流程或任務。 |
| 輸入 → 輸出 | 失敗與重試設定 → 下次嘗試或失敗。 |
| 執行環境 | Prefect 3 server 或 Cloud 與已設定執行基礎設施 |
| 本站選型評估 | 重試不保證外部寫入冪等性。 |
| 本站建議驗證 | 使用業務鍵與有限重試條件。 |
API / SDK / developer guide
Events
| 目標讀者 TA | 事件自動化團隊 |
|---|---|
| 官方文件能力 | 表達變更以供事件驅動協調。 |
| 輸入 → 輸出 | 事件與資源識別 → 可觀測事件紀錄。 |
| 執行環境 | Prefect 3 server 或 Cloud 與已設定執行基礎設施 |
| 本站選型評估 | 觀測到事件不證明下游工作完成。 |
| 本站建議驗證 | 從事件識別追蹤至觸發執行結果。 |
Official documentation
| TA | 工程師與技術產品負責人 |
|---|---|
| 本站驗證建議 | 實作前固定版本並依目標環境核對支援條件。 |
04 / INPUT · EXPECTED OUTPUT · ACCEPTANCE
實作前先看懂預期結果
資料匯入流程追蹤示意契約，非 Prefect 原始回應。未建立或執行 flow。
示意契約 · 未呼叫 API 或執行模型 · 不是供應商實測輸出
匯入完成
| 輸入 | 有效來源描述與已設定部署。 |
|---|---|
| 預期結果 | completed 狀態且列數已驗證才 ok。 |
| 驗收條件 | 比對目的紀錄與來源總數。 |
來源沒有資料列
| 輸入 | 有效來源查詢回傳零筆。 |
|---|---|
| 預期結果 | 完成無操作，rows_processed=0。 |
| 驗收條件 | 區分零筆與來源存取遭拒。 |
執行等待基礎設施
| 輸入 | 已建立執行等待 worker 或容量。 |
|---|---|
| 預期結果 | pending／scheduled，不宣稱已處理列數。 |
| 驗收條件 | 重試建立前揭露 pool 與 worker 可用性。 |
重試後 task 失敗
| 輸入 | 設定嘗試後目的寫入仍不可用。 |
|---|---|
| 預期結果 | failed 與有限錯誤及部分寫入紀錄。 |
| 驗收條件 | 防止重複寫入並核對部分結果。 |
將預期結果對應至你的應用
將實際執行環境回應對應至此建議應用契約。所有數值皆為示意，不含憑證或真實執行。
預期輸出 JSON — 示意，非實測 · PrefectAPI-expected-results.json
{
"schema_version": "1.0.0",
"example": true,
"provider": "Prefect",
"status": "ok",
"input_id": "sample-001",
"data": {
"flow_run_id": "example-run",
"deployment_id": "example-deployment",
"state": "COMPLETED",
"rows_processed": 12,
"artifact_uri": null
},
"error": null,
"verification": "illustrative-only;not-provider-response"
}| 狀態語意 | 有效空結果與錯誤不同；等待中的工作不可提前顯示成功。 |
|---|---|
| 證據 | 記錄服務與 SDK 版本、請求識別、設定及回應映射。此處未執行或量測效能。 |
| 建議驗收 | 以授權代表樣本測試前，先約定數值誤差與負載目標。 |
開發評估
供應商證據更新工作
開發構想規格・串接尚未實測
接口能力依據官方文件或程式庫；以下產品方向、輸入、交付與驗收條件則是我們的開發評估。
可先做小原型
確認存取後，用少量真實樣本測試一個有文件的操作。此為開發判斷，不是交期估算。
- 原型輸入規劃
- 一筆範例事件、經授權系統與一個明確流程轉換。
- 原型交付規劃
- 單一流程的可見工作狀態與操作紀錄。
- 驗收條件
- 重送事件不得重複建立工作；上游不可用時需保留等待或失敗狀態。
- 依賴條件
- 執行環境存取、流程權限與已核對的通知或寫入目的地。
開發順序
- 確認 Prefect REST API 的存取、授權與支援版本。
- 準備上述樣本，針對「供應商證據更新工作」先實作一個有官方文件的操作。
- 整理輸出時保留來源、時間與錯誤狀態，並保留供應商回應供審核。
- 通過驗收條件後，再估算擴展投入與客戶交付。
如何驗證需求
記錄產品瀏覽、官方文件點擊、規格下載與技術 Hub 點擊。這些是事件次數，不等於獨立人數或已完成串接。
本次可行性評估依實作條件判斷；尚未給定流量排名或交期承諾。