Managed Service for Elasticsearch API, REST: Cluster.update
Updates the specified Elasticsearch cluster.
HTTP request
PATCH https://mdb.api.cloud.yandex.net/managed-elasticsearch/v1/clusters/{clusterId}
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the Elasticsearch cluster to update. To get the Elasticsearch cluster ID, make a list request. The maximum string length in characters is 50. |
Body parameters
{
"updateMask": "string",
"description": "string",
"labels": "object",
"configSpec": {
"version": "string",
"elasticsearchSpec": {
"dataNode": {
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"elasticsearchConfig_7": {
"maxClauseCount": "integer",
"fielddataCacheSize": "string",
"reindexRemoteWhitelist": "string",
"reindexSslCaPath": "string"
}
},
"masterNode": {
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
}
},
"plugins": [
"string"
]
},
"edition": "string",
"adminPassword": "string"
},
"name": "string",
"securityGroupIds": [
"string"
],
"serviceAccountId": "string",
"deletionProtection": true,
"maintenanceWindow": {
// `maintenanceWindow` includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
"anytime": {},
"weeklyMaintenanceWindow": {
"day": "string",
"hour": "string"
},
// end of the list of possible fields`maintenanceWindow`
},
"networkId": "string"
}
Field | Description |
---|---|
updateMask | string A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in If |
description | string New description of the Elasticsearch cluster. The maximum string length in characters is 256. |
labels | object Custom labels for the Elasticsearch cluster as For example, "project": "mvp" or "source": "dictionary". The new set of labels will completely replace the old ones. To add a label, request the current set with the get method, then send an update request with the new label added to the set. 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 |
configSpec | object New configuration and resources for hosts in the Elasticsearch cluster. Use updateMask to prevent reverting all cluster settings that are not listed in |
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. |
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 Default value: 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. dataNode. elasticsearchConfig_7. 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. |
configSpec. elasticsearchSpec. dataNode. elasticsearchConfig_7. reindexSslCaPath |
string List of paths to PEM encoded certificate files that should be trusted. 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 ElasticSearch admin password. |
name | string New name for the Elasticsearch cluster. The maximum string length in characters is 63. Value must match the regular expression |
securityGroupIds[] | string User security groups |
serviceAccountId | string ID of the service account used for access to Object Storage. |
deletionProtection | boolean (boolean) Deletion Protection inhibits deletion of the cluster |
maintenanceWindow | object Window of maintenance operations. |
maintenanceWindow. anytime |
object maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow |
maintenanceWindow. weeklyMaintenanceWindow |
object maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow |
maintenanceWindow. weeklyMaintenanceWindow. day |
string |
maintenanceWindow. weeklyMaintenanceWindow. hour |
string (int64) Hour of the day in UTC. Acceptable values are 1 to 24, inclusive. |
networkId | string ID of the network to move the cluster to. The maximum string length in characters is 50. |
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. The range of possible values is from 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). |
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. The range of possible values is from 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). |
done | boolean (boolean) If the value is |
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 |
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. |