Cloud Composer 1 | Cloud Composer 2
Apache Airflow には REST API インターフェースがあり、DAG 実行とタスクに関する情報の取得、DAG の更新、Airflow 構成の取得、接続の追加と削除、ユーザーの一覧表示などのタスクを実行に使用できます。
例
Airflow REST API の使用例については、Cloud Functions を使用して DAG をトリガーするをご覧ください。
Airflow REST API のバージョン
Cloud Composer 2 では次の Airflow REST API バージョンを使用できます。
Airflow 2 は、安定版の REST API を使用します。試験運用版の REST API の Airflow によるサポートは終了しました。
Airflow 構成のオーバーライド経由で有効にすると、試験運用版の REST API を引き続き Airflow 2 で使用できます。詳細については、以下をご覧ください。
始める前に
Cloud Composer API を有効にします。安定版の Airflow REST API を有効にする
Airflow 2
Cloud Composer は、Identity-Aware Proxy と統合された独自の API 認証バックエンドを使用します。
認可は、Airflow が提供する標準の方法で機能します。新しいユーザーが API を使用して認可すると、デフォルトで、ユーザーのアカウントに Op ロールが付与されます。
以下の Airflow 構成オプションをオーバーライドすることで、安定版の REST API を有効または無効にできます。また、デフォルトのユーザーロールを変更することもできます。
| セクション | キー | 値 | 注 |
|---|---|---|---|
api |
auth_backend |
airflow.composer.api.backend.composer_auth |
安定版の REST API を無効にするには、airflow.api.auth.backend.deny_all に変更します。 |
api |
composer_auth_user_registration_role |
Op |
その他のロールも指定できます。 |
Airflow 1
Airflow 1 は Cloud Composer 2 では使用できません。
試験運用版の Airflow REST API を有効にする
Airflow 2
試験運用版 API では、API 認証機能はデフォルトで無効になっています。Airflow ウェブサーバーは、すべてのリクエストを拒否します。
API 認証機能と Airflow 2 試験運用版 API を有効にするには、次の Airflow 構成オプションをオーバーライドします。
| セクション | キー | 値 | 注 |
|---|---|---|---|
api |
auth_backend |
airflow.api.auth.backend.default |
デフォルトは airflow.composer.api.backend.composer_auth です。 |
api |
enable_experimental_api |
True |
デフォルト値は False です。 |
Airflow 1
Airflow 1 は Cloud Composer 2 では使用できません。
api-auth_backend 構成オプションを airflow.api.auth.backend.default に設定すると、Airflow ウェブサーバーは認証を行うことなくすべての API リクエストを受け入れます。Airflow ウェブサーバー自体は認証を必要としませんが、独自の認証レイヤを備える Identity-Aware Proxy によって保護されます。