Method restore

Creates a new MongoDB cluster using the specified backup.

HTTP request

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

Body parameters

{
  "backupId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "configSpec": {
    "version": "string",
    "featureCompatibilityVersion": "string",
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },

    // `configSpec` includes only one of the fields `mongodbSpec_3_6`, `mongodbSpec_4_0`
    "mongodbSpec_3_6": {
      "mongod": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              },
              "collectionConfig": {
                "blockCompressor": "string"
              }
            },
            "journal": {
              "enabled": true,
              "commitInterval": "integer"
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "integer"
          },
          "net": {
            "maxIncomingConnections": "integer"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "integer"
          },
          "net": {
            "maxIncomingConnections": "integer"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "maxIncomingConnections": "integer"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      }
    },
    "mongodbSpec_4_0": {
      "mongod": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              },
              "collectionConfig": {
                "blockCompressor": "string"
              }
            },
            "journal": {
              "commitInterval": "integer"
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "integer"
          },
          "net": {
            "maxIncomingConnections": "integer"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      },
      "mongocfg": {
        "config": {
          "storage": {
            "wiredTiger": {
              "engineConfig": {
                "cacheSizeGb": "number"
              }
            }
          },
          "operationProfiling": {
            "mode": "string",
            "slowOpThreshold": "integer"
          },
          "net": {
            "maxIncomingConnections": "integer"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      },
      "mongos": {
        "config": {
          "net": {
            "maxIncomingConnections": "integer"
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      }
    },
    // end of the list of possible fields`configSpec`

  },
  "hostSpecs": [
    {
      "zoneId": "string",
      "subnetId": "string",
      "assignPublicIp": true,
      "type": "string",
      "shardName": "string"
    }
  ],
  "networkId": "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 MongoDB 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 MongoDB cluster.

The maximum string length in characters is 256.

labels object

Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource. 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 MongoDB cluster.

Deployment environment.

  • 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 MongoDB cluster to be created.

configSpec.
version
string

Version of MongoDB used in the cluster. Possible values:

  • 3.6
  • 4.0
configSpec.
featureCompatibilityVersion
string

MongoDB feature compatibility version. Possible values:

  • 3.6
  • 4.0
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][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.
mongodbSpec_3_6
object
Configuration and resource allocation for a MongoDB 3.6 cluster.
configSpec includes only one of the fields mongodbSpec_3_6, mongodbSpec_4_0

configSpec.
mongodbSpec_3_6.
mongod
object

Configuration and resource allocation for a mongod host.

configSpec.
mongodbSpec_3_6.
mongod.
config
object

Configuration for a mongod 3.6 hosts.

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

configSpec.
mongodbSpec_3_6.
mongod.
config.
storage
object

storage section of mongod configuration.

configSpec.
mongodbSpec_3_6.
mongod.
config.
storage.
wiredTiger
object

Configuration of the WiredTiger storage engine.

Configuration of WiredTiger storage engine.

configSpec.
mongodbSpec_3_6.
mongod.
config.
storage.
wiredTiger.
engineConfig
object

Engine configuration for WiredTiger.

configSpec.
mongodbSpec_3_6.
mongod.
config.
storage.
wiredTiger.
engineConfig.
cacheSizeGb
number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

configSpec.
mongodbSpec_3_6.
mongod.
config.
storage.
wiredTiger.
collectionConfig
object

Collection configuration for WiredTiger.

configSpec.
mongodbSpec_3_6.
mongod.
config.
storage.
wiredTiger.
collectionConfig.
blockCompressor
string

Default type of compression to use for collection data.

  • NONE: No compression.
  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
configSpec.
mongodbSpec_3_6.
mongod.
config.
storage.
journal
object

Configuration of the MongoDB journal.

configSpec.
mongodbSpec_3_6.
mongod.
config.
storage.
journal.
enabled
boolean (boolean)

Whether the journal is enabled or disabled. Possible values:

  • true (default) — the journal is enabled.
  • false — the journal is disabled.
configSpec.
mongodbSpec_3_6.
mongod.
config.
storage.
journal.
commitInterval
integer (int64)

Commit interval between journal operations, in milliseconds. Default: 100.

Acceptable values are 1 to 500, inclusive.

configSpec.
mongodbSpec_3_6.
mongod.
config.
operationProfiling
object

operationProfiling section of mongod configuration.

configSpec.
mongodbSpec_3_6.
mongod.
config.
operationProfiling.
mode
string

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.
configSpec.
mongodbSpec_3_6.
mongod.
config.
operationProfiling.
slowOpThreshold
integer (int64)

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

Value must be greater than 0.

configSpec.
mongodbSpec_3_6.
mongod.
config.
net
object

net section of mongod configuration.

configSpec.
mongodbSpec_3_6.
mongod.
config.
net.
maxIncomingConnections
integer (int64)

The maximum number of simultaneous connections that mongod will accept.

Acceptable values are 10 to 16384, inclusive.

configSpec.
mongodbSpec_3_6.
mongod.
resources
object

Resources allocated to mongod hosts.

configSpec.
mongodbSpec_3_6.
mongod.
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.
mongodbSpec_3_6.
mongod.
resources.
diskSize
string (int64)

Volume of the storage available to a host, in bytes.

configSpec.
mongodbSpec_3_6.
mongod.
resources.
diskTypeId
string

Type of the storage environment for the host. Possible values:

  • network-hdd — network HDD drive,
  • network-nvme — network SSD drive,
  • local-nvme — local SSD storage.
configSpec.
mongodbSpec_3_6.
mongocfg
object

Configuration and resource allocation for a mongocfg host.

configSpec.
mongodbSpec_3_6.
mongocfg.
config
object
configSpec.
mongodbSpec_3_6.
mongocfg.
config.
storage
object

storage section of mongocfg configuration.

configSpec.
mongodbSpec_3_6.
mongocfg.
config.
storage.
wiredTiger
object

Configuration of the WiredTiger storage engine.

Configuration of WiredTiger storage engine.

configSpec.
mongodbSpec_3_6.
mongocfg.
config.
storage.
wiredTiger.
engineConfig
object

Engine configuration for WiredTiger.

configSpec.
mongodbSpec_3_6.
mongocfg.
config.
storage.
wiredTiger.
engineConfig.
cacheSizeGb
number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

configSpec.
mongodbSpec_3_6.
mongocfg.
config.
operationProfiling
object

operationProfiling section of mongocfg configuration.

configSpec.
mongodbSpec_3_6.
mongocfg.
config.
operationProfiling.
mode
string
configSpec.
mongodbSpec_3_6.
mongocfg.
config.
operationProfiling.
slowOpThreshold
integer (int64)

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow.

Value must be greater than 0.

configSpec.
mongodbSpec_3_6.
mongocfg.
config.
net
object

net section of mongocfg configuration.

configSpec.
mongodbSpec_3_6.
mongocfg.
config.
net.
maxIncomingConnections
integer (int64)

The maximum number of incoming connections.

Acceptable values are 10 to 16384, inclusive.

configSpec.
mongodbSpec_3_6.
mongocfg.
resources
object

Resources allocated to mongocfg hosts.

configSpec.
mongodbSpec_3_6.
mongocfg.
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.
mongodbSpec_3_6.
mongocfg.
resources.
diskSize
string (int64)

Volume of the storage available to a host, in bytes.

configSpec.
mongodbSpec_3_6.
mongocfg.
resources.
diskTypeId
string

Type of the storage environment for the host. Possible values:

  • network-hdd — network HDD drive,
  • network-nvme — network SSD drive,
  • local-nvme — local SSD storage.
configSpec.
mongodbSpec_3_6.
mongos
object

Configuration and resource allocation for a mongos host.

configSpec.
mongodbSpec_3_6.
mongos.
config
object
configSpec.
mongodbSpec_3_6.
mongos.
config.
net
object
configSpec.
mongodbSpec_3_6.
mongos.
config.
net.
maxIncomingConnections
integer (int64)

The maximum number of incoming connections.

Acceptable values are 10 to 16384, inclusive.

configSpec.
mongodbSpec_3_6.
mongos.
resources
object

Resources allocated to mongos hosts.

configSpec.
mongodbSpec_3_6.
mongos.
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.
mongodbSpec_3_6.
mongos.
resources.
diskSize
string (int64)

Volume of the storage available to a host, in bytes.

configSpec.
mongodbSpec_3_6.
mongos.
resources.
diskTypeId
string

Type of the storage environment for the host. Possible values:

  • network-hdd — network HDD drive,
  • network-nvme — network SSD drive,
  • local-nvme — local SSD storage.
configSpec.
mongodbSpec_4_0
object
Configuration and resource allocation for a MongoDB 4.0 cluster.
configSpec includes only one of the fields mongodbSpec_3_6, mongodbSpec_4_0

configSpec.
mongodbSpec_4_0.
mongod
object
configSpec.
mongodbSpec_4_0.
mongod.
config
object

Configuration for a mongod 4.0 host.

Configuration of a mongod daemon. Supported options are a limited subset of all options described in MongoDB documentation.

configSpec.
mongodbSpec_4_0.
mongod.
config.
storage
object

storage section of mongod configuration.

configSpec.
mongodbSpec_4_0.
mongod.
config.
storage.
wiredTiger
object

Configuration of the WiredTiger storage engine.

Configuration of WiredTiger storage engine.

configSpec.
mongodbSpec_4_0.
mongod.
config.
storage.
wiredTiger.
engineConfig
object

Engine configuration for WiredTiger.

configSpec.
mongodbSpec_4_0.
mongod.
config.
storage.
wiredTiger.
engineConfig.
cacheSizeGb
number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

configSpec.
mongodbSpec_4_0.
mongod.
config.
storage.
wiredTiger.
collectionConfig
object

Collection configuration for WiredTiger.

configSpec.
mongodbSpec_4_0.
mongod.
config.
storage.
wiredTiger.
collectionConfig.
blockCompressor
string

Default type of compression to use for collection data.

  • NONE: No compression.
  • SNAPPY: The Snappy compression.
  • ZLIB: The zlib compression.
configSpec.
mongodbSpec_4_0.
mongod.
config.
storage.
journal
object

Configuration of the MongoDB journal.

configSpec.
mongodbSpec_4_0.
mongod.
config.
storage.
journal.
commitInterval
integer (int64)

Commit interval between journal operations, in milliseconds. Default: 100.

Acceptable values are 1 to 500, inclusive.

configSpec.
mongodbSpec_4_0.
mongod.
config.
operationProfiling
object

operationProfiling section of mongod configuration.

configSpec.
mongodbSpec_4_0.
mongod.
config.
operationProfiling.
mode
string

Mode which specifies operations that should be profiled.

  • OFF: The profiler is off and does not collect any data.
  • SLOW_OP: The profiler collects data for operations that take longer than the value of slowOpThreshold.
  • ALL: The profiler collects data for all operations.
configSpec.
mongodbSpec_4_0.
mongod.
config.
operationProfiling.
slowOpThreshold
integer (int64)

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow, and are processed by the profiler running in the SLOW_OP mode.

Value must be greater than 0.

configSpec.
mongodbSpec_4_0.
mongod.
config.
net
object

net section of mongod configuration.

configSpec.
mongodbSpec_4_0.
mongod.
config.
net.
maxIncomingConnections
integer (int64)

The maximum number of simultaneous connections that mongod will accept.

Acceptable values are 10 to 16384, inclusive.

configSpec.
mongodbSpec_4_0.
mongod.
resources
object

Resources allocated to mongod hosts.

configSpec.
mongodbSpec_4_0.
mongod.
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.
mongodbSpec_4_0.
mongod.
resources.
diskSize
string (int64)

Volume of the storage available to a host, in bytes.

configSpec.
mongodbSpec_4_0.
mongod.
resources.
diskTypeId
string

Type of the storage environment for the host. Possible values:

  • network-hdd — network HDD drive,
  • network-nvme — network SSD drive,
  • local-nvme — local SSD storage.
configSpec.
mongodbSpec_4_0.
mongocfg
object
configSpec.
mongodbSpec_4_0.
mongocfg.
config
object
configSpec.
mongodbSpec_4_0.
mongocfg.
config.
storage
object

storage section of mongocfg configuration.

configSpec.
mongodbSpec_4_0.
mongocfg.
config.
storage.
wiredTiger
object

Configuration of the WiredTiger storage engine.

Configuration of WiredTiger storage engine.

configSpec.
mongodbSpec_4_0.
mongocfg.
config.
storage.
wiredTiger.
engineConfig
object

Engine configuration for WiredTiger.

configSpec.
mongodbSpec_4_0.
mongocfg.
config.
storage.
wiredTiger.
engineConfig.
cacheSizeGb
number (double)

The maximum size of the internal cache that WiredTiger will use for all data.

configSpec.
mongodbSpec_4_0.
mongocfg.
config.
operationProfiling
object

operationProfiling section of mongocfg configuration.

configSpec.
mongodbSpec_4_0.
mongocfg.
config.
operationProfiling.
mode
string
configSpec.
mongodbSpec_4_0.
mongocfg.
config.
operationProfiling.
slowOpThreshold
integer (int64)

The slow operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered slow.

Value must be greater than 0.

configSpec.
mongodbSpec_4_0.
mongocfg.
config.
net
object

net section of mongocfg configuration.

configSpec.
mongodbSpec_4_0.
mongocfg.
config.
net.
maxIncomingConnections
integer (int64)

The maximum number of simultaneous connections that mongocfg will accept.

Acceptable values are 10 to 16384, inclusive.

configSpec.
mongodbSpec_4_0.
mongocfg.
resources
object

Resources allocated to mongocfg hosts.

configSpec.
mongodbSpec_4_0.
mongocfg.
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.
mongodbSpec_4_0.
mongocfg.
resources.
diskSize
string (int64)

Volume of the storage available to a host, in bytes.

configSpec.
mongodbSpec_4_0.
mongocfg.
resources.
diskTypeId
string

Type of the storage environment for the host. Possible values:

  • network-hdd — network HDD drive,
  • network-nvme — network SSD drive,
  • local-nvme — local SSD storage.
configSpec.
mongodbSpec_4_0.
mongos
object
configSpec.
mongodbSpec_4_0.
mongos.
config
object
configSpec.
mongodbSpec_4_0.
mongos.
config.
net
object
configSpec.
mongodbSpec_4_0.
mongos.
config.
net.
maxIncomingConnections
integer (int64)

The maximum number of simultaneous connections that mongos will accept.

Acceptable values are 10 to 16384, inclusive.

configSpec.
mongodbSpec_4_0.
mongos.
resources
object

Resources allocated to mongos hosts.

configSpec.
mongodbSpec_4_0.
mongos.
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.
mongodbSpec_4_0.
mongos.
resources.
diskSize
string (int64)

Volume of the storage available to a host, in bytes.

configSpec.
mongodbSpec_4_0.
mongos.
resources.
diskTypeId
string

Type of the storage environment for the host. Possible values:

  • network-hdd — network HDD drive,
  • network-nvme — network SSD drive,
  • local-nvme — local SSD storage.
hostSpecs[] object

Required. Configurations for MongoDB 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.

The maximum string length in characters is 50.

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 network ID is set in the Cluster.networkId field.

The maximum string length in characters is 50.

hostSpecs[].
assignPublicIp
boolean (boolean)

Whether the host should get a public IP address on creation.

After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with assignPublicIp set as needed.

Possible values:

  • false — don't assign a public IP to the host.
  • true — the host should have a public IP address.
hostSpecs[].
type
string

Type of the host to be deployed.

hostSpecs[].
shardName
string

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

networkId string

Required. Required. ID of the network to create the MongoDB 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.