Managed Service for Redis API, REST: Cluster.restore
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",
"diskTypeId": "string"
},
"backupWindowStart": {
"hours": "integer",
"minutes": "integer",
"seconds": "integer",
"nanos": "integer"
},
"access": {
"dataLens": true,
"webSql": true
},
"redis": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"maxmemoryPercent": "integer"
},
"diskSizeAutoscaling": {
"plannedUsageThreshold": "integer",
"emergencyUsageThreshold": "integer",
"diskSizeLimit": "integer"
},
// `configSpec` includes only one of the fields `redisConfig_5_0`, `redisConfig_6_0`, `redisConfig_6_2`, `redisConfig_7_0`
"redisConfig_5_0": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
}
},
"redisConfig_6_0": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
}
},
"redisConfig_6_2": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"maxmemoryPercent": "integer"
},
"redisConfig_7_0": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"maxmemoryPercent": "integer"
},
// end of the list of possible fields`configSpec`
},
"hostSpecs": [
{
"zoneId": "string",
"subnetId": "string",
"shardName": "string",
"replicaPriority": "integer",
"assignPublicIp": true
}
],
"networkId": "string",
"folderId": "string",
"securityGroupIds": [
"string"
],
"tlsEnabled": true,
"persistenceMode": "string",
"deletionProtection": true,
"announceHostnames": true,
"maintenanceWindow": {
// `maintenanceWindow` includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
"anytime": {},
"weeklyMaintenanceWindow": {
"day": "string",
"hour": "string"
},
// end of the list of possible fields`maintenanceWindow`
}
}
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 |
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 No more than 64 per resource. The maximum string length in characters for each key is 63. Each key must match the regular expression |
environment | string Required. Deployment environment of the new Redis cluster.
|
configSpec | object Required. Configuration for the Redis cluster to be created. |
configSpec. version |
string Version of Redis used in the cluster. |
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. resources. diskTypeId |
string Type of the storage environment for the host. Possible values:
|
configSpec. backupWindowStart |
object Time to start the daily backup, in the UTC timezone. |
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. access. webSql |
boolean (boolean) Allow access for Web SQL. |
configSpec. redis |
object Unified configuration of a Redis cluster |
configSpec. redis. 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.
|
configSpec. redis. 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. redis. password |
string Authentication password. Value must match the regular expression |
configSpec. redis. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
configSpec. redis. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
configSpec. redis. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
configSpec. redis. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
configSpec. redis. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
configSpec. redis. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
configSpec. redis. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
configSpec. redis. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
configSpec. redis. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
configSpec. redis. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
configSpec. redis. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
configSpec. redis. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
configSpec. redis. maxmemoryPercent |
integer (int64) Redis maxmemory percent Acceptable values are 1 to 75, inclusive. |
configSpec. diskSizeAutoscaling |
object Disk size autoscaling settings |
configSpec. diskSizeAutoscaling. plannedUsageThreshold |
integer (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. |
configSpec. diskSizeAutoscaling. emergencyUsageThreshold |
integer (int64) Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. |
configSpec. diskSizeAutoscaling. diskSizeLimit |
integer (int64) Limit on how large the storage for database instances can automatically grow, in bytes. |
configSpec. redisConfig_5_0 |
object configSpec includes only one of the fields redisConfig_5_0 , redisConfig_6_0 , redisConfig_6_2 , redisConfig_7_0 Fields and structure of |
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.
|
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 |
configSpec. redisConfig_5_0. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
configSpec. redisConfig_5_0. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
configSpec. redisConfig_5_0. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
configSpec. redisConfig_5_0. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
configSpec. redisConfig_5_0. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
configSpec. redisConfig_5_0. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
configSpec. redisConfig_5_0. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
configSpec. redisConfig_5_0. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
configSpec. redisConfig_5_0. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
configSpec. redisConfig_5_0. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
configSpec. redisConfig_5_0. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
configSpec. redisConfig_5_0. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
configSpec. redisConfig_6_0 |
object configSpec includes only one of the fields redisConfig_5_0 , redisConfig_6_0 , redisConfig_6_2 , redisConfig_7_0 Fields and structure of |
configSpec. redisConfig_6_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.
|
configSpec. redisConfig_6_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_6_0. password |
string Authentication password. Value must match the regular expression |
configSpec. redisConfig_6_0. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
configSpec. redisConfig_6_0. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
configSpec. redisConfig_6_0. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
configSpec. redisConfig_6_0. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
configSpec. redisConfig_6_0. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
configSpec. redisConfig_6_0. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
configSpec. redisConfig_6_0. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
configSpec. redisConfig_6_0. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
configSpec. redisConfig_6_0. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
configSpec. redisConfig_6_0. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
configSpec. redisConfig_6_0. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
configSpec. redisConfig_6_0. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
configSpec. redisConfig_6_2 |
object configSpec includes only one of the fields redisConfig_5_0 , redisConfig_6_0 , redisConfig_6_2 , redisConfig_7_0 Fields and structure of |
configSpec. redisConfig_6_2. 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.
|
configSpec. redisConfig_6_2. 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_6_2. password |
string Authentication password. Value must match the regular expression |
configSpec. redisConfig_6_2. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
configSpec. redisConfig_6_2. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
configSpec. redisConfig_6_2. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
configSpec. redisConfig_6_2. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
configSpec. redisConfig_6_2. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
configSpec. redisConfig_6_2. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
configSpec. redisConfig_6_2. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
configSpec. redisConfig_6_2. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
configSpec. redisConfig_6_2. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
configSpec. redisConfig_6_2. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
configSpec. redisConfig_6_2. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
configSpec. redisConfig_6_2. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
configSpec. redisConfig_6_2. maxmemoryPercent |
integer (int64) Redis maxmemory percent Acceptable values are 1 to 75, inclusive. |
configSpec. redisConfig_7_0 |
object configSpec includes only one of the fields redisConfig_5_0 , redisConfig_6_0 , redisConfig_6_2 , redisConfig_7_0 Fields and structure of |
configSpec. redisConfig_7_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.
|
configSpec. redisConfig_7_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_7_0. password |
string Authentication password. Value must match the regular expression |
configSpec. redisConfig_7_0. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
configSpec. redisConfig_7_0. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
configSpec. redisConfig_7_0. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
configSpec. redisConfig_7_0. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
configSpec. redisConfig_7_0. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
configSpec. redisConfig_7_0. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
configSpec. redisConfig_7_0. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
configSpec. redisConfig_7_0. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
configSpec. redisConfig_7_0. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
configSpec. redisConfig_7_0. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
configSpec. redisConfig_7_0. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
configSpec. redisConfig_7_0. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
configSpec. redisConfig_7_0. maxmemoryPercent |
integer (int64) Redis maxmemory percent Acceptable values are 1 to 75, inclusive. |
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 |
hostSpecs[]. replicaPriority |
integer (int64) A replica with a low priority number is considered better for promotion. A replica with priority of 0 will never be selected by Redis Sentinel for promotion. Works only for non-sharded clusters. Default value is 100. |
hostSpecs[]. assignPublicIp |
boolean (boolean) Whether the host should get a public IP address on creation. Possible values:
|
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. |
securityGroupIds[] | string User security groups |
tlsEnabled | boolean (boolean) TLS port and functionality on\off |
persistenceMode | string Persistence mode |
deletionProtection | boolean (boolean) Deletion Protection inhibits deletion of the cluster |
announceHostnames | boolean (boolean) Enable FQDN instead of ip |
maintenanceWindow | object Window of maintenance operations. A maintenance window settings. |
maintenanceWindow. anytime |
object Maintenance operation can be scheduled anytime. maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow |
maintenanceWindow. weeklyMaintenanceWindow |
object Maintenance operation can be scheduled on a weekly basis. maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow |
maintenanceWindow. weeklyMaintenanceWindow. day |
string Day of the week (in |
maintenanceWindow. weeklyMaintenanceWindow. hour |
string (int64) Hour of the day in UTC (in Acceptable values are 1 to 24, inclusive. |
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. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
done | boolean (boolean) If the value is |
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 |
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. |