Method update

Updates the specified MongoDB cluster.

HTTP request

PATCH https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/{clusterId}

Path parameters

Parameter Description
clusterId Required. ID of the MongoDB Cluster resource to update. To get the MongoDB cluster ID use a list request. The maximum string length in characters is 50.

Body parameters

{
  "updateMask": "string",
  "description": "string",
  "labels": "object",
  "configSpec": {
    "version": "string",
    "featureCompatibilityVersion": "string",
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },
    "access": {
      "dataLens": true
    },

    // `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`

  }
}
Field Description
updateMask string

Field mask that specifies which fields of the MongoDB Cluster resource should be updated.

A comma-separated names off ALL fields to be updated. Оnly the specified fields will be changed. The others will be left untouched. If the field is specified in updateMask and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.

description string

New description of the 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".

The new set of labels will completely replace the old ones. To add a label, request the current set with the get method, then send an update request with the new label added to the set.

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].

configSpec object

New configuration and resources for hosts in the cluster.

configSpec.
version
string

Version of MongoDB used in the cluster. Possible values:

  • 3.6
  • 4.0
configSpec.
featureCompatibilityVersion
string

MongoDB feature compatibility version. See usage details in MongoDB documentation.

Possible values:

  • 3.6 — persist data compatibility for version 3.6. After setting this option the data will not be compatible with 3.4 or older.
  • 4.0 — persist data compatibility for version 4.0. After setting this option the data will not be compatible with 3.6 or older.
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.
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 mongod 3.6 hosts.

configSpec.
mongodbSpec_3_6.
mongod.
config
object

Configuration for 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 each mongod host.

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-ssd — network SSD drive,
  • local-ssd — local SSD storage.
configSpec.
mongodbSpec_3_6.
mongocfg
object

Configuration and resource allocation for mongocfg 3.6 hosts.

configSpec.
mongodbSpec_3_6.
mongocfg.
config
object

Configuration for mongocfg 3.6 hosts.

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

Operation profiling level. For details, see MongoDB documentation.

  • OFF: The profiler is off and does not collect any data. This is the default profiler level.
  • 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.
mongocfg.
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. For details see MongoDB documentation.

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 each mongocfg host.

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-ssd — network SSD drive,
  • local-ssd — local SSD storage.
configSpec.
mongodbSpec_3_6.
mongos
object

Configuration and resource allocation for mongos 3.6 hosts.

configSpec.
mongodbSpec_3_6.
mongos.
config
object

Configuration for mongos 3.6 hosts.

configSpec.
mongodbSpec_3_6.
mongos.
config.
net
object

Network settings for mongos.

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 each mongos host.

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-ssd — network SSD drive,
  • local-ssd — 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

Configuration and resource allocation for mongod 4.0 hosts.

configSpec.
mongodbSpec_4_0.
mongod.
config
object

Configuration for mongod 4.0 hosts.

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 each mongod host.

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-ssd — network SSD drive,
  • local-ssd — local SSD storage.
configSpec.
mongodbSpec_4_0.
mongocfg
object

Configuration and resource allocation for mongocfg 4.0 hosts.

configSpec.
mongodbSpec_4_0.
mongocfg.
config
object

Configuration for mongocfg 4.0 hosts.

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

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.
mongocfg.
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. For details see MongoDB documentation.

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 each mongocfg host.

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-ssd — network SSD drive,
  • local-ssd — local SSD storage.
configSpec.
mongodbSpec_4_0.
mongos
object

Configuration and resource allocation for mongos 4.0 hosts.

configSpec.
mongodbSpec_4_0.
mongos.
config
object

Configuration for mongos 4.0 hosts.

configSpec.
mongodbSpec_4_0.
mongos.
config.
net
object

Network settings for mongos.

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 each mongos host.

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-ssd — network SSD drive,
  • local-ssd — local SSD storage.

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.