Method get

Returns the specified MongoDB Cluster resource.

To get the list of available MongoDB Cluster resources, make a list request.

HTTP request

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

Path parameters

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

Response

HTTP Code: 200 - OK

 {
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "monitoring": [
    {
      "name": "string",
      "description": "string",
      "link": "string"
    }
  ],
  "config": {
    "version": "string",
    "mongodb_3_6": {
      "mongod": {
        "config": {
          "effectiveConfig": {
            "storage": {
              "wiredTiger": {
                "engineConfig": {
                  "cacheSizeGb": "number"
                },
                "collectionConfig": {
                  "blockCompressor": "string"
                }
              },
              "journal": {
                "enabled": true,
                "commitInterval": "integer"
              }
            },
            "operationProfiling": {
              "mode": "string",
              "slowOpThreshold": "integer"
            },
            "net": {
              "maxIncomingConnections": "integer"
            }
          },
          "userConfig": {
            "storage": {
              "wiredTiger": {
                "engineConfig": {
                  "cacheSizeGb": "number"
                },
                "collectionConfig": {
                  "blockCompressor": "string"
                }
              },
              "journal": {
                "enabled": true,
                "commitInterval": "integer"
              }
            },
            "operationProfiling": {
              "mode": "string",
              "slowOpThreshold": "integer"
            },
            "net": {
              "maxIncomingConnections": "integer"
            }
          },
          "defaultConfig": {
            "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"
        }
      }
    }
  },
  "networkId": "string",
  "health": "string",
  "status": "string"
}

A MongoDB Cluster resource. For more information, see the Cluster section in the Developer's Guide.

Field Description
id string

ID of the MongoDB cluster. This ID is assigned by MDB at creation time.

folderId string

ID of the folder that the MongoDB cluster belongs to.

createdAt string (date-time)

Creation timestamp in RFC3339 text format.

String in RFC3339 text format.

name string

Name of the MongoDB cluster. The name is unique within the folder. 1-63 characters long.

description string

Description of the MongoDB cluster. 0-256 characters long.

labels object

Custom labels for the MongoDB cluster as key:value pairs. Maximum 64 per resource.

environment string

Deployment environment of the 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.
monitoring[] object

Monitoring system.

monitoring[].
name
string

Name of the monitoring system.

monitoring[].
description
string

Description of the monitoring system.

monitoring[].
link
string

Link to the monitoring system charts for the MongoDB cluster.

config object

Configuration of the MongoDB cluster.

config.
version
string

Version of MongoDB server software.

config.
mongodb_3_6
object
config.
mongodb_3_6.
mongod
object

Configuration and resource allocation for a MongoDB 3.6 cluster.

config.
mongodb_3_6.
mongod.
config
object

Configuration of a MongoDB 3.6 server.

config.
mongodb_3_6.
mongod.
config.
effectiveConfig
object

Effective settings for a MongoDB 3.6 cluster (a combination of settings defined in userConfig and [default_config]).

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

config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
storage
object

storage section of mongod configuration.

config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
storage.
wiredTiger
object

Configuration of the WiredTiger storage engine.

Configuration of WiredTiger storage engine.

config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
storage.
wiredTiger.
engineConfig
object

Engine configuration for WiredTiger.

config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
storage.
wiredTiger.
engineConfig.
cacheSizeGb
number (double)

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

config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
storage.
wiredTiger.
collectionConfig
object

Collection configuration for WiredTiger.

config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
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.
config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
storage.
journal
object

Configuration of the MongoDB journal.

config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
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.
config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
storage.
journal.
commitInterval
integer (int64)

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

Acceptable values are 1 to 500, inclusive.

config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
operationProfiling
object

operationProfiling section of mongod configuration.

config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
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.
config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
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.

config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
net
object

net section of mongod configuration.

config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
net.
maxIncomingConnections
integer (int64)

The maximum number of simultaneous connections that mongod will accept.

Acceptable values are 10 to 16384, inclusive.

config.
mongodb_3_6.
mongod.
config.
userConfig
object

User-defined settings for a MongoDB 3.6 cluster.

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

config.
mongodb_3_6.
mongod.
config.
userConfig.
storage
object

storage section of mongod configuration.

config.
mongodb_3_6.
mongod.
config.
userConfig.
storage.
wiredTiger
object

Configuration of the WiredTiger storage engine.

Configuration of WiredTiger storage engine.

config.
mongodb_3_6.
mongod.
config.
userConfig.
storage.
wiredTiger.
engineConfig
object

Engine configuration for WiredTiger.

config.
mongodb_3_6.
mongod.
config.
userConfig.
storage.
wiredTiger.
engineConfig.
cacheSizeGb
number (double)

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

config.
mongodb_3_6.
mongod.
config.
userConfig.
storage.
wiredTiger.
collectionConfig
object

Collection configuration for WiredTiger.

config.
mongodb_3_6.
mongod.
config.
userConfig.
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.
config.
mongodb_3_6.
mongod.
config.
userConfig.
storage.
journal
object

Configuration of the MongoDB journal.

config.
mongodb_3_6.
mongod.
config.
userConfig.
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.
config.
mongodb_3_6.
mongod.
config.
userConfig.
storage.
journal.
commitInterval
integer (int64)

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

Acceptable values are 1 to 500, inclusive.

config.
mongodb_3_6.
mongod.
config.
userConfig.
operationProfiling
object

operationProfiling section of mongod configuration.

config.
mongodb_3_6.
mongod.
config.
userConfig.
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.
config.
mongodb_3_6.
mongod.
config.
userConfig.
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.

config.
mongodb_3_6.
mongod.
config.
userConfig.
net
object

net section of mongod configuration.

config.
mongodb_3_6.
mongod.
config.
userConfig.
net.
maxIncomingConnections
integer (int64)

The maximum number of simultaneous connections that mongod will accept.

Acceptable values are 10 to 16384, inclusive.

config.
mongodb_3_6.
mongod.
config.
defaultConfig
object

Default configuration for a MongoDB 3.6 cluster.

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

config.
mongodb_3_6.
mongod.
config.
defaultConfig.
storage
object

storage section of mongod configuration.

config.
mongodb_3_6.
mongod.
config.
defaultConfig.
storage.
wiredTiger
object

Configuration of the WiredTiger storage engine.

Configuration of WiredTiger storage engine.

config.
mongodb_3_6.
mongod.
config.
defaultConfig.
storage.
wiredTiger.
engineConfig
object

Engine configuration for WiredTiger.

config.
mongodb_3_6.
mongod.
config.
defaultConfig.
storage.
wiredTiger.
engineConfig.
cacheSizeGb
number (double)

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

config.
mongodb_3_6.
mongod.
config.
defaultConfig.
storage.
wiredTiger.
collectionConfig
object

Collection configuration for WiredTiger.

config.
mongodb_3_6.
mongod.
config.
defaultConfig.
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.
config.
mongodb_3_6.
mongod.
config.
defaultConfig.
storage.
journal
object

Configuration of the MongoDB journal.

config.
mongodb_3_6.
mongod.
config.
defaultConfig.
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.
config.
mongodb_3_6.
mongod.
config.
defaultConfig.
storage.
journal.
commitInterval
integer (int64)

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

Acceptable values are 1 to 500, inclusive.

config.
mongodb_3_6.
mongod.
config.
defaultConfig.
operationProfiling
object

operationProfiling section of mongod configuration.

config.
mongodb_3_6.
mongod.
config.
defaultConfig.
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.
config.
mongodb_3_6.
mongod.
config.
defaultConfig.
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.

config.
mongodb_3_6.
mongod.
config.
defaultConfig.
net
object

net section of mongod configuration.

config.
mongodb_3_6.
mongod.
config.
defaultConfig.
net.
maxIncomingConnections
integer (int64)

The maximum number of simultaneous connections that mongod will accept.

Acceptable values are 10 to 16384, inclusive.

config.
mongodb_3_6.
mongod.
resources
object

Resources allocated to MongoDB hosts.

config.
mongodb_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.

config.
mongodb_3_6.
mongod.
resources.
diskSize
string (int64)

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

config.
mongodb_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.
networkId string

ID of the network that the cluster belongs to.

health string

Aggregated cluster health.

  • HEALTH_UNKNOWN: State of the cluster is unknown ([Host.health] for every host in the cluster is UNKNOWN).
  • ALIVE: Cluster is alive and well ([Host.health] for every host in the cluster is ALIVE).
  • DEAD: Cluster is inoperable ([Host.health] for every host in the cluster is DEAD).
  • DEGRADED: Cluster is working below capacity ([Host.health] for at least one host in the cluster is not ALIVE).
status string

Current state of the cluster.

  • STATUS_UNKNOWN: Cluster state is unknown.
  • CREATING: Cluster is being created.
  • RUNNING: Cluster is running normally.
  • ERROR: Cluster encountered a problem and cannot operate.
  • UPDATING: Cluster is being updated.
  • STOPPING: Cluster is stopping.
  • STOPPED: Cluster stopped.
  • STARTING: Cluster is starting.