Get started
Yandex Managed Service for Elasticsearch

Method list

Retrieves the list of Elasticsearch clusters that belong to the specified folder.

HTTP request

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

Query parameters

Parameter Description
folderId Required. ID of the folder to list Elasticsearch clusters in. To get the folder ID, make a list request. The maximum string length in characters is 50.
pageSize The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
pageToken Page token. To get the next page of results, set page_token to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.
filter A filter expression that filters resources listed in the response. The expression must specify: 1. The field name to filter by. Currently you can only use filtering with the Cluster.name field. 2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. 3. The value. Мust be 1-63 characters long and match the regular expression ^[a-zA-Z0-9_-]+$. Example of a filter: name NOT IN 'test,beta'. The maximum string length in characters is 1000.

Response

HTTP Code: 200 - OK

{
  "clusters": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "environment": "string",
      "monitoring": [
        {
          "name": "string",
          "description": "string",
          "link": "string"
        }
      ],
      "config": {
        "version": "string",
        "elasticsearch": {
          "dataNode": {
            "resources": {
              "resourcePresetId": "string",
              "diskSize": "string",
              "diskTypeId": "string"
            },
            "elasticsearchConfigSet_7": {
              "effectiveConfig": {
                "maxClauseCount": "integer",
                "fielddataCacheSize": "string"
              },
              "userConfig": {
                "maxClauseCount": "integer",
                "fielddataCacheSize": "string"
              },
              "defaultConfig": {
                "maxClauseCount": "integer",
                "fielddataCacheSize": "string"
              }
            }
          },
          "masterNode": {
            "resources": {
              "resourcePresetId": "string",
              "diskSize": "string",
              "diskTypeId": "string"
            }
          }
        }
      },
      "networkId": "string",
      "health": "string",
      "status": "string",
      "securityGroupIds": [
        "string"
      ]
    }
  ],
  "nextPageToken": "string"
}
Field Description
clusters[] object

An Elasticsearch cluster resource. For more information, see the Concepts section of the documentation.
clusters[].
id		 string

ID of the Elasticsearch cluster. This ID is assigned at creation time.
clusters[].
folderId		 string

ID of the folder that the Elasticsearch cluster belongs to.
clusters[].
createdAt		 string (date-time)

Creation timestamp.

String in RFC3339 text format.
clusters[].
name		 string

Name of the Elasticsearch cluster. The name must be unique within the folder. 1-63 characters long.
clusters[].
description		 string

Description of the Elasticsearch cluster. 0-256 characters long.
clusters[].
labels		 object

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

Deployment environment of the Elasticsearch cluster.

  • 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.
clusters[].
monitoring[]		 object

Metadata of monitoring system.
clusters[].
monitoring[].
name		 string

Name of the monitoring system.
clusters[].
monitoring[].
description		 string

Description of the monitoring system.
clusters[].
monitoring[].
link		 string

Link to the monitoring system charts for the Elasticsearch cluster.
clusters[].
config		 object

Configuration of the Elasticsearch cluster.
clusters[].
config.
version		 string

Elasticsearch version.
clusters[].
config.
elasticsearch		 object

Configuration and resource allocation for Elasticsearch nodes.
clusters[].
config.
elasticsearch.
dataNode		 object

Configuration and resource allocation for Elasticsearch data nodes.
clusters[].
config.
elasticsearch.
dataNode.
resources		 object
Resources allocated to Elasticsearch data nodes.

Computational resources.
clusters[].
config.
elasticsearch.
dataNode.
resources.
resourcePresetId		 string

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
clusters[].
config.
elasticsearch.
dataNode.
resources.
diskSize		 string (int64)

Volume of the storage available to a host, in bytes.
clusters[].
config.
elasticsearch.
dataNode.
resources.
diskTypeId		 string

Type of the storage environment for the host. All available types are listed in the documentation.
clusters[].
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7		 object
Elasticsearch 7.x data node configuration.

Elasticsearch 7.x data node configuration.
clusters[].
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7.
effectiveConfig		 object

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

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.
clusters[].
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7.
effectiveConfig.
maxClauseCount		 integer (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.
clusters[].
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7.
effectiveConfig.
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.
clusters[].
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7.
userConfig		 object

User-defined settings for an Elasticsearch cluster.

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.
clusters[].
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7.
userConfig.
maxClauseCount		 integer (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.
clusters[].
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7.
userConfig.
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.
clusters[].
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7.
defaultConfig		 object

Default settings for an Elasticsearch cluster.

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.
clusters[].
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7.
defaultConfig.
maxClauseCount		 integer (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.
clusters[].
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7.
defaultConfig.
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.
clusters[].
config.
elasticsearch.
masterNode		 object

Configuration and resource allocation for Elasticsearch master nodes.
clusters[].
config.
elasticsearch.
masterNode.
resources		 object

Resources allocated to Elasticsearch master nodes.

Computational resources.
clusters[].
config.
elasticsearch.
masterNode.
resources.
resourcePresetId		 string

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
clusters[].
config.
elasticsearch.
masterNode.
resources.
diskSize		 string (int64)

Volume of the storage available to a host, in bytes.
clusters[].
config.
elasticsearch.
masterNode.
resources.
diskTypeId		 string

Type of the storage environment for the host. All available types are listed in the documentation.
clusters[].
networkId		 string

ID of the network that the cluster belongs to.
clusters[].
health		 string

Aggregated cluster health.

  • HEALTH_UNKNOWN: state of the cluster is unknown (health of all hosts in the cluster is UNKNOWN).
  • ALIVE: cluster is alive and well (health of all hosts in the cluster is ALIVE).
  • DEAD: cluster is inoperable (health of all hosts in the cluster is DEAD).
  • DEGRADED: cluster is in degraded state (health of at least one of the hosts in the cluster is not ALIVE).
clusters[].
status		 string

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.
clusters[].
securityGroupIds[]		 string

User security groups
nextPageToken string

Token that allows you to get the next page of results for list requests.

If the number of results is larger than pageSize, use next_page_token as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.
In this article: