Managed Service for Apache Airflow™ API, gRPC: ClusterService.Get
Returns the specified Apache Airflow Cluster resource.
gRPC request
rpc Get (GetClusterRequest) returns (Cluster)
GetClusterRequest
{
"cluster_id": "string"
}
|
Field |
Description |
|
cluster_id |
string Required field. ID of the Apache Airflow Cluster resource to return. |
Cluster
{
"id": "string",
"folder_id": "string",
"created_at": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"monitoring": [
{
"name": "string",
"description": "string",
"link": "string"
}
],
"config": {
"version_id": "string",
"airflow": {
"config": "map<string, string>"
},
"webserver": {
"count": "int64",
"resources": {
"resource_preset_id": "string"
}
},
"scheduler": {
"count": "int64",
"resources": {
"resource_preset_id": "string"
}
},
"triggerer": {
"count": "int64",
"resources": {
"resource_preset_id": "string"
}
},
"worker": {
"min_count": "int64",
"max_count": "int64",
"resources": {
"resource_preset_id": "string"
}
},
"dependencies": {
"pip_packages": [
"string"
],
"deb_packages": [
"string"
]
},
"lockbox": {
"enabled": "bool"
},
"airflow_version": "string",
"python_version": "string"
},
"health": "Health",
"status": "Status",
"network": {
"subnet_ids": [
"string"
],
"security_group_ids": [
"string"
]
},
"code_sync": {
// Includes only one of the fields `s3`
"s3": {
"bucket": "string"
}
// end of the list of possible fields
},
"deletion_protection": "bool",
"webserver_url": "string",
"service_account_id": "string",
"logging": {
"enabled": "bool",
// Includes only one of the fields `folder_id`, `log_group_id`
"folder_id": "string",
"log_group_id": "string",
// end of the list of possible fields
"min_level": "Level"
}
}
Apache Airflow cluster.
|
Field |
Description |
|
id |
string Unique ID of the Apache Airflow cluster. |
|
folder_id |
string ID of the folder that the Apache Airflow cluster belongs to. |
|
created_at |
The time when the Apache Airflow cluster was created. |
|
name |
string Name of the Apache Airflow cluster. |
|
description |
string Description of the Apache Airflow cluster. 0-256 characters long. |
|
labels |
object (map<string, string>) Resource labels as |
|
monitoring[] |
Monitoring systems relevant to the Apache Airflow cluster. |
|
config |
Configuration of Apache Airflow components. |
|
health |
enum Health Aggregated cluster health.
|
|
status |
enum Status Cluster status.
|
|
network |
Network related configuration options. |
|
code_sync |
Parameters of the location and access to the code that will be executed in the cluster. |
|
deletion_protection |
bool Deletion Protection inhibits deletion of the cluster. |
|
webserver_url |
string Address of Apache Airflow web UI. |
|
service_account_id |
string Service account used to access Cloud resources. |
|
logging |
Cloud Logging configuration. |
Monitoring
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. |
ClusterConfig
|
Field |
Description |
|
version_id |
string Version of Apache Airflow that runs on the cluster. |
|
airflow |
Configuration of the Apache Airflow application itself. |
|
webserver |
Required field. Configuration of webserver instances. |
|
scheduler |
Required field. Configuration of scheduler instances. |
|
triggerer |
Configuration of triggerer instances. |
|
worker |
Required field. Configuration of worker instances. |
|
dependencies |
The list of additional packages installed in the cluster. |
|
lockbox |
Configuration of Lockbox Secret Backend. |
|
airflow_version |
string Apache Airflow version. Format: "Major.Minor" |
|
python_version |
string Python version. Format: "Major.Minor" |
AirflowConfig
|
Field |
Description |
|
config |
object (map<string, string>) Properties to be passed to Apache Airflow configuration file. |
WebserverConfig
|
Field |
Description |
|
count |
int64 The number of webserver instances in the cluster. |
|
resources |
Resources allocated to webserver instances. |
Resources
|
Field |
Description |
|
resource_preset_id |
string ID of the preset for computational resources available to an instance (CPU, memory etc.). |
SchedulerConfig
|
Field |
Description |
|
count |
int64 The number of scheduler instances in the cluster. |
|
resources |
Resources allocated to scheduler instances. |
TriggererConfig
|
Field |
Description |
|
count |
int64 The number of triggerer instances in the cluster. |
|
resources |
Resources allocated to triggerer instances. |
WorkerConfig
|
Field |
Description |
|
min_count |
int64 The minimum number of worker instances in the cluster. |
|
max_count |
int64 The maximum number of worker instances in the cluster. |
|
resources |
Resources allocated to worker instances. |
Dependencies
|
Field |
Description |
|
pip_packages[] |
string Python packages that are installed in the cluster. |
|
deb_packages[] |
string System packages that are installed in the cluster. |
LockboxConfig
|
Field |
Description |
|
enabled |
bool The setting allows to enable Lockbox Secret Backend. |
NetworkConfig
|
Field |
Description |
|
subnet_ids[] |
string IDs of VPC network subnets where instances of the cluster are attached. |
|
security_group_ids[] |
string User security groups. |
CodeSyncConfig
|
Field |
Description |
|
s3 |
Includes only one of the fields |
S3Config
|
Field |
Description |
|
bucket |
string The name of the Object Storage bucket that stores DAG files used in the cluster. |
LoggingConfig
|
Field |
Description |
|
enabled |
bool Logs generated by the Airflow components are delivered to Cloud Logging. |
|
folder_id |
string Logs should be written to default log group for specified folder. Includes only one of the fields Destination of log records. |
|
log_group_id |
string Logs should be written to log group resolved by ID. Includes only one of the fields Destination of log records. |
|
min_level |
enum Level Minimum log entry level. See LogLevel.Level for details.
|