Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1
Apache Airflow 提供指令列介面 (CLI),可用於執行各種工作,例如觸發及管理 DAG、取得 DAG 執行作業和工作相關資訊、新增及刪除連線和使用者。
支援的 Airflow CLI 指令
Cloud Composer 1 中的 Airflow 提供兩種不同的 CLI 指令語法:
Airflow 1.10 CLI 語法:適用於使用 Airflow 1.10 的 Cloud Composer 環境。
Airflow 2 CLI 語法:支援 Airflow 2 的 Cloud Composer 環境。
如需支援的 Airflow CLI 指令完整清單,請參閱 gcloud composer environments run
指令的參考資料。
事前準備
您必須具備權限,才能在 Cloud Composer 中使用 Google Cloud CLI 並執行 Airflow CLI 指令。
執行 Airflow CLI 指令
如要在環境中執行 Airflow CLI 指令,請使用 gcloud CLI:
gcloud composer environments run ENVIRONMENT_NAME \
--location LOCATION \
SUBCOMMAND \
-- SUBCOMMAND_ARGUMENTS
請使用下列內容取代:
ENVIRONMENT_NAME
:環境名稱。LOCATION
:環境所在的地區。SUBCOMMAND
:支援的 Airflow CLI 指令之一。SUBCOMMAND_ARGUMENTS
搭配 Airflow CLI 指令的引數。
子指令引數分隔符
請使用 --
分隔指定 Airflow CLI 指令的引數:
Airflow 2
- 將複合 CLI 指令指定為子指令。
- 在
--
分隔符後方,指定複合指令的任何引數做為子指令引數。
範例:
gcloud composer environments run example-environment \
dags list -- --output=json
Airflow 1
- 將 CLI 指令指定為子指令。
- 請在
--
分隔符後指定任何引數。
範例:
gcloud composer environments run example-environment \
list_dags -- --report
預設位置
大部分的 gcloud composer
指令都需要位置。您可以使用 --location
標記指定位置,也可以設定預設位置。
舉例來說,如要在 Cloud Composer 環境中觸發名稱為 sample_quickstart
且 ID 為 5077
的 DAG,請使用以下指令:
Airflow 2
gcloud composer environments run example-environment \
--location us-central1 dags trigger -- sample_quickstart \
--run-id=5077
Airflow 1
gcloud composer environments run example-environment \
--location us-central1 trigger_dag -- sample_quickstart \
--run_id=5077