Managed Service for Apache Airflow™ API, gRPC: ClusterService.Get
Returns the specified Apache Airflow Cluster resource.
gRPC request
rpc Get (GetClusterRequest) returns (Cluster)
GetClusterRequest
{
"clusterId": "string"
}
|
Field |
Description |
|
clusterId |
string Required field. ID of the Apache Airflow Cluster resource to return. |
Cluster
{
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
"monitoring": [
{
"name": "string",
"description": "string",
"link": "string"
}
],
"config": {
"versionId": "string",
"airflow": {
"config": "string"
},
"webserver": {
"count": "int64",
"resources": {
"resourcePresetId": "string"
}
},
"scheduler": {
"count": "int64",
"resources": {
"resourcePresetId": "string"
}
},
"triggerer": {
"count": "int64",
"resources": {
"resourcePresetId": "string"
}
},
"worker": {
"minCount": "int64",
"maxCount": "int64",
"resources": {
"resourcePresetId": "string"
}
},
"dependencies": {
"pipPackages": [
"string"
],
"debPackages": [
"string"
]
},
"lockbox": {
"enabled": "bool"
}
},
"health": "Health",
"status": "Status",
"network": {
"subnetIds": [
"string"
],
"securityGroupIds": [
"string"
]
},
"codeSync": {
// Includes only one of the fields `s3`
"s3": {
"bucket": "string"
}
// end of the list of possible fields
},
"deletionProtection": "bool",
"webserverUrl": "string",
"serviceAccountId": "string",
"logging": {
"enabled": "bool",
// Includes only one of the fields `folderId`, `logGroupId`
"folderId": "string",
"logGroupId": "string",
// end of the list of possible fields
"minLevel": "Level"
}
}
Apache Airflow cluster.
|
Field |
Description |
|
id |
string Unique ID of the Apache Airflow cluster. |
|
folderId |
string ID of the folder that the Apache Airflow cluster belongs to. |
|
createdAt |
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 |
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. |
|
codeSync |
Parameters of the location and access to the code that will be executed in the cluster. |
|
deletionProtection |
bool Deletion Protection inhibits deletion of the cluster. |
|
webserverUrl |
string Address of Apache Airflow web UI. |
|
serviceAccountId |
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 |
|
versionId |
string Version of Apache 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. |
AirflowConfig
|
Field |
Description |
|
config |
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 |
|
resourcePresetId |
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 |
|
minCount |
int64 The minimum number of worker instances in the cluster. |
|
maxCount |
int64 The maximum number of worker instances in the cluster. |
|
resources |
Resources allocated to worker instances. |
Dependencies
|
Field |
Description |
|
pipPackages[] |
string Python packages that are installed in the cluster. |
|
debPackages[] |
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 |
|
subnetIds[] |
string IDs of VPC network subnets where instances of the cluster are attached. |
|
securityGroupIds[] |
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. |
|
folderId |
string Logs should be written to default log group for specified folder. Includes only one of the fields Destination of log records. |
|
logGroupId |
string Logs should be written to log group resolved by ID. Includes only one of the fields Destination of log records. |
|
minLevel |
enum Level Minimum log entry level. See LogLevel.Level for details.
|