Ytsaurus API, REST: Cluster.Create

Written by

Updated at December 18, 2025

HTTP request
Body parameters
ClusterSpec
StorageSpec
HddSpec
SsdSpec
Changelogs
ComputeSpec
DiskSpec
ScalePolicy
FixedScale
AutoScale
TabletSpec
ProxySpec
HttpProxySpec
RpcProxySpec
OdinSpec
CronSpec
ClearTmpCronSpec
ClientLogging
CidrBlocks
Response
CreateClusterMetadata
Status
Cluster
ClusterSpec
StorageSpec
HddSpec
SsdSpec
Changelogs
ComputeSpec
DiskSpec
ScalePolicy
FixedScale
AutoScale
TabletSpec
ProxySpec
HttpProxySpec
RpcProxySpec
OdinSpec
CronSpec
ClearTmpCronSpec
ClientLogging
Endpoints
CidrBlocks

Creates a cluster in the specified folder.

HTTP request

POST https://ytsaurus.api.cloud.yandex.net/ytsaurus/v1/clusters

Body parameters

{
  "folderId": "string",
  "zoneId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "subnetId": "string",
  "securityGroupIds": [
    "string"
  ],
  "spec": {
    "storage": {
      "hdd": {
        "sizeGb": "string",
        "count": "string"
      },
      "ssd": {
        "sizeGb": "string",
        "type": "string",
        "count": "string",
        "changelogs": {
          "sizeGb": "string"
        }
      }
    },
    "compute": [
      {
        "preset": "string",
        "disks": [
          {
            "type": "string",
            "sizeGb": "string",
            "locations": [
              "string"
            ]
          }
        ],
        "scalePolicy": {
          // Includes only one of the fields `fixed`, `auto`
          "fixed": {
            "size": "string"
          },
          "auto": {
            "minSize": "string",
            "maxSize": "string"
          }
          // end of the list of possible fields
        },
        "name": "string"
      }
    ],
    "tablet": {
      "preset": "string",
      "count": "string"
    },
    "proxy": {
      "http": {
        "count": "string"
      },
      "rpc": {
        "count": "string"
      }
    },
    "odin": {
      "checksTtl": "string"
    },
    "flavor": "string",
    "cron": {
      "clearTmp": {
        "interval": "string",
        "accountUsageRatioSaveTotal": "string",
        "accountUsageRatioSavePerOwner": "string",
        "maxDirNodeCount": "string"
      }
    },
    "clientLogging": {
      "serviceAccountId": "string",
      // Includes only one of the fields `logGroupId`, `folderId`
      "logGroupId": "string",
      "folderId": "string",
      // end of the list of possible fields
      "auditLogsEnabled": "boolean"
    }
  },
  "cidrBlocksWhitelist": {
    "v4CidrBlocks": [
      "string"
    ]
  }
}

Field	Description
folderId	string Required field. ID of the folder to create the cluster in.
zoneId	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.
subnetId	string Required field. ID of the subnet to create the cluster in.
securityGroupIds[]	string IDs of the security groups to attach to the cluster.
spec	ClusterSpec Cluster specification.
cidrBlocksWhitelist	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.
clientLogging	ClientLogging Client Cloud logging configuration.

StorageSpec

Field

Description

hdd

HddSpec

Configuration of cluster HDD strorage.

ssd

SsdSpec

Configuration of cluster SSD strorage

HddSpec

Field

Description

sizeGb

string (int64)

Size of a single HDD disk in GB.

count

string (int64)

Total amount of HDD disks.

SsdSpec

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

Changelogs

Field

Description

sizeGb

string (int64)

Size of changelogs disk in GB.

ComputeSpec

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

DiskSpec

Field	Description
type	string Type of a disk.
sizeGb	string (int64) Size of a single disk in GB.
locations[]	string Locations on a disk.

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

string (int64)

Amount of exec nodes.

AutoScale

Field

Description

minSize

string (int64)

Minimal amount of exec nodes.

maxSize

string (int64)

Maximum amount of exec nodes.

TabletSpec

Field

Description

preset

string

VM configuration preset name.

count

string (int64)

Total amount of tablet nodes.

ProxySpec

Field

Description

http

HttpProxySpec

Configuration of HTTP proxies.

rpc

RpcProxySpec

Configuration of rpc proxies.

HttpProxySpec

Field

Description

count

string (int64)

Total amount of HTTP proxies.

RpcProxySpec

Field

Description

count

string (int64)

Total amount of RPC proxies.

OdinSpec

Field

Description

checksTtl

string (duration)

TTL of Odin check samples.

CronSpec

Field

Description

clearTmp

ClearTmpCronSpec

Cluster regular tmp-account cleaning settings.

ClearTmpCronSpec

Field	Description
interval	string (duration) Script starting interval.
accountUsageRatioSaveTotal	string Total max space usage ratio.
accountUsageRatioSavePerOwner	string Per account max space usage ratio.
maxDirNodeCount	string (int64) Max nodes in every directory.

ClientLogging

Field	Description
serviceAccountId	string ID of Service account used for write logs.
logGroupId	string ID of cloud logging group. Includes only one of the fields `logGroupId`, `folderId`. Destination of cloud logging group.
folderId	string ID of cloud logging folder. Used default loging group. Includes only one of the fields `logGroupId`, `folderId`. Destination of cloud logging group.
auditLogsEnabled	boolean Enable audit logs.

CidrBlocks

Field

Description

v4CidrBlocks[]

string

IPv4 CIDR blocks.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "clusterId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "folderId": "string",
    "zoneId": "string",
    "name": "string",
    "description": "string",
    "labels": "object",
    "subnetId": "string",
    "securityGroupIds": [
      "string"
    ],
    "spec": {
      "storage": {
        "hdd": {
          "sizeGb": "string",
          "count": "string"
        },
        "ssd": {
          "sizeGb": "string",
          "type": "string",
          "count": "string",
          "changelogs": {
            "sizeGb": "string"
          }
        }
      },
      "compute": [
        {
          "preset": "string",
          "disks": [
            {
              "type": "string",
              "sizeGb": "string",
              "locations": [
                "string"
              ]
            }
          ],
          "scalePolicy": {
            // Includes only one of the fields `fixed`, `auto`
            "fixed": {
              "size": "string"
            },
            "auto": {
              "minSize": "string",
              "maxSize": "string"
            }
            // end of the list of possible fields
          },
          "name": "string"
        }
      ],
      "tablet": {
        "preset": "string",
        "count": "string"
      },
      "proxy": {
        "http": {
          "count": "string"
        },
        "rpc": {
          "count": "string"
        }
      },
      "odin": {
        "checksTtl": "string"
      },
      "flavor": "string",
      "cron": {
        "clearTmp": {
          "interval": "string",
          "accountUsageRatioSaveTotal": "string",
          "accountUsageRatioSavePerOwner": "string",
          "maxDirNodeCount": "string"
        }
      },
      "clientLogging": {
        "serviceAccountId": "string",
        // Includes only one of the fields `logGroupId`, `folderId`
        "logGroupId": "string",
        "folderId": "string",
        // end of the list of possible fields
        "auditLogsEnabled": "boolean"
      }
    },
    "createdAt": "string",
    "createdBy": "string",
    "updatedAt": "string",
    "updatedBy": "string",
    "status": "string",
    "health": "string",
    "endpoints": {
      "ui": "string",
      "externalHttpProxyBalancer": "string",
      "internalHttpProxyAlias": "string",
      "internalRpcProxyAlias": "string"
    },
    "cidrBlocksWhitelist": {
      "v4CidrBlocks": [
        "string"
      ]
    }
  }
  // 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 `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. 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 `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. 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 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	CreateClusterMetadata 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	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	Cluster 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.

CreateClusterMetadata

Field

Description

clusterId

string

ID of the cluster being created.

Status

The error result of the operation in case of failure or cancellation.

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

Cluster

Field	Description
id	string ID of the cluster. Generated at creation time.
folderId	string ID of the folder that the cluster belongs to.
zoneId	string ID of the availability zone where the cluster resides.
name	string Name of the cluster. The name is unique within the folder.
description	string Description of the cluster.
labels	object (map<string, string>) Cluster labels as `key:value` pairs.
subnetId	string ID of the subnet where the cluster resides.
securityGroupIds[]	string Network interfaces security groups.
spec	ClusterSpec Cluster specification.
createdAt	string (date-time) Time when the cluster was created. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. 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 User who created the cluster.
updatedAt	string (date-time) Time when the cluster was last updated. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. 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).
updatedBy	string User who last updated the cluster.
status	enum (Status) Status of the cluster. `STATUS_UNKNOWN`: Unknown status. `CREATING`: Cluster is being created. `RUNNING`: Cluster is running. `ERROR`: Cluster encountered a problem and cannot operate. `STOPPING`: Cluster is being stopped. `STOPPED`: Cluster stopped. `STARTING`: Cluster is being started. `UPDATING`: Cluster is being updated. `DELETING`: Cluster is being deleted.
health	enum (Health) Health of the cluster. `HEALTH_UNKNOWN`: Unknown health. `ALIVE`: Cluster is alive. `DEAD`: Cluster is dead. `DEGRADED`: Cluster is degraded.
endpoints	Endpoints Endpoints of the cluster.
cidrBlocksWhitelist	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.
clientLogging	ClientLogging Client Cloud logging configuration.

StorageSpec

Field

Description

hdd

HddSpec

Configuration of cluster HDD strorage.

ssd

SsdSpec

Configuration of cluster SSD strorage

HddSpec

Field

Description

sizeGb

string (int64)

Size of a single HDD disk in GB.

count

string (int64)

Total amount of HDD disks.

SsdSpec

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

Changelogs

Field

Description

sizeGb

string (int64)

Size of changelogs disk in GB.

ComputeSpec

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

DiskSpec

Field	Description
type	string Type of a disk.
sizeGb	string (int64) Size of a single disk in GB.
locations[]	string Locations on a disk.

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

string (int64)

Amount of exec nodes.

AutoScale

Field

Description

minSize

string (int64)

Minimal amount of exec nodes.

maxSize

string (int64)

Maximum amount of exec nodes.

TabletSpec

Field

Description

preset

string

VM configuration preset name.

count

string (int64)

Total amount of tablet nodes.

ProxySpec

Field

Description

http

HttpProxySpec

Configuration of HTTP proxies.

rpc

RpcProxySpec

Configuration of rpc proxies.

HttpProxySpec

Field

Description

count

string (int64)

Total amount of HTTP proxies.

RpcProxySpec

Field

Description

count

string (int64)

Total amount of RPC proxies.

OdinSpec

Field

Description

checksTtl

string (duration)

TTL of Odin check samples.

CronSpec

Field

Description

clearTmp

ClearTmpCronSpec

Cluster regular tmp-account cleaning settings.

ClearTmpCronSpec

Field	Description
interval	string (duration) Script starting interval.
accountUsageRatioSaveTotal	string Total max space usage ratio.
accountUsageRatioSavePerOwner	string Per account max space usage ratio.
maxDirNodeCount	string (int64) Max nodes in every directory.

ClientLogging

Field	Description
serviceAccountId	string ID of Service account used for write logs.
logGroupId	string ID of cloud logging group. Includes only one of the fields `logGroupId`, `folderId`. Destination of cloud logging group.
folderId	string ID of cloud logging folder. Used default loging group. Includes only one of the fields `logGroupId`, `folderId`. Destination of cloud logging group.
auditLogsEnabled	boolean Enable audit logs.

Endpoints

Field	Description
ui	string https://CID.ytsaurus.yandexcloud.net
externalHttpProxyBalancer	string https://proxy.CID.ytsaurus.yandexcloud.net
internalHttpProxyAlias	string https://hp.CID.ytsaurus.mdb.yandexcloud.net:PORT
internalRpcProxyAlias	string rp.CID.ytsaurus.mdb.yandexcloud.net:PORT

CidrBlocks

Field

Description

v4CidrBlocks[]

string

IPv4 CIDR blocks.

Ytsaurus API, REST: Cluster.Create

HTTP requestHTTP request

Body parametersBody parameters

ClusterSpecClusterSpec

StorageSpecStorageSpec

HddSpecHddSpec

SsdSpecSsdSpec

ChangelogsChangelogs

ComputeSpecComputeSpec

DiskSpecDiskSpec

ScalePolicyScalePolicy

FixedScaleFixedScale

AutoScaleAutoScale

TabletSpecTabletSpec

ProxySpecProxySpec

HttpProxySpecHttpProxySpec

RpcProxySpecRpcProxySpec

OdinSpecOdinSpec

CronSpecCronSpec

ClearTmpCronSpecClearTmpCronSpec

ClientLoggingClientLogging

CidrBlocksCidrBlocks

ResponseResponse

CreateClusterMetadataCreateClusterMetadata

StatusStatus

ClusterCluster

ClusterSpecClusterSpec

StorageSpecStorageSpec

HddSpecHddSpec

SsdSpecSsdSpec

ChangelogsChangelogs

ComputeSpecComputeSpec

DiskSpecDiskSpec

ScalePolicyScalePolicy

FixedScaleFixedScale

AutoScaleAutoScale

TabletSpecTabletSpec

ProxySpecProxySpec

HttpProxySpecHttpProxySpec

RpcProxySpecRpcProxySpec

OdinSpecOdinSpec

CronSpecCronSpec

ClearTmpCronSpecClearTmpCronSpec

ClientLoggingClientLogging

EndpointsEndpoints

CidrBlocksCidrBlocks

Was the article helpful?

HTTP request

Body parameters

ClusterSpec

StorageSpec

HddSpec

SsdSpec

Changelogs

ComputeSpec

DiskSpec

ScalePolicy

FixedScale

AutoScale

TabletSpec

ProxySpec

HttpProxySpec

RpcProxySpec

OdinSpec

CronSpec

ClearTmpCronSpec

ClientLogging

CidrBlocks

Response

CreateClusterMetadata

Status

Cluster

ClusterSpec

StorageSpec

HddSpec

SsdSpec

Changelogs

ComputeSpec

DiskSpec

ScalePolicy

FixedScale

AutoScale

TabletSpec

ProxySpec

HttpProxySpec

RpcProxySpec

OdinSpec

CronSpec

ClearTmpCronSpec

ClientLogging

Endpoints

CidrBlocks