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

Method create

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

Creates a new Elasticsearch cluster in the specified folder.

HTTP request

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

Body parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "configSpec": {
    "version": "string",
    "elasticsearchSpec": {
      "dataNode": {
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "elasticsearchConfig_7": {
          "maxClauseCount": "integer",
          "fielddataCacheSize": "string"
        }
      },
      "masterNode": {
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      },
      "plugins": [
        "string"
      ]
    },
    "edition": "string",
    "adminPassword": "string"
  },
  "userSpecs": [
    {
      "name": "string",
      "password": "string"
    }
  ],
  "hostSpecs": [
    {
      "zoneId": "string",
      "subnetId": "string",
      "assignPublicIp": true,
      "type": "string",
      "shardName": "string"
    }
  ],
  "networkId": "string",
  "securityGroupIds": [
    "string"
  ],
  "serviceAccountId": "string",
  "deletionProtection": true
}
Field Description
folderId string

Required. ID of the folder to create the Elasticsearch cluster in.

The maximum string length in characters is 50.
name string

Required. Name of the Elasticsearch cluster. The name must be unique within the folder.

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
description string

Description of the Elasticsearch cluster.

The maximum string length in characters is 256.
labels object

Custom labels for the Elasticsearch cluster as key:value pairs.

For example, "project": "mvp" or "source": "dictionary".

No more than 64 per resource. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*.
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.
configSpec object

Required. Elasticsearch and hosts configuration for the cluster.
configSpec.
version		 string

Elasticsearch version.
configSpec.
elasticsearchSpec		 object

Configuration and resource allocation for Elasticsearch nodes.
configSpec.
elasticsearchSpec.
dataNode		 object

Configuration and resource allocation for Elasticsearch data nodes.
configSpec.
elasticsearchSpec.
dataNode.
resources		 object
Resources allocated to Elasticsearch data nodes.

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

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

Type of the storage environment for the host. All available types are listed in the documentation.
configSpec.
elasticsearchSpec.
dataNode.
elasticsearchConfig_7		 object

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.
configSpec.
elasticsearchSpec.
dataNode.
elasticsearchConfig_7.
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.
configSpec.
elasticsearchSpec.
dataNode.
elasticsearchConfig_7.
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.
configSpec.
elasticsearchSpec.
masterNode		 object

Configuration and resource allocation for Elasticsearch master nodes.
configSpec.
elasticsearchSpec.
masterNode.
resources		 object

Resources allocated to Elasticsearch master nodes.

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

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

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

Cluster wide plugins

The maximum string length in characters for each value is 50.
configSpec.
edition		 string

ElasticSearch edition.
configSpec.
adminPassword		 string

Required. ElasticSearch admin password.
userSpecs[] object

One or more descriptions of users to be created in Elasticsearch cluster.
userSpecs[].
name		 string

Required. Name of the Elasticsearch user.

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]*.
userSpecs[].
password		 string

Required. Password of the Elasticsearch user.

The string length in characters must be 8-128.
hostSpecs[] object

Required. One or more configurations of hosts to be created in the Elasticsearch cluster.

Must contain at least one element.
hostSpecs[].
zoneId		 string

ID of the availability zone where the host resides.

The maximum string length in characters is 50.
hostSpecs[].
subnetId		 string

ID of the subnet the host resides in.

The maximum string length in characters is 50.
hostSpecs[].
assignPublicIp		 boolean (boolean)

The flag that defines whether a public IP address is assigned to the host.

If the value is true, then this host is available on the Internet via it's public IP address.
hostSpecs[].
type		 string

Required. Host type.

  • DATA_NODE: the host is an Elasticsearch data node.
  • MASTER_NODE: the host is an Elasticsearch master node.
hostSpecs[].
shardName		 string

The shard name to create on the host.

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
networkId string

Required. ID of the network to create the Elasticsearch cluster in.

The maximum string length in characters is 50.
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

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // end of the list of possible fields

}

An Operation resource. For more information, see Operation.

Field Description
id string

ID of the operation.
description string

Description of the operation. 0-256 characters long.
createdAt string (date-time)

Creation timestamp.

String in RFC3339 text format.
createdBy string

ID of the user or service account who initiated the operation.
modifiedAt string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format.
done boolean (boolean)

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 object

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.
error object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response

The error result of the operation in case of failure or cancellation.
error.
code		 integer (int32)

Error code. An enum value of google.rpc.Code.
error.
message		 string

An error message.
error.
details[]		 object

A list of messages that carry the error details.
response object
includes only one of the fields error, response

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.
В этой статье: