Managed Service for OpenSearch API, gRPC: ClusterService.Restore

Written by

Yandex Cloud

Updated at October 17, 2024

gRPC request
RestoreClusterRequest
ConfigCreateSpec
OpenSearchCreateSpec
NodeGroup
Resources
DiskSizeAutoscaling
OpenSearchConfig2
KeystoreSetting
DashboardsCreateSpec
NodeGroup
Access
MaintenanceWindow
AnytimeMaintenanceWindow
WeeklyMaintenanceWindow
operation.Operation
RestoreClusterMetadata
Cluster
Monitoring
ClusterConfig
OpenSearch
NodeGroup
Resources
DiskSizeAutoscaling
OpenSearchConfigSet2
OpenSearchConfig2
Dashboards
NodeGroup
Access
MaintenanceWindow
AnytimeMaintenanceWindow
WeeklyMaintenanceWindow
MaintenanceOperation

Creates a new OpenSearch cluster using the specified backup.

gRPC request

rpc Restore (RestoreClusterRequest) returns (operation.Operation)

RestoreClusterRequest

{
  "backupId": "string",
  "name": "string",
  "description": "string",
  "labels": "string",
  "environment": "Environment",
  "configSpec": {
    "version": "string",
    "adminPassword": "string",
    "opensearchSpec": {
      "plugins": [
        "string"
      ],
      "nodeGroups": [
        {
          "name": "string",
          "resources": {
            "resourcePresetId": "string",
            "diskSize": "int64",
            "diskTypeId": "string"
          },
          "hostsCount": "int64",
          "zoneIds": [
            "string"
          ],
          "subnetIds": [
            "string"
          ],
          "assignPublicIp": "bool",
          "roles": [
            "GroupRole"
          ],
          "diskSizeAutoscaling": {
            "plannedUsageThreshold": "int64",
            "emergencyUsageThreshold": "int64",
            "diskSizeLimit": "int64"
          }
        }
      ],
      // Includes only one of the fields `opensearchConfig_2`
      "opensearchConfig_2": {
        "maxClauseCount": "google.protobuf.Int64Value",
        "fielddataCacheSize": "string",
        "reindexRemoteWhitelist": "string"
      },
      // end of the list of possible fields
      "keystoreSettings": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    },
    "dashboardsSpec": {
      "nodeGroups": [
        {
          "name": "string",
          "resources": {
            "resourcePresetId": "string",
            "diskSize": "int64",
            "diskTypeId": "string"
          },
          "hostsCount": "int64",
          "zoneIds": [
            "string"
          ],
          "subnetIds": [
            "string"
          ],
          "assignPublicIp": "bool",
          "diskSizeAutoscaling": {
            "plannedUsageThreshold": "int64",
            "emergencyUsageThreshold": "int64",
            "diskSizeLimit": "int64"
          }
        }
      ]
    },
    "access": {
      "dataTransfer": "bool",
      "serverless": "bool"
    }
  },
  "networkId": "string",
  "securityGroupIds": [
    "string"
  ],
  "serviceAccountId": "string",
  "deletionProtection": "bool",
  "folderId": "string",
  "maintenanceWindow": {
    // Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
    "anytime": "AnytimeMaintenanceWindow",
    "weeklyMaintenanceWindow": {
      "day": "WeekDay",
      "hour": "int64"
    }
    // end of the list of possible fields
  }
}

Field	Description
backupId	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.
description	string Description of the new OpenSearch cluster to be created from the backup.
labels	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".
environment	enum Environment Deployment environment of the new OpenSearch cluster to be created from the backup. `ENVIRONMENT_UNSPECIFIED` `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.
configSpec	ConfigCreateSpec Required field. Configuration for the new OpenSearch cluster to be created from the backup.
networkId	string Required field. ID of the network to create the cluster in.
securityGroupIds[]	string User security groups.
serviceAccountId	string ID of the service account used to access Object Storage.
deletionProtection	bool Determines whether the cluster is protected from being deleted.
folderId	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.
maintenanceWindow	MaintenanceWindow Cluster maintenance window. Should be defined by either one of the two options.

ConfigCreateSpec

Field	Description
version	string OpenSearch version.
adminPassword	string Required field. OpenSearch admin password.
opensearchSpec	OpenSearchCreateSpec OpenSearch configuration.
dashboardsSpec	DashboardsCreateSpec Dashboards configuration.
access	Access Access policy for external services.

OpenSearchCreateSpec

OpenSearch create-time configuration.

Field	Description
plugins[]	string Names of the cluster plugins.
nodeGroups[]	NodeGroup OpenSearch type host groups of the cluster.
opensearchConfig_2	OpenSearchConfig2 Includes only one of the fields `opensearchConfig_2`.
keystoreSettings[]	KeystoreSetting Initial cluster keystore settings.

NodeGroup

Configuration of the host group.

Field	Description
name	string Required field. Name of the group.
resources	Resources Resources allocated to the hosts.
hostsCount	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	bool Determines whether a public IP is assigned to the hosts in the group.
roles[]	enum GroupRole Roles of the hosts in the group. `GROUP_ROLE_UNSPECIFIED` `DATA` `MANAGER`
diskSizeAutoscaling	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	int64 Volume of the storage used by the host, in bytes.
diskTypeId	string Type of the storage used by the host: `network-hdd`, `network-ssd` or `local-ssd`.

DiskSizeAutoscaling

Field	Description
plannedUsageThreshold	int64 Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.
emergencyUsageThreshold	int64 Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.
diskSizeLimit	int64 Limit on how large the storage for database instances can automatically grow, in bytes.

OpenSearchConfig2

Field	Description
maxClauseCount	google.protobuf.Int64Value the maximum number of allowed boolean clauses in a query
fielddataCacheSize	string the percentage or absolute value (10%, 512mb) of heap space that is allocated to fielddata
reindexRemoteWhitelist	string

KeystoreSetting

Single keystore entry.

Field

Description

name

string

Keystore entry name.

value

string

Keystore entry value.

DashboardsCreateSpec

Dashboards create-time configuration.

Field

Description

nodeGroups[]

NodeGroup

Dashboards type host groups of the cluster.

NodeGroup

Field	Description
name	string Required field. Name of the group.
resources	Resources Resources allocated to the hosts.
hostsCount	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	bool Determines whether a public IP is assigned to the hosts in the group.
diskSizeAutoscaling	DiskSizeAutoscaling Disk size autoscaling settings

Access

Access policy for external services.

Field

Description

dataTransfer

bool

Determines whether the access to Data Transfer is allowed.

serverless

bool

Determines whether the access to Serverless is allowed.

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, weeklyMaintenanceWindow.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

A weekly maintenance window.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

AnytimeMaintenanceWindow

An any-time maintenance window.

Field	Description
Empty

WeeklyMaintenanceWindow

A weekly maintenance window.

Field

Description

day

enum WeekDay

Day of the week.

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

hour

int64

Hour of the day in the UTC timezone.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "clusterId": "string",
    "backupId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "string",
    "environment": "Environment",
    "monitoring": [
      {
        "name": "string",
        "description": "string",
        "link": "string"
      }
    ],
    "config": {
      "version": "string",
      "opensearch": {
        "plugins": [
          "string"
        ],
        "nodeGroups": [
          {
            "name": "string",
            "resources": {
              "resourcePresetId": "string",
              "diskSize": "int64",
              "diskTypeId": "string"
            },
            "hostsCount": "int64",
            "zoneIds": [
              "string"
            ],
            "subnetIds": [
              "string"
            ],
            "assignPublicIp": "bool",
            "roles": [
              "GroupRole"
            ],
            "diskSizeAutoscaling": {
              "plannedUsageThreshold": "int64",
              "emergencyUsageThreshold": "int64",
              "diskSizeLimit": "int64"
            }
          }
        ],
        // Includes only one of the fields `opensearchConfigSet_2`
        "opensearchConfigSet_2": {
          "effectiveConfig": {
            "maxClauseCount": "google.protobuf.Int64Value",
            "fielddataCacheSize": "string",
            "reindexRemoteWhitelist": "string"
          },
          "userConfig": {
            "maxClauseCount": "google.protobuf.Int64Value",
            "fielddataCacheSize": "string",
            "reindexRemoteWhitelist": "string"
          },
          "defaultConfig": {
            "maxClauseCount": "google.protobuf.Int64Value",
            "fielddataCacheSize": "string",
            "reindexRemoteWhitelist": "string"
          }
        },
        // end of the list of possible fields
        "keystoreSettings": [
          "string"
        ]
      },
      "dashboards": {
        "nodeGroups": [
          {
            "name": "string",
            "resources": {
              "resourcePresetId": "string",
              "diskSize": "int64",
              "diskTypeId": "string"
            },
            "hostsCount": "int64",
            "zoneIds": [
              "string"
            ],
            "subnetIds": [
              "string"
            ],
            "assignPublicIp": "bool",
            "diskSizeAutoscaling": {
              "plannedUsageThreshold": "int64",
              "emergencyUsageThreshold": "int64",
              "diskSizeLimit": "int64"
            }
          }
        ]
      },
      "access": {
        "dataTransfer": "bool",
        "serverless": "bool"
      }
    },
    "networkId": "string",
    "health": "Health",
    "status": "Status",
    "securityGroupIds": [
      "string"
    ],
    "serviceAccountId": "string",
    "deletionProtection": "bool",
    "maintenanceWindow": {
      // Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
      "anytime": "AnytimeMaintenanceWindow",
      "weeklyMaintenanceWindow": {
        "day": "WeekDay",
        "hour": "int64"
      }
      // end of the list of possible fields
    },
    "plannedOperation": {
      "info": "string",
      "delayedUntil": "google.protobuf.Timestamp",
      "latestMaintenanceTime": "google.protobuf.Timestamp",
      "nextMaintenanceWindowTime": "google.protobuf.Timestamp"
    }
  }
  // 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	google.protobuf.Timestamp Creation timestamp.
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	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	RestoreClusterMetadata 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	Cluster 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.

RestoreClusterMetadata

Field

Description

clusterId

string

ID of the new OpenSearch cluster being created from a backup.

backupId

string

ID of the backup being used for creating a cluster.

Cluster

An OpenSearch cluster resource.

Field	Description
id	string ID of the OpenSearch cluster. This ID is assigned by the platform at the moment of cluster creation.
folderId	string ID of the folder that the OpenSearch cluster belongs to.
createdAt	google.protobuf.Timestamp Time when the cluster was created.
name	string Name of the OpenSearch cluster. The name is unique within the folder. 1-63 characters long.
description	string Description of the OpenSearch cluster. 0-256 characters long.
labels	string Custom labels for the OpenSearch cluster as `key:value` pairs. Maximum 64 labels per resource.
environment	enum Environment Deployment environment of the OpenSearch cluster. `ENVIRONMENT_UNSPECIFIED` `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.
monitoring[]	Monitoring Description of monitoring systems relevant to the OpenSearch cluster.
config	ClusterConfig Configuration of the OpenSearch cluster.
networkId	string ID of the cloud network that the cluster belongs to.
health	enum Health Aggregated cluster health. `HEALTH_UNKNOWN`: Health of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN). `ALIVE`: Cluster is working normally (Host.health for every host in the cluster is ALIVE). `DEAD`: Cluster is inoperable (Host.health for every host in the cluster is DEAD). `DEGRADED`: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
status	enum Status Current state of the cluster. `STATUS_UNKNOWN`: Cluster state is unknown. `CREATING`: Cluster is being created. `RUNNING`: Cluster is running normally. `ERROR`: Cluster has encountered a problem and cannot operate. `UPDATING`: Cluster is being updated. `STOPPING`: Cluster is stopping. `STOPPED`: Cluster has stopped. `STARTING`: Cluster is starting.
securityGroupIds[]	string User security groups.
serviceAccountId	string ID of the service account used to access Object Storage.
deletionProtection	bool Determines whether the cluster is protected from being deleted.
maintenanceWindow	MaintenanceWindow Cluster maintenance window. Should be defined by either one of the two options.
plannedOperation	MaintenanceOperation Maintenance operation planned at nearest `maintenanceWindow`.

Monitoring

Monitoring system metadata.

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the OpenSearch cluster.

ClusterConfig

The OpenSearch cluster configuration.

Field	Description
version	string Version of the OpenSearch server software.
opensearch	OpenSearch OpenSearch configuration.
dashboards	Dashboards Dashboards configuration.
access	Access Access policy for external services.

OpenSearch

The OpenSearch host group type configuration.

Field	Description
plugins[]	string Names of the cluster plugins.
nodeGroups[]	NodeGroup Host groups of the OpenSearch type.
opensearchConfigSet_2	OpenSearchConfigSet2 Includes only one of the fields `opensearchConfigSet_2`.
keystoreSettings[]	string Keystore entries names.

NodeGroup

Configuration of the host group.

Field	Description
name	string Name of the group. Must be 1-63 characters long.
resources	Resources Resources allocated to the hosts.
hostsCount	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	bool Determines whether a public IP is assigned to the hosts in the group.
roles[]	enum GroupRole Roles of the host group. `GROUP_ROLE_UNSPECIFIED` `DATA` `MANAGER`
diskSizeAutoscaling	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	int64 Volume of the storage used by the host, in bytes.
diskTypeId	string Type of the storage used by the host: `network-hdd`, `network-ssd` or `local-ssd`.

DiskSizeAutoscaling

Field	Description
plannedUsageThreshold	int64 Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.
emergencyUsageThreshold	int64 Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.
diskSizeLimit	int64 Limit on how large the storage for database instances can automatically grow, in bytes.

OpenSearchConfigSet2

Field	Description
effectiveConfig	OpenSearchConfig2 Required field.
userConfig	OpenSearchConfig2
defaultConfig	OpenSearchConfig2

OpenSearchConfig2

Field	Description
maxClauseCount	google.protobuf.Int64Value the maximum number of allowed boolean clauses in a query
fielddataCacheSize	string the percentage or absolute value (10%, 512mb) of heap space that is allocated to fielddata
reindexRemoteWhitelist	string

Dashboards

The Dashboards host group type configuration.

Field

Description

nodeGroups[]

NodeGroup

Host groups of the Dashboards type.

NodeGroup

Field	Description
name	string Name of the group. 1-63 characters long.
resources	Resources Resources allocated to the hosts.
hostsCount	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	bool Determines whether a public IP is assigned to the hosts in the group.
diskSizeAutoscaling	DiskSizeAutoscaling Disk size autoscaling settings

Access

Access policy for external services.

Field

Description

dataTransfer

bool

Determines whether the access to Data Transfer is allowed.

serverless

bool

Determines whether the access to Serverless is allowed.

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, weeklyMaintenanceWindow.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

A weekly maintenance window.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

AnytimeMaintenanceWindow

An any-time maintenance window.

Field	Description
Empty

WeeklyMaintenanceWindow

A weekly maintenance window.

Field

Description

day

enum WeekDay

Day of the week.

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

hour

int64

Hour of the day in the UTC timezone.

MaintenanceOperation

Field	Description
info	string The description of the operation.
delayedUntil	google.protobuf.Timestamp Delay time for the maintenance operation.
latestMaintenanceTime	google.protobuf.Timestamp Time of the last maintenance window.
nextMaintenanceWindowTime	google.protobuf.Timestamp Time of the next maintenance window.

Managed Service for OpenSearch API, gRPC: ClusterService.Restore

gRPC requestgRPC request

RestoreClusterRequestRestoreClusterRequest

ConfigCreateSpecConfigCreateSpec

OpenSearchCreateSpecOpenSearchCreateSpec

NodeGroupNodeGroup

ResourcesResources

DiskSizeAutoscalingDiskSizeAutoscaling

OpenSearchConfig2OpenSearchConfig2

KeystoreSettingKeystoreSetting

DashboardsCreateSpecDashboardsCreateSpec

NodeGroupNodeGroup

AccessAccess

MaintenanceWindowMaintenanceWindow

AnytimeMaintenanceWindowAnytimeMaintenanceWindow

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

operation.Operationoperation.Operation

RestoreClusterMetadataRestoreClusterMetadata

ClusterCluster

MonitoringMonitoring

ClusterConfigClusterConfig

OpenSearchOpenSearch

NodeGroupNodeGroup

ResourcesResources

DiskSizeAutoscalingDiskSizeAutoscaling

OpenSearchConfigSet2OpenSearchConfigSet2

OpenSearchConfig2OpenSearchConfig2

DashboardsDashboards

NodeGroupNodeGroup

AccessAccess

MaintenanceWindowMaintenanceWindow

AnytimeMaintenanceWindowAnytimeMaintenanceWindow

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

MaintenanceOperationMaintenanceOperation

Was the article helpful?

gRPC request

RestoreClusterRequest

ConfigCreateSpec

OpenSearchCreateSpec

NodeGroup

Resources

DiskSizeAutoscaling

OpenSearchConfig2

KeystoreSetting

DashboardsCreateSpec

NodeGroup

Access

MaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

operation.Operation

RestoreClusterMetadata

Cluster

Monitoring

ClusterConfig

OpenSearch

NodeGroup

Resources

DiskSizeAutoscaling

OpenSearchConfigSet2

OpenSearchConfig2

Dashboards

NodeGroup

Access

MaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

MaintenanceOperation