已弃用 REST API¶

警告

此 REST API 自 2.0 版起已弃用。请考虑使用稳定 REST API。有关迁移的更多信息，请参阅 UPDATING.md

在 Airflow 2.0 之前，此 REST API 被称为“实验性”API，但现在稳定 REST API 已可用，因此已重命名。

此 API 的端点位于 /api/experimental/。

在 2.0 版更改: 默认情况下禁用此 REST API。要在迁移到稳定 REST API 时恢复这些 API，请在 [api] 部分中将 enable_experimental_api 选项设置为 True。

端点¶

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

为给定的 DAG ID 创建 dag_run。注意：如果正文中未指定 execution_date，则默认情况下，Airflow 每秒仅为给定 DAG_ID 创建一个 DAG。为了在一秒钟内创建多个 DagRun，您应该将参数 "replace_microseconds" 设置为 "false"（字符串形式的布尔值）。

execution_date 必须使用 YYYY-mm-DDTHH:MM:SS.ssssss 格式指定。

使用配置触发 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¶: 获取所有池。

GET /api/experimental/pools/<string:name>¶: 按给定名称获取池。

POST /api/experimental/pools¶: 创建一个池。

DELETE /api/experimental/pools/<string:name>¶: 删除池。

GET /api/experimental/lineage/<DAG_ID>/<string:execution_date>/¶: 返回 DAG 的沿袭信息。