Yandex Data Processing API, gRPC: ClusterService.Create

Written by

Yandex Cloud

Updated at July 1, 2026

View in Markdown

gRPC request
CreateClusterRequest
CreateClusterConfigSpec
HadoopConfig
InitializationAction
CreateSubclusterConfigSpec
Resources
AutoscalingConfig
operation.Operation

Creates a cluster in the specified folder.

gRPC request

rpc Create (CreateClusterRequest) returns (operation.Operation)

CreateClusterRequest

{
  "folder_id": "string",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "config_spec": {
    "version_id": "string",
    "hadoop": {
      "services": [
        "Service"
      ],
      "properties": "map<string, string>",
      "ssh_public_keys": [
        "string"
      ],
      "initialization_actions": [
        {
          "uri": "string",
          "args": [
            "string"
          ],
          "timeout": "int64"
        }
      ],
      "oslogin_enabled": "bool"
    },
    "subclusters_spec": [
      {
        "name": "string",
        "role": "Role",
        "resources": {
          "resource_preset_id": "string",
          "disk_type_id": "string",
          "disk_size": "int64"
        },
        "subnet_id": "string",
        "hosts_count": "int64",
        "assign_public_ip": "bool",
        "autoscaling_config": {
          "max_hosts_count": "int64",
          "preemptible": "bool",
          "measurement_duration": "google.protobuf.Duration",
          "warmup_duration": "google.protobuf.Duration",
          "stabilization_duration": "google.protobuf.Duration",
          "cpu_utilization_target": "double",
          "decommission_timeout": "int64"
        }
      }
    ]
  },
  "zone_id": "string",
  "bucket": "string",
  "service_account_id": "string",
  "ui_proxy": "bool",
  "host_group_ids": [
    "string"
  ],
  "security_group_ids": [
    "string"
  ],
  "deletion_protection": "bool",
  "log_group_id": "string",
  "environment": "Environment",
  "autoscaling_service_account_id": "string"
}

Field	Description
folder_id	string Required field. ID of the folder to create a cluster in. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
name	string Required field. Name of the cluster. The name must be unique within the folder. The name can't be changed after the Yandex Data Processing cluster is created. Value must match the regular expression `\|[a-z][-a-z0-9]{1,61}[a-z0-9]`.
description	string Description of the cluster. The maximum string length in characters is 256.
labels	object (map<string, string>) Cluster labels as `key:value` pairs. The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression `[a-z][-_0-9a-z]`. Each value must match the regular expression `[-_0-9a-z]`. No more than 64 per resource.
config_spec	CreateClusterConfigSpec Required field. Configuration and resources for hosts that should be created with the cluster.
zone_id	string Required field. ID of the availability zone where the cluster should be placed. To get the list of available zones make a yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50.
bucket	string Name of the Object Storage bucket to use for Yandex Data Processing jobs.
service_account_id	string Required field. ID of the service account to be used by the Yandex Data Processing manager agent.
ui_proxy	bool Enable UI Proxy feature.
host_group_ids[]	string Host groups to place VMs of cluster on.
security_group_ids[]	string User security groups.
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
log_group_id	string ID of the cloud logging log group to write logs. If not set, logs will not be sent to logging service
environment	enum Environment Environment of the cluster `PRODUCTION` `PRESTABLE`
autoscaling_service_account_id	string ID of the service account to be used by the Instance Groups service.

CreateClusterConfigSpec

Field	Description
version_id	string Version of the image for cluster provisioning. All available versions are listed in the documentation.
hadoop	HadoopConfig Yandex Data Processing specific options.
subclusters_spec[]	CreateSubclusterConfigSpec Specification for creating subclusters.

HadoopConfig

Hadoop configuration that describes services installed in a cluster,
their properties and settings.

Field	Description
services[]	enum Service Set of services used in the cluster (if empty, the default set is used). `HDFS` `YARN` `MAPREDUCE` `HIVE` `TEZ` `ZOOKEEPER` `HBASE` `SQOOP` `FLUME` `SPARK` `ZEPPELIN` `OOZIE` `LIVY`
properties	object (map<string, string>) Properties set for all hosts in `*-site.xml` configurations. The key should indicate the service and the property. For example, use the key 'hdfs:dfs.replication' to set the `dfs.replication` property in the file `/etc/hadoop/conf/hdfs-site.xml`.
ssh_public_keys[]	string List of public SSH keys to access to cluster hosts.
initialization_actions[]	InitializationAction Set of init-actions
oslogin_enabled	bool Oslogin enable on cluster nodes

InitializationAction

Field	Description
uri	string URI of the executable file
args[]	string Arguments to the initialization action
timeout	int64 Execution timeout

CreateSubclusterConfigSpec

Field	Description
name	string Name of the subcluster. Value must match the regular expression `\|[a-z][-a-z0-9]{1,61}[a-z0-9]`.
role	enum Role Required field. Role of the subcluster in the Yandex Data Processing cluster. `MASTERNODE`: The subcluster fulfills the master role. Master can run the following services, depending on the requested components: HDFS: Namenode, Secondary Namenode YARN: ResourceManager, Timeline Server HBase Master Hive: Server, Metastore, HCatalog Spark History Server Zeppelin ZooKeeper `DATANODE`: The subcluster is a DATANODE in a Yandex Data Processing cluster. DATANODE can run the following services, depending on the requested components: HDFS DataNode YARN NodeManager HBase RegionServer Spark libraries `COMPUTENODE`: The subcluster is a COMPUTENODE in a Yandex Data Processing cluster. COMPUTENODE can run the following services, depending on the requested components: YARN NodeManager Spark libraries
resources	Resources Required field. Resource configuration for hosts in the subcluster.
subnet_id	string Required field. ID of the VPC subnet used for hosts in the subcluster. The maximum string length in characters is 50.
hosts_count	int64 Number of hosts in the subcluster. The minimum value is 1.
assign_public_ip	bool Assign public ip addresses for all hosts in subcluter.
autoscaling_config	AutoscalingConfig Configuration for instance group based subclusters

Resources

Field	Description
resource_preset_id	string ID of the resource preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. The maximum string length in characters is 50.
disk_type_id	string Type of the storage environment for the host. Possible values: network-hdd - network HDD drive, network-ssd - network SSD drive. The maximum string length in characters is 50.
disk_size	int64 Volume of the storage available to a host, in bytes. The minimum value is 0.

AutoscalingConfig

Field	Description
max_hosts_count	int64 Upper limit for total instance subcluster count. Acceptable values are 1 to 100, inclusive.
preemptible	bool Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines.
measurement_duration	google.protobuf.Duration Required field. Time in seconds allotted for averaging metrics.
warmup_duration	google.protobuf.Duration The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected.
stabilization_duration	google.protobuf.Duration Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should.
cpu_utilization_target	double Defines an autoscaling rule based on the average CPU utilization of the instance group. Acceptable values are 0 to 100, inclusive.
decommission_timeout	int64 Timeout to gracefully decommission nodes during downscaling. In seconds. Default value: 120 Acceptable values are 0 to 86400, inclusive.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // 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.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	google.protobuf.Any 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	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	google.protobuf.Any 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. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

Yandex Data Processing API, gRPC: ClusterService.Create

gRPC requestgRPC request

CreateClusterRequestCreateClusterRequest

CreateClusterConfigSpecCreateClusterConfigSpec

HadoopConfigHadoopConfig

InitializationActionInitializationAction

CreateSubclusterConfigSpecCreateSubclusterConfigSpec

ResourcesResources

AutoscalingConfigAutoscalingConfig

operation.Operationoperation.Operation

Was the article helpful?