Managed Service for Apache Airflow™ API, REST: Cluster.list
Retrieves a list of Apache Airflow Cluster resources.
HTTP request
GET https://airflow.api.cloud.yandex.net/managed-airflow/v1/clusters
Query parameters
Parameter | Description |
---|---|
folderId | Required. ID of the folder to list Apache Airflow clusters in. The maximum string length in characters is 50. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by the previous list request. The maximum string length in characters is 100. |
filter | A filter expression that filters resources listed in the response. The expression must specify:
The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"clusters": [
{
"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": true
}
},
"health": "string",
"status": "string",
"network": {
"subnetIds": [
"string"
],
"securityGroupIds": [
"string"
]
},
"codeSync": {
"s3": {
"bucket": "string"
}
},
"deletionProtection": true,
"webserverUrl": "string",
"serviceAccountId": "string",
"logging": {
"enabled": true,
"minLevel": "string",
// `clusters[].logging` includes only one of the fields `folderId`, `logGroupId`
"folderId": "string",
"logGroupId": "string",
// end of the list of possible fields`clusters[].logging`
}
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
clusters[] | object List of Apache Airflow Cluster resources. |
clusters[]. id |
string Unique ID of the Apache Airflow cluster. This ID is assigned by Cloud during cluster creation. |
clusters[]. folderId |
string ID of the folder that the Apache Airflow cluster belongs to. |
clusters[]. 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 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). |
clusters[]. name |
string Name of the Apache Airflow cluster. The name is unique within the folder. 1-64 characters long. |
clusters[]. description |
string Description of the Apache Airflow cluster. 0-256 characters long. |
clusters[]. labels |
object Resource labels as |
clusters[]. monitoring[] |
object Monitoring systems relevant to the Apache Airflow cluster. |
clusters[]. monitoring[]. name |
string Name of the monitoring system. |
clusters[]. monitoring[]. description |
string Description of the monitoring system. |
clusters[]. monitoring[]. link |
string Link to the monitoring system. |
clusters[]. config |
object Configuration of Apache Airflow components. |
clusters[]. config. versionId |
string Version of Apache that runs on the cluster. |
clusters[]. config. airflow |
object Configuration of the Apache Airflow application itself. |
clusters[]. config. airflow. config |
object Properties to be passed to Apache Airflow configuration file. |
clusters[]. config. webserver |
object Required. Configuration of webserver instances. |
clusters[]. config. webserver. count |
string (int64) The number of webserver instances in the cluster. Acceptable values are 1 to 512, inclusive. |
clusters[]. config. webserver. resources |
object Resources allocated to webserver instances. |
clusters[]. config. webserver. resources. resourcePresetId |
string ID of the preset for computational resources available to an instance (CPU, memory etc.). |
clusters[]. config. scheduler |
object Required. Configuration of scheduler instances. |
clusters[]. config. scheduler. count |
string (int64) The number of scheduler instances in the cluster. Acceptable values are 1 to 512, inclusive. |
clusters[]. config. scheduler. resources |
object Resources allocated to scheduler instances. |
clusters[]. config. scheduler. resources. resourcePresetId |
string ID of the preset for computational resources available to an instance (CPU, memory etc.). |
clusters[]. config. triggerer |
object Configuration of triggerer instances. |
clusters[]. config. triggerer. count |
string (int64) The number of triggerer instances in the cluster. Acceptable values are 0 to 512, inclusive. |
clusters[]. config. triggerer. resources |
object Resources allocated to triggerer instances. |
clusters[]. config. triggerer. resources. resourcePresetId |
string ID of the preset for computational resources available to an instance (CPU, memory etc.). |
clusters[]. config. worker |
object Required. Configuration of worker instances. |
clusters[]. config. worker. minCount |
string (int64) The minimum number of worker instances in the cluster. Acceptable values are 0 to 512, inclusive. |
clusters[]. config. worker. maxCount |
string (int64) The maximum number of worker instances in the cluster. Acceptable values are 1 to 512, inclusive. |
clusters[]. config. worker. resources |
object Resources allocated to worker instances. |
clusters[]. config. worker. resources. resourcePresetId |
string ID of the preset for computational resources available to an instance (CPU, memory etc.). |
clusters[]. config. dependencies |
object The list of additional packages installed in the cluster. |
clusters[]. config. dependencies. pipPackages[] |
string Python packages that are installed in the cluster. |
clusters[]. config. dependencies. debPackages[] |
string System packages that are installed in the cluster. |
clusters[]. config. lockbox |
object Configuration of Lockbox Secret Backend. |
clusters[]. config. lockbox. enabled |
boolean (boolean) The setting allows to enable Lockbox Secret Backend. |
clusters[]. health |
string Aggregated cluster health.
|
clusters[]. status |
string Cluster status.
|
clusters[]. network |
object Network related configuration options. |
clusters[]. network. subnetIds[] |
string IDs of VPC network subnets where instances of the cluster are attached. |
clusters[]. network. securityGroupIds[] |
string User security groups. |
clusters[]. codeSync |
object Parameters of the location and access to the code that will be executed in the cluster. |
clusters[]. codeSync. s3 |
object |
clusters[]. codeSync. s3. bucket |
string The name of the Object Storage bucket that stores DAG files used in the cluster. |
clusters[]. deletionProtection |
boolean (boolean) Deletion Protection inhibits deletion of the cluster. |
clusters[]. webserverUrl |
string Address of Apache Airflow web UI. |
clusters[]. serviceAccountId |
string Service account used to access Cloud resources. For more information, see documentation. The maximum string length in characters is 50. |
clusters[]. logging |
object Cloud Logging configuration. |
clusters[]. logging. enabled |
boolean (boolean) Logs generated by the Airflow components are delivered to Cloud Logging. |
clusters[]. logging. minLevel |
string Minimum log entry level. See [LogLevel.Level] for details.
|
clusters[]. logging. folderId |
string clusters[].logging includes only one of the fields folderId , logGroupId Logs should be written to default log group for specified folder. Value must match the regular expression |
clusters[]. logging. logGroupId |
string clusters[].logging includes only one of the fields folderId , logGroupId Logs should be written to log group resolved by ID. Value must match the regular expression |
nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |