Managed Service for Apache Airflow™ API, REST: Cluster.update
Updates the specified Apache Airflow cluster.
HTTP request
PATCH https://airflow.api.cloud.yandex.net/managed-airflow/v1/clusters/{clusterId}
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the Apache Airflow Cluster resource to update. The maximum string length in characters is 50. |
Body parameters
{
"updateMask": "string",
"name": "string",
"description": "string",
"labels": "object",
"configSpec": {
"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
}
},
"codeSync": {
"s3": {
"bucket": "string"
}
},
"networkSpec": {
"securityGroupIds": [
"string"
]
},
"deletionProtection": true,
"serviceAccountId": "string",
"logging": {
"enabled": true,
"minLevel": "string",
// `logging` includes only one of the fields `folderId`, `logGroupId`
"folderId": "string",
"logGroupId": "string",
// end of the list of possible fields`logging`
}
}
Field | Description |
---|---|
updateMask | string Field mask that specifies which fields of the Apache Airflow Cluster resource should be updated. A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in If |
name | string New name of the cluster. Value must match the regular expression |
description | string New description of the Apache Airflow cluster. The maximum string length in characters is 256. |
labels | object Custom labels for the Apache Airflow cluster as The new set of labels will completely replace the old ones. To add a label, request the current set with the get method, then send an update request with the new label added to the set. No more than 64 per resource. The string length in characters for each key must be 1-63. Each key must match the regular expression |
configSpec | object Configuration of Apache Airflow components. |
configSpec. airflow |
object Configuration of the Apache Airflow application itself. |
configSpec. airflow. config |
object Properties to be passed to Apache Airflow configuration file. |
configSpec. webserver |
object Configuration of webserver instances. |
configSpec. webserver. count |
string (int64) The number of webserver instances in the cluster. Acceptable values are 1 to 512, inclusive. |
configSpec. webserver. resources |
object Resources allocated to webserver instances. |
configSpec. webserver. resources. resourcePresetId |
string ID of the preset for computational resources available to an instance (CPU, memory etc.). |
configSpec. scheduler |
object Configuration of scheduler instances. |
configSpec. scheduler. count |
string (int64) The number of scheduler instances in the cluster. Acceptable values are 1 to 512, inclusive. |
configSpec. scheduler. resources |
object Resources allocated to scheduler instances. |
configSpec. scheduler. resources. resourcePresetId |
string ID of the preset for computational resources available to an instance (CPU, memory etc.). |
configSpec. triggerer |
object Configuration of triggerer instances. |
configSpec. triggerer. count |
string (int64) The number of triggerer instances in the cluster. Acceptable values are 0 to 512, inclusive. |
configSpec. triggerer. resources |
object Resources allocated to triggerer instances. |
configSpec. triggerer. resources. resourcePresetId |
string ID of the preset for computational resources available to an instance (CPU, memory etc.). |
configSpec. worker |
object Configuration of worker instances. |
configSpec. worker. minCount |
string (int64) The minimum number of worker instances in the cluster. Acceptable values are 0 to 512, inclusive. |
configSpec. worker. maxCount |
string (int64) The maximum number of worker instances in the cluster. Acceptable values are 1 to 512, inclusive. |
configSpec. worker. resources |
object Resources allocated to worker instances. |
configSpec. worker. resources. resourcePresetId |
string ID of the preset for computational resources available to an instance (CPU, memory etc.). |
configSpec. dependencies |
object The list of additional packages installed in the cluster. |
configSpec. dependencies. pipPackages[] |
string Python packages that are installed in the cluster. |
configSpec. dependencies. debPackages[] |
string System packages that are installed in the cluster. |
configSpec. lockbox |
object Configuration of Lockbox Secret Backend. |
configSpec. lockbox. enabled |
boolean (boolean) The setting allows to enable Lockbox Secret Backend. |
codeSync | object Parameters of the location and access to the code that will be executed in the cluster. |
codeSync. s3 |
object |
codeSync. s3. bucket |
string The name of the Object Storage bucket that stores DAG files used in the cluster. |
networkSpec | object Network related configuration options. |
networkSpec. securityGroupIds[] |
string User security groups. |
deletionProtection | boolean (boolean) Deletion Protection inhibits deletion of the cluster |
serviceAccountId | string Service account used to access Cloud resources. For more information, see documentation. The maximum string length in characters is 50. |
logging | object Cloud Logging configuration. |
logging. enabled |
boolean (boolean) Logs generated by the Airflow components are delivered to Cloud Logging. |
logging. minLevel |
string Minimum log entry level. See [LogLevel.Level] for details.
|
logging. folderId |
string 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 |
logging. logGroupId |
string 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 |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// 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 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 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 (boolean) If the value is |
metadata | object 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 | object The error result of the operation in case of failure or cancellation. includes only one of the fields error , response |
error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
error. message |
string An error message. |
error. details[] |
object A list of messages that carry the error details. |
response | object includes only one of the fields error , response 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. |