Get

Returns the specified OpenSearch cluster.

To get the list of all available OpenSearch clusters, make a List request.

TypeScript

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

const GetClusterRequest = cloudApi.dataproc.cluster_service.GetClusterRequest;

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

  const result = await client.get(
    GetClusterRequest.fromPartial({
      clusterId: "clusterId",
    })
  );
  console.log(result);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.dataproc.v1.cluster_service_pb2_grpc import ClusterServiceStub
from yandex.cloud.dataproc.v1.cluster_service_pb2 import GetClusterRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(ClusterServiceStub)
response = service.Get(GetClusterRequest(cluster_id="clusterId"))
print(response)

GetClusterRequest

clusterId : string

ID of the OpenSearch cluster to return.

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

Cluster

An OpenSearch cluster resource.

Environment

• ENVIRONMENT_UNSPECIFIED

• PRODUCTION

  Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.

• PRESTABLE

  Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.

Health

• HEALTH_UNKNOWN

  Health of the cluster is unknown ([Host.health][3] for every host in the cluster is UNKNOWN).

• ALIVE

  Cluster is working normally ([Host.health][4] for every host in the cluster is ALIVE).

• DEAD

  Cluster is inoperable ([Host.health][5] for every host in the cluster is DEAD).

• DEGRADED

  Cluster is working below capacity ([Host.health][6] for at least one host in the cluster is not ALIVE).

Status

Current state of the cluster.

• STATUS_UNKNOWN

  Cluster state is unknown.

• CREATING

  Cluster is being created.

• RUNNING

  Cluster is running normally.

• ERROR

  Cluster has encountered a problem and cannot operate.

• UPDATING

  Cluster is being updated.

• STOPPING

  Cluster is stopping.

• STOPPED

  Cluster has stopped.

• STARTING

  Cluster is starting.

id : string

ID of the OpenSearch cluster. This ID is assigned by the platform at the moment of cluster creation.

folderId : string

ID of the folder that the OpenSearch cluster belongs to.

createdAt : google.protobuf.Timestamp

Time when the cluster was created.

name : string

Name of the OpenSearch cluster. The name is unique within the folder. 1-63 characters long.

description : string

Description of the OpenSearch cluster. 0-256 characters long.

labels : string

Custom labels for the OpenSearch cluster as key:value pairs. Maximum 64 labels per resource.

environment : Environment

Deployment environment of the OpenSearch cluster.

monitoring : Monitoring

Description of monitoring systems relevant to the OpenSearch cluster.

config : ClusterConfig

Configuration of the OpenSearch cluster.

networkId : string

ID of the cloud network that the cluster belongs to.

health : Health

Aggregated cluster health.

status : Status

Current state of the cluster.

securityGroupIds : string

User security groups.

serviceAccountId : string

ID of the service account used to access Object Storage.

deletionProtection : bool

Determines whether the cluster is protected from being deleted.

maintenanceWindow : MaintenanceWindow

Cluster maintenance window. Should be defined by either one of the two options.

plannedOperation : MaintenanceOperation

Maintenance operation planned at nearest maintenance_window.

Monitoring

Monitoring system metadata.

name : string

Name of the monitoring system.

description : string

Description of the monitoring system.

link : string

Link to the monitoring system charts for the OpenSearch cluster.

ClusterConfig

The OpenSearch cluster configuration.

version : string

Version of the OpenSearch server software.

opensearch : OpenSearch

OpenSearch configuration.

dashboards : Dashboards

Dashboards configuration.

access : Access

Access policy for external services.

MaintenanceWindow

An OpenSearch cluster maintenance window. Should be defined by either one of the two options.

One of policy

• anytime : AnytimeMaintenanceWindow

  An any-time maintenance window.

• weeklyMaintenanceWindow : WeeklyMaintenanceWindow

  A weekly maintenance window.

MaintenanceOperation

info : string

The description of the operation.

delayedUntil : google.protobuf.Timestamp

Delay time for the maintenance operation.

latestMaintenanceTime : google.protobuf.Timestamp

Time of the last maintenance window.

nextMaintenanceWindowTime : google.protobuf.Timestamp

Time of the next maintenance window.

OpenSearch

The OpenSearch host group type configuration.

GroupRole

• GROUP_ROLE_UNSPECIFIED

• DATA

• MANAGER

NodeGroup

Configuration of the host group.

name : string

Name of the group. Must be 1-63 characters long.

resources : Resources

Resources allocated to the hosts.

hostsCount : int64

Number of hosts in the group.

zoneIds : string

IDs of the availability zones the hosts belong to.

subnetIds : string

IDs of the subnets that the hosts belong to.

assignPublicIp : bool

Determines whether a public IP is assigned to the hosts in the group.

roles : GroupRole

Roles of the host group.

diskSizeAutoscaling : DiskSizeAutoscaling

Disk size autoscaling settings

plugins : string

Names of the cluster plugins.

nodeGroups : NodeGroup

Host groups of the OpenSearch type.

One of config

• opensearchConfigSet_2 : config.OpenSearchConfigSet2

keystoreSettings : string

Keystore entries names.

Dashboards

The Dashboards host group type configuration.

NodeGroup

name : string

Name of the group. 1-63 characters long.

resources : Resources

Resources allocated to the hosts.

hostsCount : int64

Number of hosts in the group.

zoneIds : string

IDs of the availability zones the hosts belong to.

subnetIds : string

IDs of the subnets that the hosts belong to.

assignPublicIp : bool

Determines whether a public IP is assigned to the hosts in the group.

diskSizeAutoscaling : DiskSizeAutoscaling

Disk size autoscaling settings

nodeGroups : NodeGroup

Host groups of the Dashboards type.

Access

Access policy for external services.

dataTransfer : bool

Determines whether the access to Data Transfer is allowed.

serverless : bool

Determines whether the access to Serverless is allowed.

AnytimeMaintenanceWindow

An any-time maintenance window.

WeeklyMaintenanceWindow

A weekly maintenance window.

WeekDay

• WEEK_DAY_UNSPECIFIED

• MON

  Monday

• TUE

  Tuesday

• WED

  Wednesday

• THU

  Thursday

• FRI

  Friday

• SAT

  Saturday

• SUN

  Sunday

day : WeekDay

Day of the week.

hour : int64

Hour of the day in the UTC timezone.

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.

NodeGroup

Configuration of the host group.

name : string

Name of the group. Must be 1-63 characters long.

resources : Resources

Resources allocated to the hosts.

hostsCount : int64

Number of hosts in the group.

zoneIds : string

IDs of the availability zones the hosts belong to.

subnetIds : string

IDs of the subnets that the hosts belong to.

assignPublicIp : bool

Determines whether a public IP is assigned to the hosts in the group.

roles : GroupRole

Roles of the host group.

diskSizeAutoscaling : DiskSizeAutoscaling

Disk size autoscaling settings

OpenSearchConfigSet2

effectiveConfig : OpenSearchConfig2

userConfig : OpenSearchConfig2

defaultConfig : OpenSearchConfig2

OpenSearchConfig2

maxClauseCount : google.protobuf.Int64Value

the maximum number of allowed boolean clauses in a query

fielddataCacheSize : string

the percentage or absolute value (10%, 512mb) of heap space that is allocated to fielddata

reindexRemoteWhitelist : string

---