Managed Spark API, gRPC: ClusterService.Update

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

Yandex Cloud

Обновлена 1 июля 2026 г.

Открыть в Markdown

gRPC request
UpdateClusterRequest
UpdateClusterConfigSpec
ResourcePools
ResourcePool
ScalePolicy
FixedScale
AutoScale
HistoryServerConfig
Dependencies
Metastore
UpdateNetworkConfigSpec
LoggingConfig
MaintenanceWindow
AnytimeMaintenanceWindow
WeeklyMaintenanceWindow
operation.Operation

Updates configuration of the specified Spark cluster.

gRPC request

rpc Update (UpdateClusterRequest) returns (operation.Operation)

UpdateClusterRequest

{
  "cluster_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "config_spec": {
    "resource_pools": {
      "driver": {
        "resource_preset_id": "string",
        "scale_policy": {
          // Includes only one of the fields `fixed_scale`, `auto_scale`
          "fixed_scale": {
            "size": "int64"
          },
          "auto_scale": {
            "min_size": "int64",
            "max_size": "int64"
          }
          // end of the list of possible fields
        }
      },
      "executor": {
        "resource_preset_id": "string",
        "scale_policy": {
          // Includes only one of the fields `fixed_scale`, `auto_scale`
          "fixed_scale": {
            "size": "int64"
          },
          "auto_scale": {
            "min_size": "int64",
            "max_size": "int64"
          }
          // end of the list of possible fields
        }
      }
    },
    "history_server": {
      "enabled": "bool"
    },
    "dependencies": {
      "pip_packages": [
        "string"
      ],
      "deb_packages": [
        "string"
      ]
    },
    "metastore": {
      "cluster_id": "string"
    },
    "spark_version": "string",
    "environment_id": "string"
  },
  "network_spec": {
    "security_group_ids": [
      "string"
    ]
  },
  "deletion_protection": "bool",
  "service_account_id": "string",
  "logging": {
    "enabled": "bool",
    // Includes only one of the fields `folder_id`, `log_group_id`
    "folder_id": "string",
    "log_group_id": "string"
    // end of the list of possible fields
  },
  "maintenance_window": {
    // Includes only one of the fields `anytime`, `weekly_maintenance_window`
    "anytime": "AnytimeMaintenanceWindow",
    "weekly_maintenance_window": {
      "day": "WeekDay",
      "hour": "int64"
    }
    // end of the list of possible fields
  }
}

Update Cluster Request.

Field	Description
cluster_id	string Required field. ID of the Spark cluster. The maximum string length in characters is 50.
update_mask	google.protobuf.FieldMask Cluster Update Field Mask.
name	string Value must match the regular expression `\|[a-z][-a-z0-9]{1,61}[a-z0-9]`.
description	string Description of the Spark cluster. 0-256 characters long. The maximum string length in characters is 256.
labels	object (map<string, string>) Cluster Labels. The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression `[a-z][-_0-9a-z]`. Each value must match the regular expression `[-_0-9a-z]`. No more than 64 per resource.
config_spec	UpdateClusterConfigSpec Cluster Update Configuration.
network_spec	UpdateNetworkConfigSpec Network Update Configuration.
deletion_protection	bool Deletion Protection inhibits deletion of the cluster.
service_account_id	string Service account used to access Cloud resources. The maximum string length in characters is 50.
logging	LoggingConfig Cloud logging configuration.
maintenance_window	MaintenanceWindow Window of maintenance operations.

UpdateClusterConfigSpec

Cluster Update Configuration.

Field	Description
resource_pools	ResourcePools Resource Pools.
history_server	HistoryServerConfig Configuration for HistoryServer.
dependencies	Dependencies Container custom environment dependencies.
metastore	Metastore Metastore Cluster.
spark_version	string Spark version. Format: "Major.Minor".
environment_id	string Job Environment ID. The maximum string length in characters is 50.

ResourcePools

Resource Pools.

Field

Description

driver

ResourcePool

Required field. Driver Resource Pool.

executor

ResourcePool

Required field. Executor Resource Pool.

ResourcePool

Resource Pool.

Field

Description

resource_preset_id

string

Required field. ID of the preset for computational resources allocated to a instance (e.g., CPU, memory, etc.).

The maximum string length in characters is 50.

scale_policy

ScalePolicy

Required field. Scale Policy.

ScalePolicy

Scale Policy.

Field

Description

fixed_scale

FixedScale

Fixed Scale Policy.

Includes only one of the fields fixed_scale, auto_scale.

Scale Type.

auto_scale

AutoScale

Auto Scale Policy.

Includes only one of the fields fixed_scale, auto_scale.

Scale Type.

FixedScale

Fixed Scale Policy.

Field

Description

size

int64

Fixed Size.

Acceptable values are 1 to 100, inclusive.

AutoScale

Auto Scale Policy.

Field

Description

min_size

int64

Min Size.

Acceptable values are 0 to 100, inclusive.

max_size

int64

Max Size.

Acceptable values are 1 to 100, inclusive.

HistoryServerConfig

Configuration for HistoryServer.

Field

Description

enabled

bool

History Server is enabled.

Dependencies

Cluster Dependencies.

Field

Description

pip_packages[]

string

Pip Packages.

deb_packages[]

string

Deb Packages.

Metastore

Metastore Cluster.

Field

Description

cluster_id

string

Cluster ID.

The maximum string length in characters is 50.

UpdateNetworkConfigSpec

Network Update Configuration.

Field

Description

security_group_ids[]

string

User security groups.

LoggingConfig

Logging Config.

Field	Description
enabled	bool Logging is enabled.
folder_id	string Folder ID. Value must match the regular expression `([a-zA-Z][-a-zA-Z0-9_.]{0,63})?`. Includes only one of the fields `folder_id`, `log_group_id`. Destination.
log_group_id	string Logging Group ID. Value must match the regular expression `([a-zA-Z][-a-zA-Z0-9_.]{0,63})?`. Includes only one of the fields `folder_id`, `log_group_id`. Destination.

MaintenanceWindow

Field

Description

anytime

AnytimeMaintenanceWindow

Includes only one of the fields anytime, weekly_maintenance_window.

weekly_maintenance_window

WeeklyMaintenanceWindow

Includes only one of the fields anytime, weekly_maintenance_window.

AnytimeMaintenanceWindow

Field	Description
Empty

WeeklyMaintenanceWindow

Field

Description

day

enum WeekDay

MON
TUE
WED
THU
FRI
SAT
SUN

hour

int64

Hour of the day in UTC.

Acceptable values are 1 to 24, inclusive.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // 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	google.protobuf.Any 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	google.protobuf.Any 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.

Managed Spark API, gRPC: ClusterService.Update

gRPC requestgRPC request

UpdateClusterRequestUpdateClusterRequest

UpdateClusterConfigSpecUpdateClusterConfigSpec

ResourcePoolsResourcePools

ResourcePoolResourcePool

ScalePolicyScalePolicy

FixedScaleFixedScale

AutoScaleAutoScale

HistoryServerConfigHistoryServerConfig

DependenciesDependencies

MetastoreMetastore

UpdateNetworkConfigSpecUpdateNetworkConfigSpec

LoggingConfigLoggingConfig

MaintenanceWindowMaintenanceWindow

AnytimeMaintenanceWindowAnytimeMaintenanceWindow

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

operation.Operationoperation.Operation

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

gRPC request

UpdateClusterRequest

UpdateClusterConfigSpec

ResourcePools

ResourcePool

ScalePolicy

FixedScale

AutoScale

HistoryServerConfig

Dependencies

Metastore

UpdateNetworkConfigSpec

LoggingConfig

MaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

operation.Operation