Method restore

HTTP request
Body parameters
Response

Creates a new Redis cluster using the specified backup.

HTTP request

POST https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters:restore

Body parameters

{
  "backupId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "configSpec": {
    "version": "string",
    "resources": {
      "resourcePresetId": "string",
      "diskSize": "string"
    },
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },
    "access": {
      "dataLens": true
    },
    "redisConfig_5_0": {
      "maxmemoryPolicy": "string",
      "timeout": "integer",
      "password": "string"
    }
  },
  "hostSpecs": [
    {
      "zoneId": "string",
      "subnetId": "string",
      "shardName": "string"
    }
  ],
  "networkId": "string",
  "folderId": "string"
}

Field	Description
backupId	string Required. ID of the backup to create a cluster from. To get the backup ID, use a listBackups request.
name	string Required. Name of the new Redis cluster. 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 Redis cluster. The maximum string length in characters is 256.
labels	object Custom labels for the Redis cluster as `key:value` pairs. Maximum 64 per cluster. For example, "project": "mvp" or "source": "dictionary". No more than 64 per resource. The maximum string length in characters for each key is 63. Each key must match the regular expression `[a-z][-_0-9a-z]`. The maximum string length in characters for each value is 63. Each value must match the regular expression `[-_0-9a-z]`.
environment	string Required. Deployment environment of the new Redis cluster. 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	object Required. Configuration for the Redis cluster to be created.
configSpec. version	string Version of Redis used in the cluster. The only possible value is `5.0`.
configSpec. resources	object Resources allocated to Redis hosts.
configSpec. resources. resourcePresetId	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
configSpec. resources. diskSize	string (int64) Volume of the storage available to a host, in bytes.
configSpec. backupWindowStart	object Time to start the daily backup, in the UTC timezone. Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.
configSpec. backupWindowStart. hours	integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
configSpec. backupWindowStart. minutes	integer (int32) Minutes of hour of day. Must be from 0 to 59.
configSpec. backupWindowStart. seconds	integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
configSpec. backupWindowStart. nanos	integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
configSpec. access	object Access policy to DB
configSpec. access. dataLens	boolean (boolean) Allow access for DataLens
configSpec. redisConfig_5_0	object Fields and structure of `RedisConfig` reflects Redis configuration file parameters.
configSpec. redisConfig_5_0. maxmemoryPolicy	string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation. VOLATILE_LRU: Try to remove less recently used (LRU) keys with `expire set`. ALLKEYS_LRU: Remove less recently used (LRU) keys. VOLATILE_LFU: Try to remove least frequently used (LFU) keys with `expire set`. ALLKEYS_LFU: Remove least frequently used (LFU) keys. VOLATILE_RANDOM: Try to remove keys with `expire set` randomly. ALLKEYS_RANDOM: Remove keys randomly. VOLATILE_TTL: Try to remove less recently used (LRU) keys with `expire set` and shorter TTL first. NOEVICTION: Return errors when memory limit was reached and commands could require more memory to be used.
configSpec. redisConfig_5_0. timeout	integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed.
configSpec. redisConfig_5_0. password	string Authentication password. Value must match the regular expression `[a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}`.
hostSpecs[]	object Required. Configurations for Redis hosts that should be created for the cluster that is being created from the backup. Must contain at least one element.
hostSpecs[]. zoneId	string ID of the availability zone where the host resides. To get a list of available zones, use the list request.
hostSpecs[]. subnetId	string ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the field Cluster.networkId.
hostSpecs[]. shardName	string ID of the Redis shard the host belongs to. To get the shard ID use a listShards request. The maximum string length in characters is 63. Value must match the regular expression `[a-zA-Z0-9_-]*`.
networkId	string Required. ID of the network to create the Redis cluster in. The maximum string length in characters is 50.
folderId	string ID of the folder to create the Redis cluster in. The maximum string length in characters is 50.

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.
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.
done	boolean (boolean) 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	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` The error result of the operation in case of failure or cancellation.
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.