存取 Airflow 指令列介面

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

Apache Airflow 具有指令列介面 (CLI)，可用於執行觸發及管理 DAG、取得 DAG 執行和工作相關資訊，以及新增和刪除連線和使用者等工作。

支援的 Airflow CLI 指令

Cloud Composer 1 中的 Airflow 提供兩種不同的 CLI 指令語法：

如需支援的 Airflow CLI 指令完整清單，請參閱 gcloud composer environments run 指令的參考資料。

事前準備

  • 您必須具備權限，才能搭配使用 Google Cloud CLI 與 Cloud Composer，並執行 Airflow CLI 指令。

  • Airflow CLI 指令會耗用environments.executeAirflowCommand 配額。

執行 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

後續步驟