Skip to main content

UpdateOpenSearchNodeGroup

Updates an OpenSearch type host group.

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

const OpenSearch_GroupRole =
  cloudApi.mdb.opensearch_cluster.OpenSearch_GroupRole;
const UpdateOpenSearchNodeGroupRequest =
  cloudApi.mdb.opensearch_cluster_service.UpdateOpenSearchNodeGroupRequest;

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

  const operation = await client.updateOpenSearchNodeGroup(
    UpdateOpenSearchNodeGroupRequest.fromPartial({
      clusterId: "clusterId",
      name: "name",
      // updateMask: {
      // paths: ["paths"]
      // },
      // nodeGroupSpec: {
      // resources: {
      // resourcePresetId: "resourcePresetId",
      // diskSize: 0,
      // diskTypeId: "diskTypeId"
      // },
      // hostsCount: 0,
      // roles: [OpenSearch_GroupRole.DATA],
      // zoneIds: ["zoneIds"],
      // subnetIds: ["subnetIds"],
      // assignPublicIp: true,
      // diskSizeAutoscaling: {
      // plannedUsageThreshold: 0,
      // emergencyUsageThreshold: 0,
      // diskSizeLimit: 0
      // }
      // }
    })
  );
  await waitForOperation(operation, session);
})();

UpdateOpenSearchNodeGroupRequest​

clusterId : string​

ID of the OpenSearch cluster to update the OpenSearch type host group in.

To get the ID, use a ClusterService.List request.

name : string​

Name of the OpenSearch type host group to be updated.

updateMask : google.protobuf.FieldMask​

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

nodeGroupSpec : OpenSearchNodeGroupUpdateSpec​

New configuration for the host group.

OpenSearchNodeGroupUpdateSpec​

resources : Resources​

Resources allocated to the hosts.

hostsCount : int64​

Number of hosts in the group.

roles : OpenSearch.GroupRole​

Opensearch roles applicable to the node group.

zoneIds : string​

IDs of the availability zones for hosts

subnetIds : string​

IDs of the subnets for hosts

assignPublicIp : bool​

Whether the hosts should get a public IP address.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

Resources​

A list of computational resources allocated to a host.

resourcePresetId : string​

ID of the preset for computational resources allocated to a host.

diskSize : int64​

Volume of the storage used by the host, in bytes.

diskTypeId : string​

Type of the storage used by the host: network-hdd, network-ssd or local-ssd.

DiskSizeAutoscaling​

plannedUsageThreshold : int64​

Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.

emergencyUsageThreshold : int64​

Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.

diskSizeLimit : int64​

Limit on how large the storage for database instances can automatically grow, in bytes.

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.