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

Method addHosts

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

Adds new hosts to the specified Elasticsearch cluster.

HTTP request

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

Path parameters

Parameter Description
clusterId Required. ID of the Elasticsearch cluster. To get the Elasticsearch cluster ID, make a list request. The maximum string length in characters is 50.

Body parameters

{
  "hostSpecs": [
    {
      "zoneId": "string",
      "subnetId": "string",
      "assignPublicIp": true,
      "type": "string",
      "shardName": "string"
    }
  ]
}
Field Description
hostSpecs[] object

Required. One or more configurations of hosts to be added to 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_-]*.

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