Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Ytsaurus API, REST: Cluster.Get

Written by
Updated at October 30, 2025

Returns the specified cluster.

HTTP request

GET https://ytsaurus.api.cloud.yandex.net/ytsaurus/v1/clusters/{clusterId}

Path parameters

Field

Description

clusterId

string

Required field. ID of the cluster to return.

Response

HTTP Code: 200 - OK

{
  "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"
      }
    },
    "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"
  },
  "createdAt": "string",
  "createdBy": "string",
  "updatedAt": "string",
  "updatedBy": "string",
  "status": "string",
  "health": "string",
  "endpoints": {
    "ui": "string",
    "externalHttpProxyBalancer": "string",
    "internalHttpProxyAlias": "string",
    "internalRpcProxyAlias": "string"
  }
}

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
  • 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
  • ALIVE: Cluster is alive.
  • DEAD: Cluster is dead.
  • DEGRADED: Cluster is degraded.

endpoints

Endpoints

Endpoints of the cluster.

ClusterSpec

Field

Description

storage

StorageSpec

compute[]

ComputeSpec

tablet

TabletSpec

proxy

ProxySpec

odin

OdinSpec

flavor

enum (Flavor)

  • FLAVOR_UNSPECIFIED
  • DEMO: Demo cluster configuration with minimal system resources. Not fault-tolerant, not for production use.

StorageSpec

Field

Description

hdd

HddSpec

ssd

SsdSpec

HddSpec

Field

Description

sizeGb

string (int64)

count

string (int64)

SsdSpec

Field

Description

sizeGb

string (int64)

type

string

count

string (int64)

ComputeSpec

Field

Description

preset

string

disks[]

DiskSpec

scalePolicy

ScalePolicy

name

string

Name for exec pool.

DiskSpec

Field

Description

type

string

sizeGb

string (int64)

locations[]

string

ScalePolicy

Field

Description

fixed

FixedScale

Includes only one of the fields fixed, auto.

auto

AutoScale

Includes only one of the fields fixed, auto.

FixedScale

Field

Description

size

string (int64)

AutoScale

Field

Description

minSize

string (int64)

maxSize

string (int64)

TabletSpec

Field

Description

preset

string

count

string (int64)

ProxySpec

Field

Description

http

HttpProxySpec

rpc

RpcProxySpec

HttpProxySpec

Field

Description

count

string (int64)

RpcProxySpec

Field

Description

count

string (int64)

OdinSpec

Field

Description

checksTtl

string (duration)

Endpoints

Field

Description

ui

string

https://CID.ui.ytsaurus.yandexcloud.net

externalHttpProxyBalancer

string

https://CID.proxy.ytsaurus.yandexcloud.net

internalHttpProxyAlias

string

https://hp.CID.ytsaurus.mdb.yandexcloud.net:PORT

internalRpcProxyAlias

string

rp.CID.ytsaurus.mdb.yandexcloud.net:PORT
Previous
Overview
Next
List
© 2025 Direct Cursus Technology L.L.C.