Skip to main content

UpdateHosts

Updates the specified parameters for the host.

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);
})();

UpdateClusterHostsRequest​

clusterId : string​

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

updateHostSpecs : UpdateHostSpec​

New configurations to apply to hosts of a Managed Service for MongoDB cluster.

UpdateHostSpec​

hostName : string​

Host to be updated. Specify the host FQDN.

hidden : google.protobuf.BoolValue​

Determines if the host is a hidden replica set member.

Such members cannot become primary in a replica set, and they are invisible to client applications. However, hidden members can participate in elections of the primary host. For more information, see the MongoDB documentation.

secondaryDelaySecs : google.protobuf.Int64Value​

The time, in seconds, by which the given replica set member lags behind the primary host.

priority : google.protobuf.DoubleValue​

Priority of the host to be elected as the primary in the replica set.

The minimum value is 0 if the Managed Service for MongoDB cluster contains three or more secondary hosts. Otherwise, the minimum value is 1.

assignPublicIp : bool​

Determines whether the host should get a public IP address after the update.

updateMask : google.protobuf.FieldMask​

Field mask that specifies which fields of the MongoDB host should be updated.

tags : string​

Host tag list that contains key-value pairs for the given replica set member. For more information about how to specify the tags and what values to choose, see the MongoDB documentation.

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.