Managed Service for OpenSearch API, gRPC: ClusterService.Restore

Written by

Yandex Cloud

Updated at June 15, 2026

gRPC request
RestoreClusterRequest
ConfigCreateSpec
OpenSearchCreateSpec
NodeGroup
Resources
DiskSizeAutoscaling
OpenSearchConfig2
KeystoreSetting
DashboardsCreateSpec
NodeGroup
Access
SnapshotManagement
SnapshotSchedule
HourlySnapshotSchedule
DailySnapshotSchedule
WeeklySnapshotSchedule
AuditLog
MaintenanceWindow
AnytimeMaintenanceWindow
WeeklyMaintenanceWindow
operation.Operation

Creates a new OpenSearch cluster using the specified backup.

gRPC request

rpc Restore (RestoreClusterRequest) returns (operation.Operation)

RestoreClusterRequest

{
  "backup_id": "string",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "environment": "Environment",
  "config_spec": {
    "version": "string",
    "admin_password": "string",
    "opensearch_spec": {
      "plugins": [
        "string"
      ],
      "node_groups": [
        {
          "name": "string",
          "resources": {
            "resource_preset_id": "string",
            "disk_size": "int64",
            "disk_type_id": "string"
          },
          "hosts_count": "int64",
          "zone_ids": [
            "string"
          ],
          "subnet_ids": [
            "string"
          ],
          "assign_public_ip": "bool",
          "roles": [
            "GroupRole"
          ],
          "disk_size_autoscaling": {
            "planned_usage_threshold": "int64",
            "emergency_usage_threshold": "int64",
            "disk_size_limit": "int64"
          }
        }
      ],
      // Includes only one of the fields `opensearch_config_2`
      "opensearch_config_2": {
        "max_clause_count": "google.protobuf.Int64Value",
        "fielddata_cache_size": "string",
        "search_max_buckets": "google.protobuf.Int64Value",
        "reindex_remote_whitelist": "string",
        "http_max_initial_line_length": "google.protobuf.StringValue"
      },
      // end of the list of possible fields
      "keystore_settings": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    },
    "dashboards_spec": {
      "node_groups": [
        {
          "name": "string",
          "resources": {
            "resource_preset_id": "string",
            "disk_size": "int64",
            "disk_type_id": "string"
          },
          "hosts_count": "int64",
          "zone_ids": [
            "string"
          ],
          "subnet_ids": [
            "string"
          ],
          "assign_public_ip": "bool",
          "disk_size_autoscaling": {
            "planned_usage_threshold": "int64",
            "emergency_usage_threshold": "int64",
            "disk_size_limit": "int64"
          }
        }
      ]
    },
    "access": {
      "data_transfer": "bool",
      "serverless": "bool"
    },
    "snapshot_management": {
      "snapshot_schedule": {
        // Includes only one of the fields `hourly_snapshot_schedule`, `daily_snapshot_schedule`, `weekly_snapshot_schedule`
        "hourly_snapshot_schedule": {
          "minute": "int64"
        },
        "daily_snapshot_schedule": {
          "hour": "int64",
          "minute": "int64"
        },
        "weekly_snapshot_schedule": {
          "day": "WeekDay",
          "hour": "int64",
          "minute": "int64"
        }
        // end of the list of possible fields
      },
      "snapshot_max_age_days": "google.protobuf.Int64Value"
    },
    "audit_log": {
      "compliance_enabled": "google.protobuf.BoolValue",
      "log_request_body": "google.protobuf.BoolValue",
      "log_search_queries": "google.protobuf.BoolValue",
      "log_data_modifications": "google.protobuf.BoolValue",
      "log_index_metadata_access": "google.protobuf.BoolValue",
      "log_monitoring_checks": "google.protobuf.BoolValue",
      "log_index_maintenance": "google.protobuf.BoolValue",
      "log_backup_operations": "google.protobuf.BoolValue"
    }
  },
  "network_id": "string",
  "security_group_ids": [
    "string"
  ],
  "service_account_id": "string",
  "deletion_protection": "bool",
  "folder_id": "string",
  "maintenance_window": {
    // Includes only one of the fields `anytime`, `weekly_maintenance_window`
    "anytime": "AnytimeMaintenanceWindow",
    "weekly_maintenance_window": {
      "day": "WeekDay",
      "hour": "int64"
    }
    // end of the list of possible fields
  },
  "disk_encryption_key_id": "google.protobuf.StringValue"
}

Field	Description
backup_id	string Required field. ID of the backup to create a new cluster from. To get the backup ID, use a ClusterService.ListBackups request.
name	string Required field. Name of the new OpenSearch cluster to be created from the backup. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression `[a-zA-Z0-9_-]*`.
description	string Description of the new OpenSearch cluster to be created from the backup. The maximum string length in characters is 256.
labels	object (map<string, string>) Custom labels for the new OpenSearch cluster to be created from the backup as `key:value` pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary". The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression `[a-z][-_0-9a-z]`. Each value must match the regular expression `[-_0-9a-z]`. No more than 64 per resource.
environment	enum Environment Deployment environment of the new OpenSearch cluster to be created from the backup. `PRODUCTION`: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. `PRESTABLE`: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
config_spec	ConfigCreateSpec Required field. Configuration for the new OpenSearch cluster to be created from the backup.
network_id	string Required field. ID of the network to create the cluster in. The maximum string length in characters is 50.
security_group_ids[]	string User security groups.
service_account_id	string ID of the service account used to access Object Storage.
deletion_protection	bool Determines whether the cluster is protected from being deleted.
folder_id	string Required field. ID of the folder to create the OpenSearch cluster in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
maintenance_window	MaintenanceWindow Cluster maintenance window. Should be defined by either one of the two options.
disk_encryption_key_id	google.protobuf.StringValue ID of the key to encrypt cluster disks.

ConfigCreateSpec

Field	Description
version	string OpenSearch version.
admin_password	string Required field. OpenSearch admin password. The string length in characters must be 10-72.
opensearch_spec	OpenSearchCreateSpec OpenSearch configuration.
dashboards_spec	DashboardsCreateSpec Dashboards configuration.
access	Access Access policy for external services.
snapshot_management	SnapshotManagement Snapshot management configuration.
audit_log	AuditLog Audit log settings.

OpenSearchCreateSpec

OpenSearch create-time configuration.

Field	Description
plugins[]	string Names of the cluster plugins.
node_groups[]	NodeGroup OpenSearch type host groups of the cluster.
opensearch_config_2	OpenSearchConfig2 OpenSearch server configuration settings. Includes only one of the fields `opensearch_config_2`.
keystore_settings[]	KeystoreSetting Initial cluster keystore settings.

NodeGroup

Configuration of the host group.

Field	Description
name	string Required field. Name of the group. The maximum string length in characters is 63. Value must match the regular expression `[a-zA-Z0-9_-]*`.
resources	Resources Resources allocated to the hosts.
hosts_count	int64 Number of hosts in the group. The minimum value is 1.
zone_ids[]	string IDs of the availability zones the hosts belong to. The maximum string length in characters for each value is 50. The maximum number of elements is 10.
subnet_ids[]	string IDs of the subnets that the hosts belong to. The maximum string length in characters for each value is 50. The maximum number of elements is 10.
assign_public_ip	bool Determines whether a public IP is assigned to the hosts in the group.
roles[]	enum GroupRole Roles of the hosts in the group. `DATA`: Data nodes store indices data. `MANAGER`: Manager nodes perform cluster coordination. `WARM`: Warm nodes provide access to searchable snapshots and manage search cache for these snapshots. `INGEST`: Ingest nodes provides indexed data processing. If no node groups have INGEST role explicitly set, then all DATA nodes will implicitly have INGEST role.
disk_size_autoscaling	DiskSizeAutoscaling Disk size autoscaling settings

Resources

A list of computational resources allocated to a host.

Field	Description
resource_preset_id	string Required field. ID of the preset for computational resources allocated to a host.
disk_size	int64 Volume of the storage used by the host, in bytes. Value must be greater than 0.
disk_type_id	string Required field. Type of the storage used by the host: `network-hdd`, `network-ssd` or `local-ssd`.

DiskSizeAutoscaling

Disk size autoscaling settings.

Field	Description
planned_usage_threshold	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.
emergency_usage_threshold	int64 Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive.
disk_size_limit	int64 Limit on how large the storage for database instances can automatically grow, in bytes.

OpenSearchConfig2

OpenSearch server configuration settings.

Field	Description
max_clause_count	google.protobuf.Int64Value Defines the maximum product of fields and terms that are queryable simultaneously. Default value: 1024. Change of the setting is applied with restart. For details, see OpenSearch documentation.
fielddata_cache_size	string The maximum size of the field data cache. May be specified as an absolute value (for example, 8GB) or a percentage of the node heap (for example, 50%). This setting is dynamic. If you don't specify this setting, the maximum size is 35%. This value should be smaller than the indices.breaker.fielddata.limit Change of the setting is applied with restart. For details, see OpenSearch documentation.
search_max_buckets	google.protobuf.Int64Value The maximum number of aggregation buckets allowed in a single response. Default is 65535 Default value: 65535. Change of the setting is applied with restart. For details, see OpenSearch documentation.
reindex_remote_whitelist	string Allowed remote hosts Change of the setting is applied with restart. For details, see OpenSearch documentation.
http_max_initial_line_length	google.protobuf.StringValue Sets the maximum length allowed for HTTP URLs in the initial request line. URLs exceeding this limit will be rejected. Default is 4kb. Default value: 4kb. Change of the setting is applied with restart. For details, see OpenSearch documentation.

KeystoreSetting

Single keystore entry.

Field

Description

name

string

Required field. Keystore entry name.

value

string

Required field. Keystore entry value.

DashboardsCreateSpec

Dashboards create-time configuration.

Field

Description

node_groups[]

NodeGroup

Dashboards type host groups of the cluster.

NodeGroup

Field	Description
name	string Required field. Name of the group. The maximum string length in characters is 63. Value must match the regular expression `[a-zA-Z0-9_-]*`.
resources	Resources Resources allocated to the hosts.
hosts_count	int64 Number of hosts in the group. The minimum value is 1.
zone_ids[]	string IDs of the availability zones the hosts belong to.
subnet_ids[]	string IDs of the subnets that the hosts belong to. The maximum string length in characters for each value is 50. The maximum number of elements is 10.
assign_public_ip	bool Determines whether a public IP is assigned to the hosts in the group.
disk_size_autoscaling	DiskSizeAutoscaling Disk size autoscaling settings

Access

Access policy for external services.

Field

Description

data_transfer

bool

Determines whether the access to Data Transfer is allowed.

serverless

bool

Determines whether the access to Serverless is allowed.

SnapshotManagement

Snapshot management configuration

Field

Description

snapshot_schedule

SnapshotSchedule

Snapshot creation schedule

snapshot_max_age_days

google.protobuf.Int64Value

Snapshot max age in days

The minimum value is 7.

SnapshotSchedule

Snapshot creation schedule

Field	Description
hourly_snapshot_schedule	HourlySnapshotSchedule Hourly based snapshot schedule Includes only one of the fields `hourly_snapshot_schedule`, `daily_snapshot_schedule`, `weekly_snapshot_schedule`.
daily_snapshot_schedule	DailySnapshotSchedule Daily based snapshot schedule Includes only one of the fields `hourly_snapshot_schedule`, `daily_snapshot_schedule`, `weekly_snapshot_schedule`.
weekly_snapshot_schedule	WeeklySnapshotSchedule Weekly based snapshot schedule Includes only one of the fields `hourly_snapshot_schedule`, `daily_snapshot_schedule`, `weekly_snapshot_schedule`.

HourlySnapshotSchedule

Hourly based snapshot schedule

Field

Description

minute

int64

The minute of the hour at which the backup should be created.

Acceptable values are 0 to 59, inclusive.

DailySnapshotSchedule

Daily based snapshot schedule

Field

Description

hour

int64

The hour of the day in UTC timezone at which the backup should be created.

Acceptable values are 0 to 23, inclusive.

minute

int64

The minute of the hour at which the backup should be created.

Acceptable values are 0 to 59, inclusive.

WeeklySnapshotSchedule

Weekly based snapshot schedule

Field	Description
day	enum WeekDay Day of the week `MON` `TUE` `WED` `THU` `FRI` `SAT` `SUN`
hour	int64 The hour of the day in UTC timezone at which the backup should be created. Acceptable values are 0 to 23, inclusive.
minute	int64 The minute of the hour at which the backup should be created. Acceptable values are 0 to 59, inclusive.

AuditLog

OpenSearch audit logs settings.

Field	Description
compliance_enabled	google.protobuf.BoolValue Enables audit logging on changes to a security index, such as changes to roles mappings and role creation or deletion. For details, see OpenSearch documentation.
log_request_body	google.protobuf.BoolValue Includes the body of the request (if available) for both REST and the transport layer. For details, see OpenSearch documentation.
log_search_queries	google.protobuf.BoolValue Enables indices data read requests logging.
log_data_modifications	google.protobuf.BoolValue Enables indices data write request logging.
log_index_metadata_access	google.protobuf.BoolValue Enables indices metadata requests logging.
log_monitoring_checks	google.protobuf.BoolValue Enables monitoring data requests logging.
log_index_maintenance	google.protobuf.BoolValue Enables indices maintenance requests logging, such as indices refreshes, flushes and merges.
log_backup_operations	google.protobuf.BoolValue Enables snapshots and repositories requests logging.

MaintenanceWindow

An OpenSearch cluster maintenance window. Should be defined by either one of the two options.

Field

Description

anytime

AnytimeMaintenanceWindow

An any-time maintenance window.

Includes only one of the fields anytime, weekly_maintenance_window.

weekly_maintenance_window

WeeklyMaintenanceWindow

A weekly maintenance window.

Includes only one of the fields anytime, weekly_maintenance_window.

AnytimeMaintenanceWindow

An any-time maintenance window.

Field	Description
Empty

WeeklyMaintenanceWindow

A weekly maintenance window.

Field

Description

day

enum WeekDay

Day of the week.

MON: Monday
TUE: Tuesday
WED: Wednesday
THU: Thursday
FRI: Friday
SAT: Saturday
SUN: Sunday

hour

int64

Hour of the day in the UTC timezone.

Acceptable values are 1 to 24, inclusive.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // 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.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any 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	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	google.protobuf.Any 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. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

Managed Service for OpenSearch API, gRPC: ClusterService.Restore

gRPC requestgRPC request

RestoreClusterRequestRestoreClusterRequest

ConfigCreateSpecConfigCreateSpec

OpenSearchCreateSpecOpenSearchCreateSpec

NodeGroupNodeGroup

ResourcesResources

DiskSizeAutoscalingDiskSizeAutoscaling

OpenSearchConfig2OpenSearchConfig2

KeystoreSettingKeystoreSetting

DashboardsCreateSpecDashboardsCreateSpec

NodeGroupNodeGroup

AccessAccess

SnapshotManagementSnapshotManagement

SnapshotScheduleSnapshotSchedule

HourlySnapshotScheduleHourlySnapshotSchedule

DailySnapshotScheduleDailySnapshotSchedule

WeeklySnapshotScheduleWeeklySnapshotSchedule

AuditLogAuditLog

MaintenanceWindowMaintenanceWindow

AnytimeMaintenanceWindowAnytimeMaintenanceWindow

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

operation.Operationoperation.Operation

Was the article helpful?

gRPC request

RestoreClusterRequest

ConfigCreateSpec

OpenSearchCreateSpec

NodeGroup

Resources

DiskSizeAutoscaling

OpenSearchConfig2

KeystoreSetting

DashboardsCreateSpec

NodeGroup

Access

SnapshotManagement

SnapshotSchedule

HourlySnapshotSchedule

DailySnapshotSchedule

WeeklySnapshotSchedule

AuditLog

MaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

operation.Operation