Contact UsGet started

Managed Service for Elasticsearch API, REST: Cluster.Get

Written by
Updated at October 17, 2024

Returns the specified Elasticsearch cluster.

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

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-elasticsearch/v1/clusters/{clusterId}

Path parameters

Field

Description

clusterId

string

Required field. ID of the Elasticsearch cluster to return.

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

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "string",
  "environment": "string",
  "monitoring": [
    {
      "name": "string",
      "description": "string",
      "link": "string"
    }
  ],
  "config": {
    "version": "string",
    "elasticsearch": {
      "dataNode": {
        // Includes only one of the fields `elasticsearchConfigSet_7`
        "elasticsearchConfigSet_7": {
          "effectiveConfig": {
            "maxClauseCount": "string",
            "fielddataCacheSize": "string",
            "reindexRemoteWhitelist": "string",
            "reindexSslCaPath": "string"
          },
          "userConfig": {
            "maxClauseCount": "string",
            "fielddataCacheSize": "string",
            "reindexRemoteWhitelist": "string",
            "reindexSslCaPath": "string"
          },
          "defaultConfig": {
            "maxClauseCount": "string",
            "fielddataCacheSize": "string",
            "reindexRemoteWhitelist": "string",
            "reindexSslCaPath": "string"
          }
        },
        // end of the list of possible fields
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      },
      "masterNode": {
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      },
      "plugins": [
        "string"
      ]
    },
    "edition": "string"
  },
  "networkId": "string",
  "health": "string",
  "status": "string",
  "securityGroupIds": [
    "string"
  ],
  "serviceAccountId": "string",
  "deletionProtection": "boolean",
  "maintenanceWindow": {
    // Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
    "anytime": "object",
    "weeklyMaintenanceWindow": {
      "day": "string",
      "hour": "string"
    }
    // end of the list of possible fields
  },
  "plannedOperation": {
    "info": "string",
    "delayedUntil": "string"
  }
}

An Elasticsearch cluster resource.
For more information, see the Concepts section of the documentation.

Field

Description

id

string

ID of the Elasticsearch cluster.
This ID is assigned at creation time.

folderId

string

ID of the folder that the Elasticsearch cluster belongs to.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

name

string

Name of the Elasticsearch cluster.
The name must be unique within the folder. 1-63 characters long.

description

string

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

labels

string

Custom labels for the Elasticsearch cluster as key:value pairs.
A maximum of 64 labels per resource is allowed.

environment

enum (Environment)

Deployment environment of the Elasticsearch cluster.

  • ENVIRONMENT_UNSPECIFIED
  • PRODUCTION: Stable environment with a conservative update policy when only hotfixes are applied during regular maintenance.
  • PRESTABLE: Environment with a more aggressive update policy when new versions are rolled out irrespective of backward compatibility.

monitoring[]

Monitoring

Description of monitoring systems relevant to the Elasticsearch cluster.

config

ClusterConfig

Configuration of the Elasticsearch cluster.

networkId

string

ID of the network that the cluster belongs to.

health

enum (Health)

Aggregated cluster health.

  • HEALTH_UNKNOWN: State of the cluster is unknown (Host.health of all hosts in the cluster is UNKNOWN).
  • ALIVE: Cluster is alive and well (Host.health of all hosts in the cluster is ALIVE).
  • DEAD: Cluster is inoperable (Host.health of all hosts in the cluster is DEAD).
  • DEGRADED: Cluster is in degraded state (Host.health of at least one of the hosts in the cluster is not ALIVE).

status

enum (Status)

Current state of the cluster.

  • STATUS_UNKNOWN: Cluster state is unknown.
  • CREATING: Cluster is being created.
  • RUNNING: Cluster is running normally.
  • ERROR: Cluster encountered a problem and cannot operate.
  • UPDATING: Cluster is being updated.
  • STOPPING: Cluster is stopping.
  • STOPPED: Cluster stopped.
  • STARTING: Cluster is starting.

securityGroupIds[]

string

User security groups

serviceAccountId

string

ID of the service account used for access to Object Storage.

deletionProtection

boolean

Deletion Protection inhibits deletion of the cluster

maintenanceWindow

MaintenanceWindow

Window of maintenance operations.

plannedOperation

MaintenanceOperation

Maintenance operation planned at nearest maintenance_window.

Monitoring

Metadata of monitoring system.

Field

Description

name

string

Name of the monitoring system.

description

string

Description of the monitoring system.

link

string

Link to the monitoring system charts for the Elasticsearch cluster.

ClusterConfig

Field

Description

version

string

Elasticsearch version.

elasticsearch

Elasticsearch

Configuration and resource allocation for Elasticsearch nodes.

edition

string

ElasticSearch edition.

Elasticsearch

Field

Description

dataNode

DataNode

Configuration and resource allocation for Elasticsearch data nodes.

masterNode

MasterNode

Configuration and resource allocation for Elasticsearch master nodes.

plugins[]

string

Cluster wide plugins

DataNode

Field

Description

elasticsearchConfigSet_7

ElasticsearchConfigSet7

Elasticsearch 7.x data node configuration.

Includes only one of the fields elasticsearchConfigSet_7.

resources

Resources

Resources allocated to Elasticsearch data nodes.

ElasticsearchConfigSet7

Elasticsearch 7.x data node configuration.

Field

Description

effectiveConfig

ElasticsearchConfig7

Required field. Effective settings for an Elasticsearch cluster (a combination of settings defined in userConfig and defaultConfig).

userConfig

ElasticsearchConfig7

User-defined settings for an Elasticsearch cluster.

defaultConfig

ElasticsearchConfig7

Default settings for an Elasticsearch cluster.

ElasticsearchConfig7

Elasticsearch 7.x supported configuration options are listed here.

Detailed description for each set of options is available in Elasticsearch documentation.

Any options that are not listed here are not supported.

Field

Description

maxClauseCount

string (int64)

The maximum number of clauses a boolean query can contain.

The limit is in place to prevent searches from becoming too large and taking up too much CPU and memory.
It affects not only Elasticsearch's bool query, but many other queries that are implicitly converted to bool query by Elastcsearch.

Default value: 1024.

See in-depth description in Elasticsearch documentation.

fielddataCacheSize

string

The maximum percentage or absolute value (10%, 512mb) of heap space that is allocated to field data cache.

All the field values that are placed in this cache, get loaded to memory in order to provide fast document based access to those values.
Building the field data cache for a field can be an expensive operations, so its recommended to have enough memory for this cache, and to keep it loaded.

Default value: unbounded.

See in-depth description in Elasticsearch documentation.

reindexRemoteWhitelist

string

Remote hosts for reindex have to be explicitly allowed in elasticsearch.yml using the reindex.remote.whitelist property.
It can be set to a comma delimited list of allowed remote host and port combinations.
Scheme is ignored, only the host and port are used.

reindexSslCaPath

string

List of paths to PEM encoded certificate files that should be trusted.

See in-depth description in Elasticsearch documentation

Resources

Computational resources.

Field

Description

resourcePresetId

string

ID of the preset for computational resources available to a host (CPU, memory etc.).
All available presets are listed in the documentation.

diskSize

string (int64)

Volume of the storage available to a host, in bytes.

diskTypeId

string

Type of the storage environment for the host.
All available types are listed in the documentation.

MasterNode

Field

Description

resources

Resources

Resources allocated to Elasticsearch master nodes.

MaintenanceWindow

Field

Description

anytime

object

Includes only one of the fields anytime, weeklyMaintenanceWindow.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

Includes only one of the fields anytime, weeklyMaintenanceWindow.

WeeklyMaintenanceWindow

Field

Description

day

enum (WeekDay)

  • WEEK_DAY_UNSPECIFIED
  • MON
  • TUE
  • WED
  • THU
  • FRI
  • SAT
  • SUN

hour

string (int64)

Hour of the day in UTC.

MaintenanceOperation

Field

Description

info

string

delayedUntil

string (date-time)

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
Previous
Overview
Next
List