Managed Service for OpenSearch API, REST: Cluster.updateOpenSearchNodeGroup
Updates an OpenSearch type host group.
HTTP request
PATCH https://mdb.api.cloud.yandex.net/managed-opensearch/v1/clusters/{clusterId}/opensearch/node_groups/{name}
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the OpenSearch cluster to update the OpenSearch type host group in. To get the ID, use a list request. The maximum string length in characters is 50. |
name | Required. Name of the OpenSearch type host group to be updated. The maximum string length in characters is 63. Value must match the regular expression |
Body parameters
{
"updateMask": "string",
"nodeGroupSpec": {
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"hostsCount": "string",
"roles": [
"string"
],
"zoneIds": [
"string"
],
"subnetIds": [
"string"
],
"assignPublicIp": true,
"diskSizeAutoscaling": {
"plannedUsageThreshold": "string",
"emergencyUsageThreshold": "string",
"diskSizeLimit": "string"
}
}
}
Field | Description |
---|---|
updateMask | string Field mask that specifies which fields of the host group configuration 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 |
nodeGroupSpec | object New configuration for the host group. |
nodeGroupSpec. resources |
object Resources allocated to the hosts. A list of computational resources allocated to a host. |
nodeGroupSpec. resources. resourcePresetId |
string ID of the preset for computational resources allocated to a host. |
nodeGroupSpec. resources. diskSize |
string (int64) Volume of the storage used by the host, in bytes. |
nodeGroupSpec. resources. diskTypeId |
string Type of the storage used by the host: |
nodeGroupSpec. hostsCount |
string (int64) Number of hosts in the group. |
nodeGroupSpec. roles[] |
string Opensearch roles applicable to the node group. |
nodeGroupSpec. zoneIds[] |
string IDs of the availability zones for hosts |
nodeGroupSpec. subnetIds[] |
string IDs of the subnets for hosts |
nodeGroupSpec. assignPublicIp |
boolean (boolean) Whether the hosts should get a public IP address. |
nodeGroupSpec. diskSizeAutoscaling |
object Disk size autoscaling settings |
nodeGroupSpec. diskSizeAutoscaling. plannedUsageThreshold |
string (int64) Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. |
nodeGroupSpec. diskSizeAutoscaling. emergencyUsageThreshold |
string (int64) Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. |
nodeGroupSpec. diskSizeAutoscaling. diskSizeLimit |
string (int64) Limit on how large the storage for database instances can automatically grow, in bytes. |
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. |