Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex Managed Service for Apache Airflow™
  • Getting started
  • Access management
  • Pricing policy
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • Start
        • Stop
        • ListOperations
  • Yandex Monitoring metrics
  • Release notes
  • FAQ

In this article:

  • HTTP request
  • Path parameters
  • Response
  • StopClusterMetadata
  • Status
  • Cluster
  • Monitoring
  • ClusterConfig
  • AirflowConfig
  • WebserverConfig
  • Resources
  • SchedulerConfig
  • TriggererConfig
  • WorkerConfig
  • Dependencies
  • LockboxConfig
  • NetworkConfig
  • CodeSyncConfig
  • S3Config
  • LoggingConfig
  • MaintenanceWindow
  • WeeklyMaintenanceWindow
  • MaintenanceOperation
  1. API reference
  2. REST
  3. Cluster
  4. Stop

Managed Service for Apache Airflow™ API, REST: Cluster.Stop

Written by
Yandex Cloud
Updated at April 24, 2025
  • HTTP request
  • Path parameters
  • Response
  • StopClusterMetadata
  • Status
  • Cluster
  • Monitoring
  • ClusterConfig
  • AirflowConfig
  • WebserverConfig
  • Resources
  • SchedulerConfig
  • TriggererConfig
  • WorkerConfig
  • Dependencies
  • LockboxConfig
  • NetworkConfig
  • CodeSyncConfig
  • S3Config
  • LoggingConfig
  • MaintenanceWindow
  • WeeklyMaintenanceWindow
  • MaintenanceOperation

Stops the specified Apache Airflow cluster.

HTTP requestHTTP request

POST https://airflow.api.cloud.yandex.net/managed-airflow/v1/clusters/{clusterId}:stop

Path parametersPath parameters

Field

Description

clusterId

string

Required field. ID of the Apache Airflow cluster to stop.

ResponseResponse

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "clusterId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "string",
    "name": "string",
    "description": "string",
    "labels": "object",
    "monitoring": [
      {
        "name": "string",
        "description": "string",
        "link": "string"
      }
    ],
    "config": {
      "versionId": "string",
      "airflow": {
        "config": "object"
      },
      "webserver": {
        "count": "string",
        "resources": {
          "resourcePresetId": "string"
        }
      },
      "scheduler": {
        "count": "string",
        "resources": {
          "resourcePresetId": "string"
        }
      },
      "triggerer": {
        "count": "string",
        "resources": {
          "resourcePresetId": "string"
        }
      },
      "worker": {
        "minCount": "string",
        "maxCount": "string",
        "resources": {
          "resourcePresetId": "string"
        }
      },
      "dependencies": {
        "pipPackages": [
          "string"
        ],
        "debPackages": [
          "string"
        ]
      },
      "lockbox": {
        "enabled": "boolean"
      },
      "airflowVersion": "string",
      "pythonVersion": "string"
    },
    "health": "string",
    "status": "string",
    "network": {
      "subnetIds": [
        "string"
      ],
      "securityGroupIds": [
        "string"
      ]
    },
    "codeSync": {
      // Includes only one of the fields `s3`
      "s3": {
        "bucket": "string"
      }
      // end of the list of possible fields
    },
    "deletionProtection": "boolean",
    "webserverUrl": "string",
    "serviceAccountId": "string",
    "logging": {
      "enabled": "boolean",
      // Includes only one of the fields `folderId`, `logGroupId`
      "folderId": "string",
      "logGroupId": "string",
      // end of the list of possible fields
      "minLevel": "string"
    },
    "maintenanceWindow": {
      // Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
      "anytime": "object",
      "weeklyMaintenanceWindow": {
        "day": "string",
        "hour": "string"
      }
      // end of the list of possible fields
    },
    "plannedOperation": {
      "info": "string",
      "delayedUntil": "string",
      "latestMaintenanceTime": "string",
      "nextMaintenanceWindowTime": "string"
    }
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

StopClusterMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Cluster

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

StopClusterMetadataStopClusterMetadata

Field

Description

clusterId

string

ID of the Apache Airflow cluster that is being stopped.

StatusStatus

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

ClusterCluster

Apache Airflow cluster.

Field

Description

id

string

Unique ID of the Apache Airflow cluster.
This ID is assigned by Cloud during cluster creation.

folderId

string

ID of the folder that the Apache Airflow cluster belongs to.

createdAt

string (date-time)

The time when the Apache Airflow cluster was created.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

name

string

Name of the Apache Airflow cluster.
The name is unique within the folder. 1-64 characters long.

description

string

Description of the Apache Airflow cluster. 0-256 characters long.

labels

object (map<string, string>)

Resource labels as key:value pairs. Maximum of 64 per resource.

monitoring[]

Monitoring

Monitoring systems relevant to the Apache Airflow cluster.

config

ClusterConfig

Configuration of Apache Airflow components.

health

enum (Health)

Aggregated cluster health.

  • HEALTH_UNKNOWN: Cluster is in unknown state (we have no data).
  • ALIVE: Cluster is alive and well.
  • DEAD: Cluster is inoperable (it cannot perform any of its essential functions).
  • DEGRADED: Cluster is partially alive (it can perform some of its essential functions).

status

enum (Status)

Cluster status.

  • STATUS_UNKNOWN: Cluster state is unknown.
  • CREATING: Cluster is being created.
  • RUNNING: Cluster is running normally.
  • ERROR: Cluster encountered a problem and cannot operate.
  • STOPPING: Cluster is stopping.
  • STOPPED: Cluster is stopped.
  • STARTING: Cluster is starting.
  • UPDATING: Cluster is being updated.

network

NetworkConfig

Network related configuration options.

codeSync

CodeSyncConfig

Parameters of the location and access to the code that will be executed in the cluster.

deletionProtection

boolean

Deletion Protection inhibits deletion of the cluster.

webserverUrl

string

Address of Apache Airflow web UI.

serviceAccountId

string

Service account used to access Cloud resources.
For more information, see documentation.

logging

LoggingConfig

Cloud Logging configuration.

maintenanceWindow

MaintenanceWindow

Window of maintenance operations.

plannedOperation

MaintenanceOperation

Maintenance operation planned at nearest maintenance_window.

MonitoringMonitoring

Monitoring system.

Field

Description

name

string

Name of the monitoring system.

description

string

Description of the monitoring system.

link

string

Link to the monitoring system.

ClusterConfigClusterConfig

Field

Description

versionId

string

Version of Apache Airflow that runs on the cluster.
Use airlow_version instead.

airflow

AirflowConfig

Configuration of the Apache Airflow application itself.

webserver

WebserverConfig

Required field. Configuration of webserver instances.

scheduler

SchedulerConfig

Required field. Configuration of scheduler instances.

triggerer

TriggererConfig

Configuration of triggerer instances.

worker

WorkerConfig

Required field. Configuration of worker instances.

dependencies

Dependencies

The list of additional packages installed in the cluster.

lockbox

LockboxConfig

Configuration of Lockbox Secret Backend.

airflowVersion

string

Apache Airflow version. Format: "Major.Minor"

pythonVersion

string

Python version. Format: "Major.Minor"

AirflowConfigAirflowConfig

Field

Description

config

object (map<string, string>)

Properties to be passed to Apache Airflow configuration file.

WebserverConfigWebserverConfig

Field

Description

count

string (int64)

The number of webserver instances in the cluster.

resources

Resources

Resources allocated to webserver instances.

ResourcesResources

Field

Description

resourcePresetId

string

ID of the preset for computational resources available to an instance (CPU, memory etc.).

SchedulerConfigSchedulerConfig

Field

Description

count

string (int64)

The number of scheduler instances in the cluster.

resources

Resources

Resources allocated to scheduler instances.

TriggererConfigTriggererConfig

Field

Description

count

string (int64)

The number of triggerer instances in the cluster.

resources

Resources

Resources allocated to triggerer instances.

WorkerConfigWorkerConfig

Field

Description

minCount

string (int64)

The minimum number of worker instances in the cluster.

maxCount

string (int64)

The maximum number of worker instances in the cluster.

resources

Resources

Resources allocated to worker instances.

DependenciesDependencies

Field

Description

pipPackages[]

string

Python packages that are installed in the cluster.

debPackages[]

string

System packages that are installed in the cluster.

LockboxConfigLockboxConfig

Field

Description

enabled

boolean

The setting allows to enable Lockbox Secret Backend.

NetworkConfigNetworkConfig

Field

Description

subnetIds[]

string

IDs of VPC network subnets where instances of the cluster are attached.

securityGroupIds[]

string

User security groups.

CodeSyncConfigCodeSyncConfig

Field

Description

s3

S3Config

Includes only one of the fields s3.

S3ConfigS3Config

Field

Description

bucket

string

The name of the Object Storage bucket that stores DAG files used in the cluster.

LoggingConfigLoggingConfig

Field

Description

enabled

boolean

Logs generated by the Airflow components are delivered to Cloud Logging.

folderId

string

Logs should be written to default log group for specified folder.

Includes only one of the fields folderId, logGroupId.

Destination of log records.

logGroupId

string

Logs should be written to log group resolved by ID.

Includes only one of the fields folderId, logGroupId.

Destination of log records.

minLevel

enum (Level)

Minimum log entry level.

See LogLevel.Level for details.

  • LEVEL_UNSPECIFIED: Default log level.

    Equivalent to not specifying log level at all.

  • TRACE: Trace log level.

    Possible use case: verbose logging of some business logic.

  • DEBUG: Debug log level.

    Possible use case: debugging special cases in application logic.

  • INFO: Info log level.

    Mostly used for information messages.

  • WARN: Warn log level.

    May be used to alert about significant events.

  • ERROR: Error log level.

    May be used to alert about errors in infrastructure, logic, etc.

  • FATAL: Fatal log level.

    May be used to alert about unrecoverable failures and events.

MaintenanceWindowMaintenanceWindow

Field

Description

anytime

object

Includes only one of the fields anytime, weeklyMaintenanceWindow.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

Includes only one of the fields anytime, weeklyMaintenanceWindow.

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

Field

Description

day

enum (WeekDay)

  • WEEK_DAY_UNSPECIFIED
  • MON
  • TUE
  • WED
  • THU
  • FRI
  • SAT
  • SUN

hour

string (int64)

Hour of the day in UTC.

MaintenanceOperationMaintenanceOperation

Field

Description

info

string

delayedUntil

string (date-time)

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

latestMaintenanceTime

string (date-time)

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

nextMaintenanceWindowTime

string (date-time)

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

Was the article helpful?

Previous
Start
Next
ListOperations
Yandex project
© 2025 Yandex.Cloud LLC