Skip to main content

AddHosts

Adds new hosts in a cluster.

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

const AddClusterHostsRequest =
  cloudApi.mdb.clickhouse_cluster_service.AddClusterHostsRequest;
const Host_Type = cloudApi.mdb.clickhouse_cluster.Host_Type;

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

  const operation = await client.addHosts(
    AddClusterHostsRequest.fromPartial({
      clusterId: "clusterId",
      // hostSpecs: [{
      // zoneId: "zoneId",
      // type: Host_Type.CLICKHOUSE,
      // subnetId: "subnetId",
      // assignPublicIp: true,
      // shardName: "shardName"
      // }],
      // copySchema: {
      // value: true
      // }
    })
  );
  await waitForOperation(operation, session);
})();

AddClusterHostsRequest​

clusterId : string​

ID of the cluster to add hosts to.

To get this ID, make a ClusterService.List request.

hostSpecs : HostSpec​

Configuration of the newly added hosts.

HostSpec​

zoneId : string​

ID of the availability zone where the host resides.

To get a list of available zones, make the yandex.cloud.compute.v1.ZoneService.List request.

subnetId : string​

ID of the subnet to assign to the host.

This subnet should be a part of the cluster network (the network ID is specified in the ClusterService.CreateClusterRequest.network_id).

assignPublicIp : bool​

Option that enables public IP address for the host so that the host can be accessed from the internet.

After a host has been created, this setting cannot be changed. To remove an assigned public IP address, or to assign a public IP address to a host without one, recreate the host with the appropriate assign_public_ip value set.

Possible values:

  • false - don't assign a public IP address to the host.
  • true - assign a public IP address to the host.
replicationSource : string​

Host.name of the host to be used as the replication source (for cascading replication).

backupPriority : int64​

Host backup priority

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.