Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1
Apache Airflow には、DAG のトリガーと管理、DAG 実行とタスクに関する情報の取得、接続とユーザーの追加と削除など、タスクの実行に使用できるコマンドライン インターフェース(CLI)があります。
サポートされている Airflow CLI コマンド
Cloud Composer 1 の Airflow では、CLI コマンドに 2 つの異なる構文が用意されています。
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 環境で ID 5077
を指定し、sample_quickstart
という名前の 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