Подключиться
Yandex Managed Service for Elasticsearch

Cluster

Статья создана

A set of methods for managing Elasticsearch clusters.

JSON Representation

{
  "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"
        }
      },
      "plugins": [
        "string"
      ]
    },
    "edition": "string"
  },
  "networkId": "string",
  "health": "string",
  "status": "string",
  "securityGroupIds": [
    "string"
  ],
  "serviceAccountId": "string",
  "deletionProtection": true
}
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.
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 object

Custom labels for the Elasticsearch cluster as key:value pairs. A maximum of 64 labels per resource is allowed.
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.
monitoring[] object

Metadata of monitoring system.
monitoring[].
name		 string

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

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

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

Configuration of the Elasticsearch cluster.
config.
version		 string

Elasticsearch version.
config.
elasticsearch		 object

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

Configuration and resource allocation for Elasticsearch data nodes.
config.
elasticsearch.
dataNode.
resources		 object

Computational resources.
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.
config.
elasticsearch.
dataNode.
resources.
diskSize		 string (int64)

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

Type of the storage environment for the host. All available types are listed in the documentation.
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7		 object

Elasticsearch 7.x data node configuration.
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.
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.
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.
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.
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.
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.
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.
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.
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.
config.
elasticsearch.
masterNode		 object

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

Resources allocated to Elasticsearch master nodes.

Computational resources.
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.
config.
elasticsearch.
masterNode.
resources.
diskSize		 string (int64)

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

Type of the storage environment for the host. All available types are listed in the documentation.
config.
elasticsearch.
plugins[]		 string

Cluster wide plugins
config.
edition		 string

ElasticSearch edition.
networkId string

ID of the network that the cluster belongs to.
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).
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.
securityGroupIds[] string

User security groups
serviceAccountId string

ID of the service account used for access to Yandex Object Storage.
deletionProtection boolean (boolean)

Deletion Protection inhibits deletion of the cluster

Methods

Method Description
addHosts Adds new hosts to the specified Elasticsearch cluster.
create Creates a new Elasticsearch cluster in the specified folder.
delete Deletes the specified Elasticsearch cluster.
deleteHosts Deletes specified hosts from the specified Elasticsearch cluster.
get Returns the specified Elasticsearch cluster.
list Retrieves the list of Elasticsearch clusters that belong to the specified folder.
listHosts Retrieves a list of hosts for the specified Elasticsearch cluster.
listLogs Retrieves logs for the specified Elasticsearch cluster.
listOperations Retrieves the list of operations for the specified Elasticsearch cluster.
move Moves the specified Elasticsearch cluster to the specified folder.
start Starts the specified Elasticsearch cluster.
stop Stops the specified Elasticsearch cluster.
streamLogs Same as listLogs but using server-side streaming. Also supports tail -f semantics.
update Updates the specified Elasticsearch cluster.
В этой статье: