Ytsaurus API, gRPC: ClusterService.Create

Written by

Yandex Cloud

Updated at July 1, 2026

View in Markdown

gRPC request
CreateClusterRequest
ClusterSpec
StorageSpec
HddSpec
SsdSpec
Changelogs
ComputeSpec
DiskSpec
ScalePolicy
FixedScale
AutoScale
LinearScalingStrategy
TabletSpec
ProxySpec
HttpProxySpec
RpcProxySpec
TaskProxySpec
OdinSpec
CronSpec
ClearTmpCronSpec
ClientLogging
ExcelSpec
MaintenanceWindow
AnytimeMaintenanceWindow
WeeklyMaintenanceWindow
CidrBlocks
operation.Operation

Creates a cluster in the specified folder.

gRPC request

rpc Create (CreateClusterRequest) returns (operation.Operation)

CreateClusterRequest

{
  "folder_id": "string",
  "zone_id": "string",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "subnet_id": "string",
  "security_group_ids": [
    "string"
  ],
  "spec": {
    "storage": {
      "hdd": {
        "size_gb": "int64",
        "count": "int64"
      },
      "ssd": {
        "size_gb": "int64",
        "type": "string",
        "count": "int64",
        "changelogs": {
          "size_gb": "int64"
        }
      }
    },
    "compute": [
      {
        "preset": "string",
        "disks": [
          {
            "type": "string",
            "size_gb": "int64",
            "locations": [
              "string"
            ],
            "location_quotas_gb": [
              "int64"
            ]
          }
        ],
        "scale_policy": {
          // Includes only one of the fields `fixed`, `auto`
          "fixed": {
            "size": "int64"
          },
          "auto": {
            "min_size": "int64",
            "max_size": "int64",
            "initial_size": "int64",
            // Includes only one of the fields `linear`
            "linear": {
              "cooldown_interval": "google.protobuf.Duration",
              "statistics_interval": "google.protobuf.Duration",
              "overload_coefficient": "double",
              "underload_coefficient": "double"
            }
            // end of the list of possible fields
          }
          // end of the list of possible fields
        },
        "name": "string"
      }
    ],
    "tablet": {
      "preset": "string",
      "count": "int64"
    },
    "proxy": {
      "http": {
        "count": "int64"
      },
      "rpc": {
        "count": "int64"
      },
      "task": {
        "count": "int64"
      }
    },
    "odin": {
      "checks_ttl": "google.protobuf.Duration"
    },
    "flavor": "Flavor",
    "cron": {
      "clear_tmp": {
        "interval": "google.protobuf.Duration",
        "account_usage_ratio_save_total": "double",
        "account_usage_ratio_save_per_owner": "double",
        "max_dir_node_count": "int64"
      }
    },
    "client_logging": {
      // Includes only one of the fields `log_group_id`, `folder_id`
      "log_group_id": "string",
      "folder_id": "string",
      // end of the list of possible fields
      "service_account_id": "string",
      "audit_logs_enabled": "bool"
    },
    "excel": {
      "enabled": "bool"
    }
  },
  "maintenance_window": {
    // Includes only one of the fields `anytime`, `weekly_maintenance_window`
    "anytime": "AnytimeMaintenanceWindow",
    "weekly_maintenance_window": {
      "day": "WeekDay",
      "hour": "int64"
    }
    // end of the list of possible fields
  },
  "cidr_blocks_whitelist": {
    "v4_cidr_blocks": [
      "string"
    ]
  }
}

Field	Description
folder_id	string Required field. ID of the folder to create the cluster in.
zone_id	string Required field. ID of the availability zone where the cluster resides.
name	string Name of the cluster. The maximum string length in characters is 63. Value must match the regular expression `[a-zA-Z0-9040104510410-044f]\S{1,61}[a-zA-Z0-9040104510410-044f]`.
description	string Description of the cluster.
labels	object (map<string, string>) Cluster labels as `key:value` pairs.
subnet_id	string Required field. ID of the subnet to create the cluster in.
security_group_ids[]	string IDs of the security groups to attach to the cluster.
spec	ClusterSpec Cluster specification.
maintenance_window	MaintenanceWindow Cluster maintenance window
cidr_blocks_whitelist	CidrBlocks CIDRs whitelist.

ClusterSpec

Field	Description
storage	StorageSpec Cluster storage configuration.
compute[]	ComputeSpec Cluster exec nodes configuration.
tablet	TabletSpec Cluster tablet nodes configuration.
proxy	ProxySpec Cluster proxies configuration.
odin	OdinSpec Odin configuration.
flavor	enum Flavor Cluster flavor (type). `DEMO`: Demo cluster configuration with minimal system resources. Not fault-tolerant, not for production use.
cron	CronSpec Cluster regular processing settings.
client_logging	ClientLogging Client Cloud logging configuration.
excel	ExcelSpec Cluster Excel configuration.

StorageSpec

Field

Description

hdd

HddSpec

Configuration of cluster HDD strorage.

ssd

SsdSpec

Configuration of cluster SSD strorage

HddSpec

Field

Description

size_gb

int64

Size of a single HDD disk in GB.

count

int64

Total amount of HDD disks.

SsdSpec

Field	Description
size_gb	int64 Size of a single SSD disk in GB.
type	string Type of a SSD disk.
count	int64 Total amount of SSD disks.
changelogs	Changelogs Configuration of dynamic table changelogs.

Changelogs

Field

Description

size_gb

int64

Size of changelogs disk in GB.

ComputeSpec

Field	Description
preset	string VM configuration preset name.
disks[]	DiskSpec Configuration of exec node strorage.
scale_policy	ScalePolicy Exec nodes scaling policy.
name	string Name for exec pool.

DiskSpec

Field	Description
type	string Type of a disk.
size_gb	int64 Size of a single disk in GB.
locations[]	string Locations on a disk.
location_quotas_gb[]	int64 Quotas for each location. Must be the same length as locations or empty. Zero value will disable quota for location.

ScalePolicy

Field

Description

fixed

FixedScale

Scale policy that doesn't change number of running exec nodes over time.

Includes only one of the fields fixed, auto.

auto

AutoScale

Scale policy that can adjust number of running exec nodes within specified range based on some criteria.

Includes only one of the fields fixed, auto.

FixedScale

Field

Description

size

int64

Amount of exec nodes.

AutoScale

Field	Description
min_size	int64 Minimal amount of exec nodes.
max_size	int64 Maximum amount of exec nodes.
initial_size	int64 Initial amount of exec nodes.
linear	LinearScalingStrategy Linear scaling strategy. Includes only one of the fields `linear`.

LinearScalingStrategy

Field	Description
cooldown_interval	google.protobuf.Duration Cooldown interval.
statistics_interval	google.protobuf.Duration Statistics interval.
overload_coefficient	double Overload coefficient.
underload_coefficient	double Underload coefficient.

TabletSpec

Field

Description

preset

string

VM configuration preset name.

count

int64

Total amount of tablet nodes.

ProxySpec

Field	Description
http	HttpProxySpec Configuration of HTTP proxies.
rpc	RpcProxySpec Configuration of rpc proxies.
task	TaskProxySpec Configuration of task proxies.

HttpProxySpec

Field

Description

count

int64

Total amount of HTTP proxies.

RpcProxySpec

Field

Description

count

int64

Total amount of RPC proxies.

TaskProxySpec

Field

Description

count

int64

Total amount of task proxies.

OdinSpec

Field

Description

checks_ttl

google.protobuf.Duration

TTL of Odin check samples.

CronSpec

Field

Description

clear_tmp

ClearTmpCronSpec

Cluster regular tmp-account cleaning settings.

ClearTmpCronSpec

Field	Description
interval	google.protobuf.Duration Script starting interval.
account_usage_ratio_save_total	double Total max space usage ratio.
account_usage_ratio_save_per_owner	double Per account max space usage ratio.
max_dir_node_count	int64 Max nodes in every directory.

ClientLogging

Field	Description
log_group_id	string ID of cloud logging group. Includes only one of the fields `log_group_id`, `folder_id`. Destination of cloud logging group.
folder_id	string ID of cloud logging folder. Used default loging group. Includes only one of the fields `log_group_id`, `folder_id`. Destination of cloud logging group.
service_account_id	string ID of Service account used for write logs.
audit_logs_enabled	bool Enable audit logs.

ExcelSpec

Field

Description

enabled

bool

Enable Excel.

MaintenanceWindow

Field

Description

anytime

AnytimeMaintenanceWindow

Maintenance can be scheduled anytime.

Includes only one of the fields anytime, weekly_maintenance_window.

weekly_maintenance_window

WeeklyMaintenanceWindow

Maintenance is allowed only within the specified weekly window.

Includes only one of the fields anytime, weekly_maintenance_window.

AnytimeMaintenanceWindow

Field	Description
Empty

WeeklyMaintenanceWindow

Field

Description

day

enum WeekDay

Day of the week when maintenance can occur.

MON: Monday.
TUE: Tuesday.
WED: Wednesday.
THU: Thursday.
FRI: Friday.
SAT: Saturday.
SUN: Sunday.

hour

int64

Hour of the day in UTC when the maintenance window starts.

Acceptable values are 1 to 24, inclusive.

CidrBlocks

Field

Description

v4_cidr_blocks[]

string

IPv4 CIDR blocks.

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.

Ytsaurus API, gRPC: ClusterService.Create

gRPC requestgRPC request

CreateClusterRequestCreateClusterRequest

ClusterSpecClusterSpec

StorageSpecStorageSpec

HddSpecHddSpec

SsdSpecSsdSpec

ChangelogsChangelogs

ComputeSpecComputeSpec

DiskSpecDiskSpec

ScalePolicyScalePolicy

FixedScaleFixedScale

AutoScaleAutoScale

LinearScalingStrategyLinearScalingStrategy

TabletSpecTabletSpec

ProxySpecProxySpec

HttpProxySpecHttpProxySpec

RpcProxySpecRpcProxySpec

TaskProxySpecTaskProxySpec

OdinSpecOdinSpec

CronSpecCronSpec

ClearTmpCronSpecClearTmpCronSpec

ClientLoggingClientLogging

ExcelSpecExcelSpec

MaintenanceWindowMaintenanceWindow

AnytimeMaintenanceWindowAnytimeMaintenanceWindow

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

CidrBlocksCidrBlocks

operation.Operationoperation.Operation

Was the article helpful?

gRPC request

CreateClusterRequest

ClusterSpec

StorageSpec

HddSpec

SsdSpec

Changelogs

ComputeSpec

DiskSpec

ScalePolicy

FixedScale

AutoScale

LinearScalingStrategy

TabletSpec

ProxySpec

HttpProxySpec

RpcProxySpec

TaskProxySpec

OdinSpec

CronSpec

ClearTmpCronSpec

ClientLogging

ExcelSpec

MaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

CidrBlocks

operation.Operation