Managed Service for OpenSearch API, REST: Cluster.update
Updates the specified OpenSearch cluster.
HTTP request
PATCH https://mdb.api.cloud.yandex.net/managed-opensearch/v1/clusters/{clusterId}
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the OpenSearch cluster resource to update. To get the OpenSearch cluster ID, use a list request. The maximum string length in characters is 50. |
Body parameters
{
"updateMask": "string",
"description": "string",
"labels": "object",
"configSpec": {
"version": "string",
"adminPassword": "string",
"opensearchSpec": {
"plugins": [
"string"
],
"setKeystoreSettings": [
{
"name": "string",
"value": "string"
}
],
"removeKeystoreSettings": [
"string"
],
"opensearchConfig_2": {
"maxClauseCount": "integer",
"fielddataCacheSize": "string",
"reindexRemoteWhitelist": "string"
}
},
"dashboardsSpec": {},
"access": {
"dataTransfer": true,
"serverless": true
}
},
"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 Field mask that specifies which fields of the OpenSearch cluster resource should be updated. 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 OpenSearch cluster. The maximum string length in characters is 256. |
labels | object Custom labels for the OpenSearch cluster as The new set of labels completely replaces the old one. 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 cluster configuration |
configSpec. version |
string OpenSearch version. |
configSpec. adminPassword |
string Required. OpenSearch admin password. |
configSpec. opensearchSpec |
object OpenSearch configuration. |
configSpec. opensearchSpec. plugins[] |
string Names of the cluster plugins. |
configSpec. opensearchSpec. setKeystoreSettings[] |
object Keystore settings to add/replace. Old entries not listed here will be left unchanged. |
configSpec. opensearchSpec. setKeystoreSettings[]. name |
string Keystore entry name. |
configSpec. opensearchSpec. setKeystoreSettings[]. value |
string Keystore entry value. |
configSpec. opensearchSpec. removeKeystoreSettings[] |
string Keystore entries names to remove. |
configSpec. opensearchSpec. opensearchConfig_2 |
object |
configSpec. opensearchSpec. opensearchConfig_2. maxClauseCount |
integer (int64) the maximum number of allowed boolean clauses in a query |
configSpec. opensearchSpec. opensearchConfig_2. fielddataCacheSize |
string the percentage or absolute value (10%, 512mb) of heap space that is allocated to fielddata |
configSpec. opensearchSpec. opensearchConfig_2. reindexRemoteWhitelist |
string |
configSpec. dashboardsSpec |
object Dashboards configuration. Dashboards configuration. |
configSpec. access |
object Access policy for external services. Access policy for external services. |
configSpec. access. dataTransfer |
boolean (boolean) Determines whether the access to Data Transfer is allowed. |
configSpec. access. serverless |
boolean (boolean) Determines whether the access to Serverless is allowed. |
name | string New name for the cluster. The name must be unique within the folder. 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 to access Object Storage. |
deletionProtection | boolean (boolean) Determines whether the cluster is protected from being deleted. |
maintenanceWindow | object Cluster maintenance window. Should be defined by either one of the two options. An OpenSearch cluster maintenance window. Should be defined by either one of the two options. |
maintenanceWindow. anytime |
object An any-time maintenance window. maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow |
maintenanceWindow. weeklyMaintenanceWindow |
object A weekly maintenance window. maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow |
maintenanceWindow. weeklyMaintenanceWindow. day |
string Day of the week.
|
maintenanceWindow. weeklyMaintenanceWindow. hour |
string (int64) Hour of the day in the UTC timezone. 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. |