已棄用的 REST API¶

警告

此 REST API 自 2.0 版本起已棄用。請考慮使用穩定的 REST API。如需遷移的更多資訊，請參閱UPDATING.md

警告

請注意，這些 API 端點沒有存取控制。已驗證的使用者擁有完整存取權。

在 Airflow 2.0 之前，此 REST API 被稱為「實驗性」API，但現在穩定的 REST API已可用，因此已重新命名。

此 API 的端點位於 /api/experimental/。

在 2.0 版本中變更：此 REST API 預設為停用。若要在遷移至穩定的 REST API 時還原這些 API，請將 enable_experimental_api 選項在 [api] 區段中設定為 True。

端點¶

POST /api/experimental/dags/<DAG_ID>/dag_runs¶

為給定的 DAG ID 建立 dag_run。注意：如果 body 中未指定 execution_date，則 Airflow 預設為給定的 DAG_ID 每秒僅建立一個 DAG。為了在一秒內建立多個 DagRun，您應該將參數 "replace_microseconds" 設定為 "false" (布林值字串)。

execution_date 必須以 YYYY-mm-DDTHH:MM:SS.ssssss 格式指定。

使用 config 觸發 DAG，範例

curl -X POST \
    'https://127.0.0.1:8080/api/experimental/dags/<DAG_ID>/dag_runs' \
    --header 'Cache-Control: no-cache' \
    --header 'Content-Type: application/json' \
    --data '{"conf":"{\"key\":\"value\"}"}'

以毫秒精度觸發 DAG，範例

curl -X POST  \
    'https://127.0.0.1:8080/api/experimental/dags/<DAG_ID>/dag_runs' \
    --header 'Content-Type: application/json' \
    --header 'Cache-Control: no-cache' \
    --data '{"replace_microseconds":"false"}'

GET /api/experimental/dags/<DAG_ID>/dag_runs¶: 傳回特定 DAG ID 的 Dag Run 列表。

GET /api/experimental/dags/<string:dag_id>/dag_runs/<string:execution_date>¶: 傳回包含 dag_run 公開實例變數的 JSON。 <string:execution_date> 的格式應為 YYYY-mm-DDTHH:MM:SS，例如："2016-11-16T11:34:15"。

GET /api/experimental/test¶: 檢查 REST API 伺服器是否正常運作。傳回狀態 ‘OK’。

GET /api/experimental/dags/<DAG_ID>/tasks/<TASK_ID>¶: 傳回任務的資訊。

GET /api/experimental/dags/<DAG_ID>/dag_runs/<string:execution_date>/tasks/<TASK_ID>¶: 傳回包含任務實例公開實例變數的 JSON。 <string:execution_date> 的格式應為 YYYY-mm-DDTHH:MM:SS，例如："2016-11-16T11:34:15"。

GET /api/experimental/dags/<DAG_ID>/paused/<string:paused>¶: ‘<string:paused>’ 必須為 ‘true’ 以暫停 DAG，以及 ‘false’ 以取消暫停。

GET /api/experimental/dags/<DAG_ID>/paused¶: 傳回 DAG 的暫停狀態

GET /api/experimental/latest_runs¶: 傳回每個 DAG 的最新 DagRun，並為 UI 格式化。

GET /api/experimental/pools¶: 取得所有 pools。

GET /api/experimental/pools/<string:name>¶: 依給定名稱取得 pool。

POST /api/experimental/pools¶: 建立 pool。

DELETE /api/experimental/pools/<string:name>¶: 刪除 pool。

GET /api/experimental/lineage/<DAG_ID>/<string:execution_date>/¶: 傳回 DAG 的譜系資訊。