Ytsaurus API, REST: Cluster.Update

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

Обновлена 30 октября 2025 г.

HTTP request
Body parameters
ClusterSpec
StorageSpec
HddSpec
SsdSpec
ComputeSpec
DiskSpec
ScalePolicy
FixedScale
AutoScale
TabletSpec
ProxySpec
HttpProxySpec
RpcProxySpec
OdinSpec
Response
UpdateClusterMetadata
Status
Cluster
ClusterSpec
StorageSpec
HddSpec
SsdSpec
ComputeSpec
DiskSpec
ScalePolicy
FixedScale
AutoScale
TabletSpec
ProxySpec
HttpProxySpec
RpcProxySpec
OdinSpec
Endpoints

Updates the specified cluster.

HTTP request

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

Body parameters

{
  "clusterId": "string",
  "updateMask": "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"
  }
}

Field	Description
clusterId	string Required field. ID of the cluster to update.
updateMask	string (field-mask) A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in `updateMask` and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0. If `updateMask` is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.
name	string New name for the cluster. The name must be unique within the folder.
description	string New description for the cluster.
labels	object (map<string, string>) Cluster labels as `key:value` pairs. Existing set of labels is completely replaced by the provided set, so if you just want to add or remove a label: Get the current set of labels with a ClusterService.Get request. Add or remove a label in this set. Send the new set in this field.
subnetId	string New subnet for the cluster.
securityGroupIds[]	string New security groups for the cluster.
spec	ClusterSpec New cluster specification.

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)

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"
        }
      },
      "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"
    }
  }
  // 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	UpdateClusterMetadata 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.

UpdateClusterMetadata

Field

Description

clusterId

string

ID of the cluster that is being updated.

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` `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

Ytsaurus API, REST: Cluster.Update

HTTP requestHTTP request

Body parametersBody parameters

ClusterSpecClusterSpec

StorageSpecStorageSpec

HddSpecHddSpec

SsdSpecSsdSpec

ComputeSpecComputeSpec

DiskSpecDiskSpec

ScalePolicyScalePolicy

FixedScaleFixedScale

AutoScaleAutoScale

TabletSpecTabletSpec

ProxySpecProxySpec

HttpProxySpecHttpProxySpec

RpcProxySpecRpcProxySpec

OdinSpecOdinSpec

ResponseResponse

UpdateClusterMetadataUpdateClusterMetadata

StatusStatus

ClusterCluster

ClusterSpecClusterSpec

StorageSpecStorageSpec

HddSpecHddSpec

SsdSpecSsdSpec

ComputeSpecComputeSpec

DiskSpecDiskSpec

ScalePolicyScalePolicy

FixedScaleFixedScale

AutoScaleAutoScale

TabletSpecTabletSpec

ProxySpecProxySpec

HttpProxySpecHttpProxySpec

RpcProxySpecRpcProxySpec

OdinSpecOdinSpec

EndpointsEndpoints

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

HTTP request

Body parameters

ClusterSpec

StorageSpec

HddSpec

SsdSpec

ComputeSpec

DiskSpec

ScalePolicy

FixedScale

AutoScale

TabletSpec

ProxySpec

HttpProxySpec

RpcProxySpec

OdinSpec

Response

UpdateClusterMetadata

Status

Cluster

ClusterSpec

StorageSpec

HddSpec

SsdSpec

ComputeSpec

DiskSpec

ScalePolicy

FixedScale

AutoScale

TabletSpec

ProxySpec

HttpProxySpec

RpcProxySpec

OdinSpec

Endpoints