Managed Service for Elasticsearch API, gRPC: ClusterService.Restore
- gRPC request
- RestoreClusterRequest
- ConfigSpec
- ElasticsearchSpec
- DataNode
- ElasticsearchConfig7
- Resources
- MasterNode
- HostSpec
- ExtensionSpec
- operation.Operation
- RestoreClusterMetadata
- Cluster
- Monitoring
- ClusterConfig
- Elasticsearch
- DataNode
- ElasticsearchConfigSet7
- ElasticsearchConfig7
- Resources
- MasterNode
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
Creates a new ElasticSearch cluster from 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",
"elasticsearchSpec": {
"dataNode": {
// Includes only one of the fields `elasticsearchConfig_7`
"elasticsearchConfig_7": {
"maxClauseCount": "google.protobuf.Int64Value",
"fielddataCacheSize": "string",
"reindexRemoteWhitelist": "string",
"reindexSslCaPath": "string"
},
// end of the list of possible fields
"resources": {
"resourcePresetId": "string",
"diskSize": "int64",
"diskTypeId": "string"
}
},
"masterNode": {
"resources": {
"resourcePresetId": "string",
"diskSize": "int64",
"diskTypeId": "string"
}
},
"plugins": [
"string"
]
},
"edition": "string",
"adminPassword": "string"
},
"hostSpecs": [
{
"zoneId": "string",
"subnetId": "string",
"assignPublicIp": "bool",
"type": "Type",
"shardName": "string"
}
],
"networkId": "string",
"securityGroupIds": [
"string"
],
"serviceAccountId": "string",
"deletionProtection": "bool",
"folderId": "string",
"extensionSpecs": [
{
"name": "string",
"uri": "string",
"disabled": "bool"
}
]
}
Field |
Description |
backupId |
string Required field. Required. ID of the backup to restore from. |
name |
string Required field. Name of the ElasticSearch cluster. The name must be unique within the folder. |
description |
string Description of the ElasticSearch cluster. |
labels |
string Custom labels for the ElasticSearch cluster as |
environment |
enum Environment Deployment environment of the ElasticSearch cluster.
|
configSpec |
Required field. Configuration and resources for hosts that should be created for the ElasticSearch cluster. |
hostSpecs[] |
Required. Configuration of ElasticSearch hosts. |
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 for access to Object Storage. |
deletionProtection |
bool Deletion Protection inhibits deletion of the cluster |
folderId |
string Required field. ID of the folder to create the ElasticSearch cluster in. |
extensionSpecs[] |
optional |
ConfigSpec
Field |
Description |
version |
string Elasticsearch version. |
elasticsearchSpec |
Configuration and resource allocation for Elasticsearch nodes. |
edition |
string ElasticSearch edition. |
adminPassword |
string Required field. ElasticSearch admin password. |
ElasticsearchSpec
Field |
Description |
dataNode |
Configuration and resource allocation for Elasticsearch data nodes. |
masterNode |
Configuration and resource allocation for Elasticsearch master nodes. |
plugins[] |
string Cluster wide plugins |
DataNode
Field |
Description |
elasticsearchConfig_7 |
Includes only one of the fields Elasticsearch data node configuration. |
resources |
Resources allocated to Elasticsearch data nodes. |
ElasticsearchConfig7
Elasticsearch 7.x supported configuration options are listed here.
Detailed description for each set of options is available in Elasticsearch documentation
Any options that are not listed here are not supported.
Field |
Description |
maxClauseCount |
The maximum number of clauses a boolean query can contain. The limit is in place to prevent searches from becoming too large and taking up too much CPU and memory. Default value: See in-depth description in Elasticsearch documentation |
fielddataCacheSize |
string The maximum percentage or absolute value (10%, 512mb) of heap space that is allocated to field data cache. All the field values that are placed in this cache, get loaded to memory in order to provide fast document based access to those values. Default value: unbounded. See in-depth description in Elasticsearch documentation |
reindexRemoteWhitelist |
string Remote hosts for reindex have to be explicitly allowed in elasticsearch.yml using the reindex.remote.whitelist property. |
reindexSslCaPath |
string List of paths to PEM encoded certificate files that should be trusted. See in-depth description in Elasticsearch documentation |
Resources
Computational resources.
Field |
Description |
resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). |
diskSize |
int64 Volume of the storage available to a host, in bytes. |
diskTypeId |
string Type of the storage environment for the host. |
MasterNode
Field |
Description |
resources |
Resources allocated to Elasticsearch master nodes. |
HostSpec
Field |
Description |
zoneId |
string ID of the availability zone where the host resides. |
subnetId |
string ID of the subnet the host resides in. |
assignPublicIp |
bool The flag that defines whether a public IP address is assigned to the host. If the value is |
type |
enum Type Required field. Host type.
|
shardName |
string The shard name to create on the host. |
ExtensionSpec
Field |
Description |
name |
string Required field. Name of the extension. |
uri |
string URI of the zip archive to create the new extension from. Currently only supports links that are stored in Object Storage. |
disabled |
bool The flag shows whether to create the extension in disabled state. |
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",
"elasticsearch": {
"dataNode": {
// Includes only one of the fields `elasticsearchConfigSet_7`
"elasticsearchConfigSet_7": {
"effectiveConfig": {
"maxClauseCount": "google.protobuf.Int64Value",
"fielddataCacheSize": "string",
"reindexRemoteWhitelist": "string",
"reindexSslCaPath": "string"
},
"userConfig": {
"maxClauseCount": "google.protobuf.Int64Value",
"fielddataCacheSize": "string",
"reindexRemoteWhitelist": "string",
"reindexSslCaPath": "string"
},
"defaultConfig": {
"maxClauseCount": "google.protobuf.Int64Value",
"fielddataCacheSize": "string",
"reindexRemoteWhitelist": "string",
"reindexSslCaPath": "string"
}
},
// end of the list of possible fields
"resources": {
"resourcePresetId": "string",
"diskSize": "int64",
"diskTypeId": "string"
}
},
"masterNode": {
"resources": {
"resourcePresetId": "string",
"diskSize": "int64",
"diskTypeId": "string"
}
},
"plugins": [
"string"
]
},
"edition": "string"
},
"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"
}
}
// 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 |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool 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. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
RestoreClusterMetadata
Field |
Description |
clusterId |
string Required. ID of the new ElasticSearch cluster. |
backupId |
string Required. ID of the backup used for recovery. |
Cluster
An Elasticsearch cluster resource.
For more information, see the Concepts section of the documentation.
Field |
Description |
id |
string ID of the Elasticsearch cluster. |
folderId |
string ID of the folder that the Elasticsearch cluster belongs to. |
createdAt |
Creation timestamp. |
name |
string Name of the Elasticsearch cluster. |
description |
string Description of the Elasticsearch cluster. 0-256 characters long. |
labels |
string Custom labels for the Elasticsearch cluster as |
environment |
enum Environment Deployment environment of the Elasticsearch cluster.
|
monitoring[] |
Description of monitoring systems relevant to the Elasticsearch cluster. |
config |
Configuration of the Elasticsearch cluster. |
networkId |
string ID of the network that the cluster belongs to. |
health |
enum Health Aggregated cluster health.
|
status |
enum Status Current state of the cluster.
|
securityGroupIds[] |
string User security groups |
serviceAccountId |
string ID of the service account used for access to Object Storage. |
deletionProtection |
bool Deletion Protection inhibits deletion of the cluster |
maintenanceWindow |
Window of maintenance operations. |
plannedOperation |
Maintenance operation planned at nearest maintenance_window. |
Monitoring
Metadata of monitoring system.
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 Elasticsearch cluster. |
ClusterConfig
Field |
Description |
version |
string Elasticsearch version. |
elasticsearch |
Configuration and resource allocation for Elasticsearch nodes. |
edition |
string ElasticSearch edition. |
Elasticsearch
Field |
Description |
dataNode |
Configuration and resource allocation for Elasticsearch data nodes. |
masterNode |
Configuration and resource allocation for Elasticsearch master nodes. |
plugins[] |
string Cluster wide plugins |
DataNode
Field |
Description |
elasticsearchConfigSet_7 |
Elasticsearch 7.x data node configuration. Includes only one of the fields |
resources |
Resources allocated to Elasticsearch data nodes. |
ElasticsearchConfigSet7
Elasticsearch 7.x data node configuration.
Field |
Description |
effectiveConfig |
Required field. Effective settings for an Elasticsearch cluster (a combination of settings defined in |
userConfig |
User-defined settings for an Elasticsearch cluster. |
defaultConfig |
Default settings for an Elasticsearch cluster. |
ElasticsearchConfig7
Elasticsearch 7.x supported configuration options are listed here.
Detailed description for each set of options is available in Elasticsearch documentation
Any options that are not listed here are not supported.
Field |
Description |
maxClauseCount |
The maximum number of clauses a boolean query can contain. The limit is in place to prevent searches from becoming too large and taking up too much CPU and memory. Default value: See in-depth description in Elasticsearch documentation |
fielddataCacheSize |
string The maximum percentage or absolute value (10%, 512mb) of heap space that is allocated to field data cache. All the field values that are placed in this cache, get loaded to memory in order to provide fast document based access to those values. Default value: unbounded. See in-depth description in Elasticsearch documentation |
reindexRemoteWhitelist |
string Remote hosts for reindex have to be explicitly allowed in elasticsearch.yml using the reindex.remote.whitelist property. |
reindexSslCaPath |
string List of paths to PEM encoded certificate files that should be trusted. See in-depth description in Elasticsearch documentation |
Resources
Computational resources.
Field |
Description |
resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). |
diskSize |
int64 Volume of the storage available to a host, in bytes. |
diskTypeId |
string Type of the storage environment for the host. |
MasterNode
Field |
Description |
resources |
Resources allocated to Elasticsearch master nodes. |
MaintenanceWindow
Field |
Description |
anytime |
Includes only one of the fields |
weeklyMaintenanceWindow |
Includes only one of the fields |
AnytimeMaintenanceWindow
Field |
Description |
Empty |
WeeklyMaintenanceWindow
Field |
Description |
day |
enum WeekDay
|
hour |
int64 Hour of the day in UTC. |
MaintenanceOperation
Field |
Description |
info |
string |
delayedUntil |