Method: projects.locations.environments.executeAirflowCommand

Executes Airflow CLI command.

HTTP request

POST https://composer.googleapis.com/v1/{environment=projects/*/locations/*/environments/*}:executeAirflowCommand

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
environment

string

The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

Authorization requires the following IAM permission on the specified resource environment:

  • composer.environments.executeAirflowCommand

Request body

The request body contains data with the following structure:

JSON representation 
{
  "command": string,
  "subcommand": string,
  "parameters": [
    string
  ]
}
Fields
command

string

Airflow command.
subcommand

string

Airflow subcommand.
parameters[]

string

Parameters for the Airflow command/subcommand as an array of arguments. It may contain positional arguments like ["my-dag-id"], key-value parameters like ["--foo=bar"] or ["--foo","bar"], or other flags like ["-f"].

Response body

Response to ExecuteAirflowCommandRequest.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "executionId": string,
  "pod": string,
  "podNamespace": string,
  "error": string
}
Fields
executionId

string

The unique ID of the command execution for polling.
pod

string

The name of the pod where the command is executed.
podNamespace

string

The namespace of the pod where the command is executed.
error

string

Error message. Empty if there was no error.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.