Update

Modifies the specified SQL Server cluster.

TypeScript

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const Cluster = cloudApi.dataproc.cluster.Cluster;
const HadoopConfig_Service = cloudApi.dataproc.cluster.HadoopConfig_Service;
const UpdateClusterRequest =
  cloudApi.dataproc.cluster_service.UpdateClusterRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.ClusterServiceClient);

  const operation = await client.update(
    UpdateClusterRequest.fromPartial({
      // clusterId: "clusterId",
      // updateMask: {
      // paths: ["paths"]
      // },
      // description: "description",
      // labels: {"key": "labels"},
      // configSpec: {
      // subclustersSpec: [{
      // id: "id",
      // name: "name",
      // resources: {
      // resourcePresetId: "resourcePresetId",
      // diskTypeId: "diskTypeId",
      // diskSize: 0
      // },
      // hostsCount: 0,
      // autoscalingConfig: {
      // maxHostsCount: 0,
      // preemptible: true,
      // measurementDuration: {
      // seconds: 0,
      // nanos: 0
      // },
      // warmupDuration: {
      // seconds: 0,
      // nanos: 0
      // },
      // stabilizationDuration: {
      // seconds: 0,
      // nanos: 0
      // },
      // cpuUtilizationTarget: 0,
      // decommissionTimeout: 0
      // }
      // }],
      // hadoop: {
      // services: [HadoopConfig_Service.HDFS],
      // properties: {"key": "properties"},
      // sshPublicKeys: ["sshPublicKeys"],
      // initializationActions: [{
      // uri: "uri",
      // args: ["args"],
      // timeout: 0
      // }]
      // }
      // },
      // name: "name",
      // serviceAccountId: "serviceAccountId",
      // bucket: "bucket",
      // decommissionTimeout: 0,
      // uiProxy: true,
      // securityGroupIds: ["securityGroupIds"],
      // deletionProtection: true,
      // logGroupId: "logGroupId"
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof Cluster>(finishedOp.response);
    console.log(result);
  }
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.dataproc.v1.subcluster_pb2 import AutoscalingConfig
from yandex.cloud.dataproc.v1.cluster_pb2 import Cluster
from yandex.cloud.dataproc.v1.cluster_service_pb2_grpc import ClusterServiceStub
from yandex.cloud.dataproc.v1.cluster_pb2 import HadoopConfig
from yandex.cloud.dataproc.v1.cluster_pb2 import InitializationAction
from yandex.cloud.dataproc.v1.common_pb2 import Resources
from yandex.cloud.dataproc.v1.cluster_service_pb2 import UpdateClusterConfigSpec
from yandex.cloud.dataproc.v1.cluster_service_pb2 import UpdateClusterMetadata
from yandex.cloud.dataproc.v1.cluster_service_pb2 import UpdateClusterRequest
from yandex.cloud.dataproc.v1.cluster_service_pb2 import UpdateSubclusterConfigSpec

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(ClusterServiceStub)
operation = service.Update(
    UpdateClusterRequest(
        # cluster_id = "clusterId",
        # update_mask = FieldMask.FromJsonString("field1,field2"),
        # description = "description",
        # labels = {"key": "labels"},
        # config_spec = UpdateClusterConfigSpec(
        # subclusters_spec = [UpdateSubclusterConfigSpec(
        # id = "id",
        # name = "name",
        # resources = Resources(
        # resource_preset_id = "resourcePresetId",
        # disk_type_id = "diskTypeId",
        # disk_size = 0
        # ),
        # hosts_count = 0,
        # autoscaling_config = AutoscalingConfig(
        # max_hosts_count = 0,
        # preemptible = true,
        # measurement_duration = Duration(
        # seconds = 0,
        # nanos = 0
        # ),
        # warmup_duration = Duration(
        # seconds = 0,
        # nanos = 0
        # ),
        # stabilization_duration = Duration(
        # seconds = 0,
        # nanos = 0
        # ),
        # cpu_utilization_target = 0,
        # decommission_timeout = 0
        # )
        # )],
        # hadoop = HadoopConfig(
        # services = [HadoopConfig.Service.HDFS],
        # properties = {"key": "properties"},
        # ssh_public_keys = ["sshPublicKeys"],
        # initialization_actions = [InitializationAction(
        # uri = "uri",
        # args = ["args"],
        # timeout = 0
        # )]
        # )
        # ),
        # name = "name",
        # service_account_id = "serviceAccountId",
        # bucket = "bucket",
        # decommission_timeout = 0,
        # ui_proxy = true,
        # security_group_ids = ["securityGroupIds"],
        # deletion_protection = true,
        # log_group_id = "logGroupId"
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=Cluster,
    meta_type=UpdateClusterMetadata,
)
print(operation_result)

UpdateClusterRequest

clusterId : string

ID of the SQL Server cluster to update.

To get the SQL Server cluster ID, use a ClusterService.List request.

updateMask : google.protobuf.FieldMask

Field mask that specifies which fields of the SQL Server cluster should be updated.

description : string

New description of the SQL Server cluster.

labels : string

Custom labels for the SQL Server cluster as key:value pairs.

For example, "project":"mvp" or "source":"dictionary".

The new set of labels completely replaces the old one.

To add a label, request the current set with the ClusterService.Get method, then send an ClusterService.Update request with the new label added to the set.

configSpec : ConfigSpec

New configuration and resources for hosts in the SQL Server cluster.

name : string

New name for the SQL Server cluster.

securityGroupIds : string

User security groups.

deletionProtection : bool

Determines whether the cluster is protected from being deleted.

serviceAccountId : string

ID of the service account used for access to Object Storage.

ConfigSpec

version : string

Version of SQL Server used in the cluster.

Possible values:

• 2016sp2std,
• 2016sp2ent,
• 2017std,
• 2017ent,
• 2019std,
• 2019ent.

One of sqlserverConfig

Configuration of an SQL Server cluster.

• sqlserverConfig_2016sp2std : config.SQLServerConfig2016sp2std

  Configuration for an SQL Server 2016 SP2 Standard edition cluster.

• sqlserverConfig_2016sp2ent : config.SQLServerConfig2016sp2ent

  Configuration for an SQL Server 2016 SP2 Enterprise edition cluster.

• sqlserverConfig_2017std : config.SQLServerConfig2017std

  Configuration for an SQL Server 2017 Standard edition cluster.

• sqlserverConfig_2017ent : config.SQLServerConfig2017ent

  Configuration for an SQL Server 2017 Enterprise edition cluster.

• sqlserverConfig_2019std : config.SQLServerConfig2019std

  Configuration for an SQL Server 2019 Standard edition cluster.

• sqlserverConfig_2019ent : config.SQLServerConfig2019ent

  Configuration for an SQL Server 2019 Enterprise edition cluster.

resources : Resources

Resources allocated to SQL Server hosts.

backupWindowStart : google.type.TimeOfDay

Start time for the daily backup in UTC timezone.

access : Access

Database access policy.

secondaryConnections : ClusterConfig.SecondaryConnections

Secondary replicas connection mode

SQLServerConfig2016sp2std

SQL Server 2016 SP2 Standard edition supported configuration options are listed here.

Detailed description for each set of options is available in SQL Server documentation.

Any options that are not listed here are not supported.

maxDegreeOfParallelism : google.protobuf.Int64Value

Limits the number of processors to use in parallel plan execution per task.

See in-depth description in SQL Server documentation.

costThresholdForParallelism : google.protobuf.Int64Value

Specifies the threshold at which SQL Server creates and runs parallel plans for queries.

SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option.

See in-depth description in SQL Server documentation.

auditLevel : google.protobuf.Int64Value

Describes how to configure login auditing to monitor SQL Server Database Engine login activity.

Possible values:

• 0 - do not log login attempts;
• 1 - log only failed login attempts;
• 2 - log only successful login attempts (not recommended);
• 3 - log all login attempts (not recommended).

See in-depth description in SQL Server documentation.

fillFactorPercent : google.protobuf.Int64Value

Manages the fill factor server configuration option.

When an index is created or rebuilt, the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth.

Values 0 and 100 mean full page usage (no space reserved).

See in-depth description in SQL Server documentation.

optimizeForAdHocWorkloads : google.protobuf.BoolValue

Determines whether plans should be cached only after second execution.

Allows to avoid SQL cache bloat because of single-use plans.

See in-depth description in SQL Server documentation.

SQLServerConfig2016sp2ent

SQL Server 2016 SP2 Enterprise edition supported configuration options are listed here.

Detailed description for each set of options is available in SQL Server documentation.

Any options that are not listed here are not supported.

maxDegreeOfParallelism : google.protobuf.Int64Value

Limits the number of processors to use in parallel plan execution per task.

See in-depth description in SQL Server documentation.

costThresholdForParallelism : google.protobuf.Int64Value

Specifies the threshold at which SQL Server creates and runs parallel plans for queries.

SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option.

See in-depth description in SQL Server documentation.

auditLevel : google.protobuf.Int64Value

Describes how to configure login auditing to monitor SQL Server Database Engine login activity.

Possible values:

• 0 - do not log login attempts;
• 1 - log only failed login attempts;
• 2 - log only successful login attempts (not recommended);
• 3 - log all login attempts (not recommended).

See in-depth description in SQL Server documentation.

fillFactorPercent : google.protobuf.Int64Value

Manages the fill factor server configuration option. When an index is created or rebuilt, the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth.

Values 0 and 100 mean full page usage (no space reserved).

See in-depth description in SQL Server documentation.

optimizeForAdHocWorkloads : google.protobuf.BoolValue

Determines whether plans should be cached only after second execution.

Allows to avoid SQL cache bloat because of single-use plans.

See in-depth description in SQL Server documentation.

SQLServerConfig2017std

SQL Server 2017 Standard edition supported configuration options are listed here.

Detailed description for each set of options is available in SQL Server documentation.

Any options that are not listed here are not supported.

maxDegreeOfParallelism : google.protobuf.Int64Value

Limits the number of processors to use in parallel plan execution per task.

See in-depth description in SQL Server documentation.

costThresholdForParallelism : google.protobuf.Int64Value

Specifies the threshold at which SQL Server creates and runs parallel plans for queries.

SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option.

See in-depth description in SQL Server documentation.

auditLevel : google.protobuf.Int64Value

Describes how to configure login auditing to monitor SQL Server Database Engine login activity.

Possible values:

• 0 - do not log login attempts;
• 1 - log only failed login attempts;
• 2 - log only successful login attempts (not recommended);
• 3 - log all login attempts (not recommended).

See in-depth description in SQL Server documentation.

fillFactorPercent : google.protobuf.Int64Value

Manages the fill factor server configuration option.

When an index is created or rebuilt, the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth.

Values 0 and 100 mean full page usage (no space reserved).

See in-depth description in SQL Server documentation.

optimizeForAdHocWorkloads : google.protobuf.BoolValue

Determines whether plans should be cached only after second execution.

Allows to avoid SQL cache bloat because of single-use plans.

See in-depth description in SQL Server documentation.

SQLServerConfig2017ent

SQL Server 2017 Enterprise edition supported configuration options are listed here.

Detailed description for each set of options is available in SQL Server documentation.

Any options that are not listed here are not supported.

maxDegreeOfParallelism : google.protobuf.Int64Value

Limits the number of processors to use in parallel plan execution per task.

See in-depth description in SQL Server documentation.

costThresholdForParallelism : google.protobuf.Int64Value

Specifies the threshold at which SQL Server creates and runs parallel plans for queries.

SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option.

See in-depth description in SQL Server documentation.

auditLevel : google.protobuf.Int64Value

Describes how to configure login auditing to monitor SQL Server Database Engine login activity.

Possible values:

• 0 - do not log login attempts;
• 1 - log only failed login attempts;
• 2 - log only successful login attempts (not recommended);
• 3 - log all login attempts (not recommended).

See in-depth description in SQL Server documentation.

fillFactorPercent : google.protobuf.Int64Value

Manages the fill factor server configuration option. When an index is created or rebuilt, the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth.

Values 0 and 100 mean full page usage (no space reserved).

See in-depth description in SQL Server documentation.

optimizeForAdHocWorkloads : google.protobuf.BoolValue

Determines whether plans should be cached only after second execution.

Allows to avoid SQL cache bloat because of single-use plans.

See in-depth description in SQL Server documentation.

SQLServerConfig2019std

SQL Server 2019 Standard edition supported configuration options are listed here.

Detailed description for each set of options is available in SQL Server documentation.

Any options that are not listed here are not supported.

maxDegreeOfParallelism : google.protobuf.Int64Value

Limits the number of processors to use in parallel plan execution per task.

See in-depth description in SQL Server documentation.

costThresholdForParallelism : google.protobuf.Int64Value

Specifies the threshold at which SQL Server creates and runs parallel plans for queries.

SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option.

See in-depth description in SQL Server documentation.

auditLevel : google.protobuf.Int64Value

Describes how to configure login auditing to monitor SQL Server Database Engine login activity.

Possible values:

• 0 - do not log login attempts;
• 1 - log only failed login attempts;
• 2 - log only successful login attempts (not recommended);
• 3 - log all login attempts (not recommended).

See in-depth description in SQL Server documentation.

fillFactorPercent : google.protobuf.Int64Value

Manages the fill factor server configuration option.

When an index is created or rebuilt, the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth.

Values 0 and 100 mean full page usage (no space reserved).

See in-depth description in SQL Server documentation.

optimizeForAdHocWorkloads : google.protobuf.BoolValue

Determines whether plans should be cached only after second execution.

Allows to avoid SQL cache bloat because of single-use plans.

See in-depth description in SQL Server documentation.

SQLServerConfig2019ent

SQL Server 2019 Enterprise edition supported configuration options are listed here.

Detailed description for each set of options is available in SQL Server documentation.

Any options that are not listed here are not supported.

maxDegreeOfParallelism : google.protobuf.Int64Value

Limits the number of processors to use in parallel plan execution per task.

See in-depth description in SQL Server documentation.

costThresholdForParallelism : google.protobuf.Int64Value

Specifies the threshold at which SQL Server creates and runs parallel plans for queries.

SQL Server creates and runs a parallel plan for a query only when the estimated cost to run a serial plan for the same query is higher than the value of the option.

See in-depth description in SQL Server documentation.

auditLevel : google.protobuf.Int64Value

Describes how to configure login auditing to monitor SQL Server Database Engine login activity.

Possible values:

• 0 - do not log login attempts;
• 1 - log only failed login attempts;
• 2 - log only successful login attempts (not recommended);
• 3 - log all login attempts (not recommended).

See in-depth description in SQL Server documentation.

fillFactorPercent : google.protobuf.Int64Value

Manages the fill factor server configuration option. When an index is created or rebuilt, the fill factor determines the percentage of space on each index leaf-level page to be filled with data, reserving the rest as free space for future growth.

Values 0 and 100 mean full page usage (no space reserved).

See in-depth description in SQL Server documentation.

optimizeForAdHocWorkloads : google.protobuf.BoolValue

Determines whether plans should be cached only after second execution.

Allows to avoid SQL cache bloat because of single-use plans.

See in-depth description in SQL Server documentation.

Resources

resourcePresetId : string

ID of the preset for computational resources available to a host (CPU, memory, etc.).

All available presets are listed in the documentation.

diskSize : int64

Volume of the storage available to a host.

diskTypeId : string

Type of the storage environment for the host.

Possible values:

• network-hdd - network HDD drive;
• network-ssd - network SSD drive;
• local-ssd - local SSD storage.

Access

dataLens : bool

Allows access for DataLens.

webSql : bool

Allows access for Web SQL.

Operation

An Operation resource. For more information, see Operation.

id : string

ID of the operation.

description : string

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp

Creation timestamp.

createdBy : string

ID of the user or service account who initiated the operation.

modifiedAt : 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.

One of result

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.

• error : google.rpc.Status

  The error result of the operation in case of failure or cancellation.

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

---