Ytsaurus API, REST: Cluster.List

Статья создана

Обновлена 18 декабря 2025 г.

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

Retrieves the list of clusters in the specified folder.

HTTP request

GET https://ytsaurus.api.yandexcloud.kz/ytsaurus/v1/clusters

Query parameters

Field	Description
folderId	string Required field. ID of the folder to list clusters in.
pageSize	string (int64) The maximum number of results per page to return. If the number of available results is larger than `page_size`, the service returns a ListClustersResponse.nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100.
pageToken	string Page token. To get the next page of results, set `page_token` to the ListClustersResponse.nextPageToken returned by a previous list request.
filter[]	string A filter expression that filters clusters listed in the response.

Response

HTTP Code: 200 - OK

{
  "clusters": [
    {
      "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"
        ]
      }
    }
  ],
  "nextPageToken": "string"
}

Field

Description

clusters[]

Cluster

List of clusters in the specified folder.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListClustersRequest.pageSize, use the nextPageToken as the value
for the ListClustersRequest.pageToken query parameter in the next list request.
Each subsequent list request will have its own nextPageToken to continue paging through the results.

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.List

HTTP requestHTTP request

Query parametersQuery parameters

ResponseResponse

ClusterCluster

ClusterSpecClusterSpec

StorageSpecStorageSpec

HddSpecHddSpec

SsdSpecSsdSpec

ChangelogsChangelogs

ComputeSpecComputeSpec

DiskSpecDiskSpec

ScalePolicyScalePolicy

FixedScaleFixedScale

AutoScaleAutoScale

TabletSpecTabletSpec

ProxySpecProxySpec

HttpProxySpecHttpProxySpec

RpcProxySpecRpcProxySpec

OdinSpecOdinSpec

CronSpecCronSpec

ClearTmpCronSpecClearTmpCronSpec

ClientLoggingClientLogging

EndpointsEndpoints

CidrBlocksCidrBlocks

Была ли статья полезна?

HTTP request

Query parameters

Response

Cluster

ClusterSpec

StorageSpec

HddSpec

SsdSpec

Changelogs

ComputeSpec

DiskSpec

ScalePolicy

FixedScale

AutoScale

TabletSpec

ProxySpec

HttpProxySpec

RpcProxySpec

OdinSpec

CronSpec

ClearTmpCronSpec

ClientLogging

Endpoints

CidrBlocks