Managed Service for Apache Airflow™ API, REST: Cluster.create
Creates an Apache Airflow cluster.
HTTP request
POST https://airflow.api.cloud.yandex.net/managed-airflow/v1/clusters
Body parameters
{
"folderId": "string",
"name": "string",
"description": "string",
"labels": "object",
"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
}
},
"network": {
"subnetIds": [
"string"
],
"securityGroupIds": [
"string"
]
},
"codeSync": {
"s3": {
"bucket": "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`
},
"adminPassword": "string"
}
Field | Description |
---|---|
folderId | string Required. ID of the folder to create Apache Airflow cluster in. The maximum string length in characters is 50. |
name | string Required. Name of the Apache Airflow cluster. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression |
description | string Description of the Apache Airflow cluster. The maximum string length in characters is 256. |
labels | object Custom labels for the Apache Airflow cluster as No more than 64 per resource. The maximum string length in characters for each key is 63. Each key must match the regular expression |
config | object Required. Configuration of Apache Airflow components. |
config. versionId |
string Version of Apache that runs on the cluster. |
config. airflow |
object Configuration of the Apache Airflow application itself. |
config. airflow. config |
object Properties to be passed to Apache Airflow configuration file. |
config. webserver |
object Required. Configuration of webserver instances. |
config. webserver. count |
string (int64) The number of webserver instances in the cluster. Acceptable values are 1 to 512, inclusive. |
config. webserver. resources |
object Resources allocated to webserver instances. |
config. webserver. resources. resourcePresetId |
string ID of the preset for computational resources available to an instance (CPU, memory etc.). |
config. scheduler |
object Required. Configuration of scheduler instances. |
config. scheduler. count |
string (int64) The number of scheduler instances in the cluster. Acceptable values are 1 to 512, inclusive. |
config. scheduler. resources |
object Resources allocated to scheduler instances. |
config. scheduler. resources. resourcePresetId |
string ID of the preset for computational resources available to an instance (CPU, memory etc.). |
config. triggerer |
object Configuration of triggerer instances. |
config. triggerer. count |
string (int64) The number of triggerer instances in the cluster. Acceptable values are 0 to 512, inclusive. |
config. triggerer. resources |
object Resources allocated to triggerer instances. |
config. triggerer. resources. resourcePresetId |
string ID of the preset for computational resources available to an instance (CPU, memory etc.). |
config. worker |
object Required. Configuration of worker instances. |
config. worker. minCount |
string (int64) The minimum number of worker instances in the cluster. Acceptable values are 0 to 512, inclusive. |
config. worker. maxCount |
string (int64) The maximum number of worker instances in the cluster. Acceptable values are 1 to 512, inclusive. |
config. worker. resources |
object Resources allocated to worker instances. |
config. worker. resources. resourcePresetId |
string ID of the preset for computational resources available to an instance (CPU, memory etc.). |
config. dependencies |
object The list of additional packages installed in the cluster. |
config. dependencies. pipPackages[] |
string Python packages that are installed in the cluster. |
config. dependencies. debPackages[] |
string System packages that are installed in the cluster. |
config. lockbox |
object Configuration of Lockbox Secret Backend. |
config. lockbox. enabled |
boolean (boolean) The setting allows to enable Lockbox Secret Backend. |
network | object Network related configuration options. |
network. subnetIds[] |
string IDs of VPC network subnets where instances of the cluster are attached. |
network. securityGroupIds[] |
string User security groups. |
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. |
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 |
adminPassword | string Required. Password of user The string length in characters must be 8-128. |
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. |