Managed Service for OpenSearch API, REST: Cluster.AddOpenSearchNodeGroup
Creates an OpenSearch type host group.
HTTP request
POST https://mdb.api.cloud.yandex.net/managed-opensearch/v1/clusters/{clusterId}/opensearch/node_groups
Path parameters
|
Field |
Description |
|
clusterId |
string Required field. ID of the OpenSearch cluster to create the OpenSearch type host group in. To get the ID, use a ClusterService.List request. |
Body parameters
{
"nodeGroupSpec": {
"name": "string",
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"hostsCount": "string",
"zoneIds": [
"string"
],
"subnetIds": [
"string"
],
"assignPublicIp": "boolean",
"roles": [
"string"
],
"diskSizeAutoscaling": {
"plannedUsageThreshold": "string",
"emergencyUsageThreshold": "string",
"diskSizeLimit": "string"
}
}
}
|
Field |
Description |
|
nodeGroupSpec |
Configuration of the new host group. |
NodeGroup
Configuration of the host group.
|
Field |
Description |
|
name |
string Required field. Name of the group. |
|
resources |
Resources allocated to the hosts. |
|
hostsCount |
string (int64) Number of hosts in the group. |
|
zoneIds[] |
string IDs of the availability zones the hosts belong to. |
|
subnetIds[] |
string IDs of the subnets that the hosts belong to. |
|
assignPublicIp |
boolean Determines whether a public IP is assigned to the hosts in the group. |
|
roles[] |
enum (GroupRole) Roles of the hosts in the group.
|
|
diskSizeAutoscaling |
Disk size autoscaling settings |
Resources
A list of computational resources allocated to a host.
|
Field |
Description |
|
resourcePresetId |
string ID of the preset for computational resources allocated to a host. |
|
diskSize |
string (int64) Volume of the storage used by the host, in bytes. |
|
diskTypeId |
string Type of the storage used by the host: |
DiskSizeAutoscaling
|
Field |
Description |
|
plannedUsageThreshold |
string (int64) Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent. |
|
emergencyUsageThreshold |
string (int64) Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. |
|
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": "boolean",
"metadata": {
"clusterId": "string",
"name": "string"
},
// Includes only one of the fields `error`
"error": {
"code": "integer",
"message": "string",
"details": [
"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 |
|
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 |
|
done |
boolean If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
AddNodeGroupMetadata
|
Field |
Description |
|
clusterId |
string ID of the OpenSearch cluster where the host group is being created. |
|
name |
string Name of the host group being created. |
Status
The error result of the operation in case of failure or cancellation.
|
Field |
Description |
|
code |
integer (int32) Error code. An enum value of google.rpc.Code. |
|
message |
string An error message. |
|
details[] |
object A list of messages that carry the error details. |