UpdateHosts

Updates the specified hosts.

TypeScript

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

const UpdateClusterHostsRequest =
  cloudApi.mdb.clickhouse_cluster_service.UpdateClusterHostsRequest;

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

  const operation = await client.updateHosts(
    UpdateClusterHostsRequest.fromPartial({
      clusterId: "clusterId",
      // updateHostSpecs: [{
      // hostName: "hostName",
      // updateMask: {
      // paths: ["paths"]
      // },
      // assignPublicIp: {
      // value: true
      // }
      // }]
    })
  );
  await waitForOperation(operation, session);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.dataproc.v1.cluster_service_pb2_grpc import ClusterServiceStub
from yandex.cloud.mdb.clickhouse.v1.cluster_service_pb2 import UpdateClusterHostsMetadata
from yandex.cloud.mdb.clickhouse.v1.cluster_service_pb2 import UpdateClusterHostsRequest
from yandex.cloud.mdb.clickhouse.v1.cluster_service_pb2 import UpdateHostSpec

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(ClusterServiceStub)
operation = service.UpdateHosts()
operation_result = sdk.wait_operation_and_get_result(
    operation,
    meta_type=UpdateClusterHostsMetadata,
)

UpdateClusterHostsRequest

clusterId : string

ID of the MySQL cluster to update hosts in. To get the MySQL cluster ID, use a ClusterService.List request.

updateHostSpecs : UpdateHostSpec

New configurations to apply to hosts.

UpdateHostSpec

hostName : string

Name of the host to update. To get a MySQL host name, use a ClusterService.ListHosts request.

replicationSource : string

Host.name of the host to be used as the replication source (for cascading replication). To get a MySQL host name, use a ClusterService.ListHosts request.

updateMask : google.protobuf.FieldMask

Field mask that specifies which settings of the MySQL host should be updated.

backupPriority : int64

Host backup priority.

assignPublicIp : bool

Whether the host should get a public IP address on creation.

priority : int64

Host master promotion priority.

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.

---