Yandex Cloud
Поиск
Связаться с намиПодключиться
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Контейнеры
    • Инструменты разработчика
    • Бессерверные вычисления
    • Безопасность
    • Мониторинг и управление ресурсами
    • Машинное обучение
    • Бизнес-инструменты
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Истории успеха
    • Тарифы Yandex Cloud
    • Промоакции и free tier
    • Правила тарификации
  • Документация
  • Блог
Проект Яндекса
© 2025 ООО «Яндекс.Облако»
Yandex Data Processing
  • Начало работы
  • Управление доступом
  • Правила тарификации
  • Справочник Terraform
    • Аутентификация в API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • Start
        • Stop
        • ListOperations
        • ListHosts
        • ListUILinks
  • Метрики Monitoring
  • Аудитные логи Audit Trails
  • Публичные материалы
  • Вопросы и ответы
  • Обучающие курсы

В этой статье:

  • gRPC request
  • UpdateClusterRequest
  • UpdateClusterConfigSpec
  • UpdateSubclusterConfigSpec
  • Resources
  • AutoscalingConfig
  • HadoopConfig
  • InitializationAction
  • operation.Operation
  • UpdateClusterMetadata
  • Cluster
  • Monitoring
  • ClusterConfig
  • HadoopConfig
  • InitializationAction
  1. Справочник API
  2. gRPC (англ.)
  3. Cluster
  4. Update

Yandex Data Processing API, gRPC: ClusterService.Update

Статья создана
Yandex Cloud
Обновлена 24 апреля 2025 г.
  • gRPC request
  • UpdateClusterRequest
  • UpdateClusterConfigSpec
  • UpdateSubclusterConfigSpec
  • Resources
  • AutoscalingConfig
  • HadoopConfig
  • InitializationAction
  • operation.Operation
  • UpdateClusterMetadata
  • Cluster
  • Monitoring
  • ClusterConfig
  • HadoopConfig
  • InitializationAction

Updates the configuration of the specified cluster.

gRPC requestgRPC request

rpc Update (UpdateClusterRequest) returns (operation.Operation)

UpdateClusterRequestUpdateClusterRequest

{
  "cluster_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "description": "string",
  "labels": "map<string, string>",
  "config_spec": {
    "subclusters_spec": [
      {
        "id": "string",
        "name": "string",
        "resources": {
          "resource_preset_id": "string",
          "disk_type_id": "string",
          "disk_size": "int64"
        },
        "hosts_count": "int64",
        "autoscaling_config": {
          "max_hosts_count": "int64",
          "preemptible": "bool",
          "measurement_duration": "google.protobuf.Duration",
          "warmup_duration": "google.protobuf.Duration",
          "stabilization_duration": "google.protobuf.Duration",
          "cpu_utilization_target": "double",
          "decommission_timeout": "int64"
        }
      }
    ],
    "hadoop": {
      "services": [
        "Service"
      ],
      "properties": "map<string, string>",
      "ssh_public_keys": [
        "string"
      ],
      "initialization_actions": [
        {
          "uri": "string",
          "args": [
            "string"
          ],
          "timeout": "int64"
        }
      ],
      "oslogin_enabled": "bool"
    }
  },
  "name": "string",
  "service_account_id": "string",
  "bucket": "string",
  "decommission_timeout": "int64",
  "ui_proxy": "bool",
  "security_group_ids": [
    "string"
  ],
  "deletion_protection": "bool",
  "log_group_id": "string"
}

Field

Description

cluster_id

string

ID of the cluster to update.

To get the cluster ID, make a ClusterService.List request.

update_mask

google.protobuf.FieldMask

Field mask that specifies which attributes of the cluster should be updated.

description

string

New description for the cluster.

labels

object (map<string, string>)

A new set of cluster labels as key:value pairs.

config_spec

UpdateClusterConfigSpec

Configuration and resources for hosts that should be created with the Yandex Data Processing cluster.

name

string

New name for the Yandex Data Processing cluster. The name must be unique within the folder.

service_account_id

string

ID of the new service account to be used by the Yandex Data Processing manager agent.

bucket

string

Name of the new Object Storage bucket to use for Yandex Data Processing jobs.

decommission_timeout

int64

Timeout to gracefully decommission nodes. In seconds. Default value: 0

ui_proxy

bool

Enable UI Proxy feature.

security_group_ids[]

string

User security groups.

deletion_protection

bool

Deletion Protection inhibits deletion of the cluster

log_group_id

string

ID of the cloud logging log group to write logs. If not set, logs will not be sent to logging service

UpdateClusterConfigSpecUpdateClusterConfigSpec

Field

Description

subclusters_spec[]

UpdateSubclusterConfigSpec

New configuration for subclusters in a cluster.

hadoop

HadoopConfig

Hadoop specific options

UpdateSubclusterConfigSpecUpdateSubclusterConfigSpec

Field

Description

id

string

ID of the subcluster to update.

To get the subcluster ID make a SubclusterService.List request.

name

string

Name of the subcluster.

resources

Resources

Resource configuration for each host in the subcluster.

hosts_count

int64

Number of hosts in the subcluster.

autoscaling_config

AutoscalingConfig

Configuration for instance group based subclusters

ResourcesResources

Field

Description

resource_preset_id

string

ID of the resource preset for computational resources available to a host (CPU, memory etc.).
All available presets are listed in the documentation.

disk_type_id

string

Type of the storage environment for the host.
Possible values:

  • network-hdd - network HDD drive,
  • network-ssd - network SSD drive.

disk_size

int64

Volume of the storage available to a host, in bytes.

AutoscalingConfigAutoscalingConfig

Field

Description

max_hosts_count

int64

Upper limit for total instance subcluster count.

preemptible

bool

Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time
if their resources are needed by Compute.
For more information, see Preemptible Virtual Machines.

measurement_duration

google.protobuf.Duration

Required field. Time in seconds allotted for averaging metrics.

warmup_duration

google.protobuf.Duration

The warmup time of the instance in seconds. During this time,
traffic is sent to the instance, but instance metrics are not collected.

stabilization_duration

google.protobuf.Duration

Minimum amount of time in seconds allotted for monitoring before
Instance Groups can reduce the number of instances in the group.
During this time, the group size doesn't decrease, even if the new metric values
indicate that it should.

cpu_utilization_target

double

Defines an autoscaling rule based on the average CPU utilization of the instance group.

decommission_timeout

int64

Timeout to gracefully decommission nodes during downscaling. In seconds. Default value: 120

HadoopConfigHadoopConfig

Hadoop configuration that describes services installed in a cluster,
their properties and settings.

Field

Description

services[]

enum Service

Set of services used in the cluster (if empty, the default set is used).

  • SERVICE_UNSPECIFIED
  • HDFS
  • YARN
  • MAPREDUCE
  • HIVE
  • TEZ
  • ZOOKEEPER
  • HBASE
  • SQOOP
  • FLUME
  • SPARK
  • ZEPPELIN
  • OOZIE
  • LIVY

properties

object (map<string, string>)

Properties set for all hosts in *-site.xml configurations. The key should indicate
the service and the property.

For example, use the key 'hdfs:dfs.replication' to set the dfs.replication property
in the file /etc/hadoop/conf/hdfs-site.xml.

ssh_public_keys[]

string

List of public SSH keys to access to cluster hosts.

initialization_actions[]

InitializationAction

Set of init-actions

oslogin_enabled

bool

Oslogin enable on cluster nodes

InitializationActionInitializationAction

Field

Description

uri

string

URI of the executable file

args[]

string

Arguments to the initialization action

timeout

int64

Execution timeout

operation.Operationoperation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "cluster_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "monitoring": [
      {
        "name": "string",
        "description": "string",
        "link": "string"
      }
    ],
    "config": {
      "version_id": "string",
      "hadoop": {
        "services": [
          "Service"
        ],
        "properties": "map<string, string>",
        "ssh_public_keys": [
          "string"
        ],
        "initialization_actions": [
          {
            "uri": "string",
            "args": [
              "string"
            ],
            "timeout": "int64"
          }
        ],
        "oslogin_enabled": "bool"
      }
    },
    "health": "Health",
    "status": "Status",
    "zone_id": "string",
    "service_account_id": "string",
    "bucket": "string",
    "ui_proxy": "bool",
    "security_group_ids": [
      "string"
    ],
    "host_group_ids": [
      "string"
    ],
    "deletion_protection": "bool",
    "log_group_id": "string",
    "environment": "Environment"
  }
  // 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

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

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

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.

UpdateClusterMetadataUpdateClusterMetadata

Field

Description

cluster_id

string

ID of the cluster that is being updated.

ClusterCluster

A Yandex Data Processing cluster. For details about the concept, see documentation.

Field

Description

id

string

ID of the cluster. Generated at creation time.

folder_id

string

ID of the folder that the cluster belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp.

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.

monitoring[]

Monitoring

Monitoring systems relevant to the cluster.

config

ClusterConfig

Configuration of the cluster.

health

enum Health

Aggregated cluster health.

  • HEALTH_UNKNOWN: Object is in unknown state (we have no data).
  • ALIVE: Object is alive and well (for example, all hosts of the cluster are alive).
  • DEAD: Object is inoperable (it cannot perform any of its essential functions).
  • DEGRADED: Object is partially alive (it can perform some of its essential functions).

status

enum Status

Cluster status.

  • STATUS_UNKNOWN: Cluster state is unknown.
  • CREATING: Cluster is being created.
  • RUNNING: Cluster is running normally.
  • ERROR: Cluster encountered a problem and cannot operate.
  • STOPPING: Cluster is stopping.
  • STOPPED: Cluster stopped.
  • STARTING: Cluster is starting.

zone_id

string

ID of the availability zone where the cluster resides.

service_account_id

string

ID of service account for the Yandex Data Processing manager agent.

bucket

string

Object Storage bucket to be used for Yandex Data Processing jobs that are run in the cluster.

ui_proxy

bool

Whether UI Proxy feature is enabled.

security_group_ids[]

string

User security groups.

host_group_ids[]

string

Host groups hosting VMs of the cluster.

deletion_protection

bool

Deletion Protection inhibits deletion of the cluster

log_group_id

string

ID of the cloud logging log group to write logs. If not set, default log group for the folder will be used.
To prevent logs from being sent to the cloud set cluster property dataproc:disable_cloud_logging = true

environment

enum Environment

Environment of the cluster

  • ENVIRONMENT_UNSPECIFIED
  • PRODUCTION
  • PRESTABLE

MonitoringMonitoring

Metadata of a monitoring system for a Yandex Data Processing cluster.

Field

Description

name

string

Name of the monitoring system.

description

string

Description of the monitoring system.

link

string

Link to the monitoring system.

ClusterConfigClusterConfig

Field

Description

version_id

string

Image version for cluster provisioning.
All available versions are listed in the documentation.

hadoop

HadoopConfig

Yandex Data Processing specific configuration options.

HadoopConfigHadoopConfig

Hadoop configuration that describes services installed in a cluster,
their properties and settings.

Field

Description

services[]

enum Service

Set of services used in the cluster (if empty, the default set is used).

  • SERVICE_UNSPECIFIED
  • HDFS
  • YARN
  • MAPREDUCE
  • HIVE
  • TEZ
  • ZOOKEEPER
  • HBASE
  • SQOOP
  • FLUME
  • SPARK
  • ZEPPELIN
  • OOZIE
  • LIVY

properties

object (map<string, string>)

Properties set for all hosts in *-site.xml configurations. The key should indicate
the service and the property.

For example, use the key 'hdfs:dfs.replication' to set the dfs.replication property
in the file /etc/hadoop/conf/hdfs-site.xml.

ssh_public_keys[]

string

List of public SSH keys to access to cluster hosts.

initialization_actions[]

InitializationAction

Set of init-actions

oslogin_enabled

bool

Oslogin enable on cluster nodes

InitializationActionInitializationAction

Field

Description

uri

string

URI of the executable file

args[]

string

Arguments to the initialization action

timeout

int64

Execution timeout

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

Предыдущая
Create
Следующая
Delete
Проект Яндекса
© 2025 ООО «Яндекс.Облако»