Cluster

Набор методов для управления ресурсами Cluster для MongoDB.

JSON-представление

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "monitoring": [
    {
      "name": "string",
      "description": "string",
      "link": "string"
    }
  ],
  "config": {
    "version": "string",
    "featureCompatibilityVersion": "string",
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },

    // `config` включает только одно из полей `mongodb_3_6`, `mongodb_4_0`
    "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"
        }
      },
      "mongocfg": {
        "config": {
          "effectiveConfig": {
            "storage": {
              "wiredTiger": {
                "engineConfig": {
                  "cacheSizeGb": "number"
                }
              }
            },
            "operationProfiling": {
              "mode": "string",
              "slowOpThreshold": "integer"
            },
            "net": {
              "maxIncomingConnections": "integer"
            }
          },
          "userConfig": {
            "storage": {
              "wiredTiger": {
                "engineConfig": {
                  "cacheSizeGb": "number"
                }
              }
            },
            "operationProfiling": {
              "mode": "string",
              "slowOpThreshold": "integer"
            },
            "net": {
              "maxIncomingConnections": "integer"
            }
          },
          "defaultConfig": {
            "storage": {
              "wiredTiger": {
                "engineConfig": {
                  "cacheSizeGb": "number"
                }
              }
            },
            "operationProfiling": {
              "mode": "string",
              "slowOpThreshold": "integer"
            },
            "net": {
              "maxIncomingConnections": "integer"
            }
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      },
      "mongos": {
        "config": {
          "effectiveConfig": {
            "net": {
              "maxIncomingConnections": "integer"
            }
          },
          "userConfig": {
            "net": {
              "maxIncomingConnections": "integer"
            }
          },
          "defaultConfig": {
            "net": {
              "maxIncomingConnections": "integer"
            }
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      }
    },
    "mongodb_4_0": {
      "mongod": {
        "config": {
          "effectiveConfig": {
            "storage": {
              "wiredTiger": {
                "engineConfig": {
                  "cacheSizeGb": "number"
                },
                "collectionConfig": {
                  "blockCompressor": "string"
                }
              },
              "journal": {
                "commitInterval": "integer"
              }
            },
            "operationProfiling": {
              "mode": "string",
              "slowOpThreshold": "integer"
            },
            "net": {
              "maxIncomingConnections": "integer"
            }
          },
          "userConfig": {
            "storage": {
              "wiredTiger": {
                "engineConfig": {
                  "cacheSizeGb": "number"
                },
                "collectionConfig": {
                  "blockCompressor": "string"
                }
              },
              "journal": {
                "commitInterval": "integer"
              }
            },
            "operationProfiling": {
              "mode": "string",
              "slowOpThreshold": "integer"
            },
            "net": {
              "maxIncomingConnections": "integer"
            }
          },
          "defaultConfig": {
            "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": {
          "effectiveConfig": {
            "storage": {
              "wiredTiger": {
                "engineConfig": {
                  "cacheSizeGb": "number"
                }
              }
            },
            "operationProfiling": {
              "mode": "string",
              "slowOpThreshold": "integer"
            },
            "net": {
              "maxIncomingConnections": "integer"
            }
          },
          "userConfig": {
            "storage": {
              "wiredTiger": {
                "engineConfig": {
                  "cacheSizeGb": "number"
                }
              }
            },
            "operationProfiling": {
              "mode": "string",
              "slowOpThreshold": "integer"
            },
            "net": {
              "maxIncomingConnections": "integer"
            }
          },
          "defaultConfig": {
            "storage": {
              "wiredTiger": {
                "engineConfig": {
                  "cacheSizeGb": "number"
                }
              }
            },
            "operationProfiling": {
              "mode": "string",
              "slowOpThreshold": "integer"
            },
            "net": {
              "maxIncomingConnections": "integer"
            }
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      },
      "mongos": {
        "config": {
          "effectiveConfig": {
            "net": {
              "maxIncomingConnections": "integer"
            }
          },
          "userConfig": {
            "net": {
              "maxIncomingConnections": "integer"
            }
          },
          "defaultConfig": {
            "net": {
              "maxIncomingConnections": "integer"
            }
          }
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      }
    },
    // конец списка возможных полей`config`

  },
  "networkId": "string",
  "health": "string",
  "status": "string",
  "sharded": true
}
Поле Описание
id string

Идентификатор кластера MongoDB. Этот идентификатор генерирует MDB при создании.

folderId string

Идентификатор каталога, которому принадлежит кластер MongoDB.

createdAt string (date-time)

Время создания в формате RFC3339 .

Строка в формате RFC3339.

name string

Имя кластера MongoDB. Имя уникально в рамках каталога. Длина 1-63 символов.

description string

Описание кластера MongoDB. Длина описания должна быть от 0 до 256 символов.

labels object

Пользовательские метки для кластера MongoDB как пары key:value. Максимум 64 на ресурс.

environment string

Среда развертывания кластера MongoDB.

Среда развертывания.

  • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
  • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
monitoring[] object

Система мониторинга.

monitoring[].
name
string

Название системы мониторинга.

monitoring[].
description
string

Описание системы мониторинга.

monitoring[].
link
string

Ссылка на графики системы мониторинга для данного кластера MongoDB.

config object

Конфигурация кластера MongoDB.

config.
version
string

Версия серверного программного обеспечения MongoDB.

config.
featureCompatibilityVersion
string

Функционально совместимая версия MongoDB.

config.
backupWindowStart
object

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.

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

config.
backupWindowStart.
minutes
integer (int32)

Minutes of hour of day. Must be from 0 to 59.

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

config.
backupWindowStart.
nanos
integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

config.
mongodb_3_6
object
config включает только одно из полей mongodb_3_6, mongodb_4_0

config.
mongodb_3_6.
mongod
object

Конфигурация и распределение ресурсов для кластера MongoDB 3.6.

config.
mongodb_3_6.
mongod.
config
object

Конфигурация для хостов mongod 3.6.

config.
mongodb_3_6.
mongod.
config.
effectiveConfig
object

Действующие параметры для кластера MongoDB 3.6 (сочетание параметров, определенных в userConfig и [default_config]).

Конфигурация демона mongod. Поддерживаемые опции являются ограниченным подмножеством всех опций, описанных в 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

Конфигурация механизма хранения WiredTiger.

Конфигурация механизма хранения WiredTiger.

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

Конфигурация для механизма хранения WiredTiger.

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

Максимальный размер внутреннего кэша, который WiredTiger будет использовать для всех данных.

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

Конфигурация коллекций для механизма хранения WiredTiger.

config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
storage.
wiredTiger.
collectionConfig.
blockCompressor
string

Тип сжатия по умолчанию, который следует использовать для данных коллекции.

  • NONE: Без сжатия.
  • SNAPPY: Сжатие Snappy.
  • ZLIB: Сжатие zlib.
config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
storage.
journal
object

Конфигурация journal MongoDB.

config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
storage.
journal.
enabled
boolean (boolean)

Включен ли журнал. Возможные значения:

  • true (по умолчанию) — журнал включен.
  • false — журнал отключен.
config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
storage.
journal.
commitInterval
integer (int64)

Максимальный интервал между операциями в журнале, в миллисекундах. По умолчанию: 100.

Допустимые значения — от 1 до 500 включительно.

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

operationProfiling section of mongod configuration.

config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
operationProfiling.
mode
string

Режим, который определяет критерии для профилирования операций.

  • OFF: Профайлер выключен и не собирает никакие данные.
  • SLOW_OP: Профайлер собирает данные для операций, которые производятся дольше, чем значение slowOpThreshold.
  • ALL: Профайлер собирает данные для всех операций.
config.
mongodb_3_6.
mongod.
config.
effectiveConfig.
operationProfiling.
slowOpThreshold
integer (int64)

Порог времени для медленных операций, в миллисекундах. Операции, которые выполняются дольше этого порога, считаются медленными и обрабатываются профайлером, работающим в режиме SLOW_OP.

Значение должно быть больше 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)

Максимальное количество одновременных подключений, которые принимает mongod.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_3_6.
mongod.
config.
userConfig
object

Пользовательские настройки для кластера MongoDB 3.6.

Конфигурация демона mongod. Поддерживаемые опции являются ограниченным подмножеством всех опций, описанных в 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

Конфигурация механизма хранения WiredTiger.

Конфигурация механизма хранения WiredTiger.

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

Конфигурация для механизма хранения WiredTiger.

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

Максимальный размер внутреннего кэша, который WiredTiger будет использовать для всех данных.

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

Конфигурация коллекций для механизма хранения WiredTiger.

config.
mongodb_3_6.
mongod.
config.
userConfig.
storage.
wiredTiger.
collectionConfig.
blockCompressor
string

Тип сжатия по умолчанию, который следует использовать для данных коллекции.

  • NONE: Без сжатия.
  • SNAPPY: Сжатие Snappy.
  • ZLIB: Сжатие zlib.
config.
mongodb_3_6.
mongod.
config.
userConfig.
storage.
journal
object

Конфигурация journal MongoDB.

config.
mongodb_3_6.
mongod.
config.
userConfig.
storage.
journal.
enabled
boolean (boolean)

Включен ли журнал. Возможные значения:

  • true (по умолчанию) — журнал включен.
  • false — журнал отключен.
config.
mongodb_3_6.
mongod.
config.
userConfig.
storage.
journal.
commitInterval
integer (int64)

Максимальный интервал между операциями в журнале, в миллисекундах. По умолчанию: 100.

Допустимые значения — от 1 до 500 включительно.

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

operationProfiling section of mongod configuration.

config.
mongodb_3_6.
mongod.
config.
userConfig.
operationProfiling.
mode
string

Режим, который определяет критерии для профилирования операций.

  • OFF: Профайлер выключен и не собирает никакие данные.
  • SLOW_OP: Профайлер собирает данные для операций, которые производятся дольше, чем значение slowOpThreshold.
  • ALL: Профайлер собирает данные для всех операций.
config.
mongodb_3_6.
mongod.
config.
userConfig.
operationProfiling.
slowOpThreshold
integer (int64)

Порог времени для медленных операций, в миллисекундах. Операции, которые выполняются дольше этого порога, считаются медленными и обрабатываются профайлером, работающим в режиме SLOW_OP.

Значение должно быть больше 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)

Максимальное количество одновременных подключений, которые принимает mongod.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_3_6.
mongod.
config.
defaultConfig
object

Конфигурация по умолчанию для кластера MongoDB 3.6.

Конфигурация демона mongod. Поддерживаемые опции являются ограниченным подмножеством всех опций, описанных в 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

Конфигурация механизма хранения WiredTiger.

Конфигурация механизма хранения WiredTiger.

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

Конфигурация для механизма хранения WiredTiger.

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

Максимальный размер внутреннего кэша, который WiredTiger будет использовать для всех данных.

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

Конфигурация коллекций для механизма хранения WiredTiger.

config.
mongodb_3_6.
mongod.
config.
defaultConfig.
storage.
wiredTiger.
collectionConfig.
blockCompressor
string

Тип сжатия по умолчанию, который следует использовать для данных коллекции.

  • NONE: Без сжатия.
  • SNAPPY: Сжатие Snappy.
  • ZLIB: Сжатие zlib.
config.
mongodb_3_6.
mongod.
config.
defaultConfig.
storage.
journal
object

Конфигурация journal MongoDB.

config.
mongodb_3_6.
mongod.
config.
defaultConfig.
storage.
journal.
enabled
boolean (boolean)

Включен ли журнал. Возможные значения:

  • true (по умолчанию) — журнал включен.
  • false — журнал отключен.
config.
mongodb_3_6.
mongod.
config.
defaultConfig.
storage.
journal.
commitInterval
integer (int64)

Максимальный интервал между операциями в журнале, в миллисекундах. По умолчанию: 100.

Допустимые значения — от 1 до 500 включительно.

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

operationProfiling section of mongod configuration.

config.
mongodb_3_6.
mongod.
config.
defaultConfig.
operationProfiling.
mode
string

Режим, который определяет критерии для профилирования операций.

  • OFF: Профайлер выключен и не собирает никакие данные.
  • SLOW_OP: Профайлер собирает данные для операций, которые производятся дольше, чем значение slowOpThreshold.
  • ALL: Профайлер собирает данные для всех операций.
config.
mongodb_3_6.
mongod.
config.
defaultConfig.
operationProfiling.
slowOpThreshold
integer (int64)

Порог времени для медленных операций, в миллисекундах. Операции, которые выполняются дольше этого порога, считаются медленными и обрабатываются профайлером, работающим в режиме SLOW_OP.

Значение должно быть больше 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)

Максимальное количество одновременных подключений, которые принимает mongod.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_3_6.
mongod.
resources
object

Ресурсы, выделенные хостам MongoDB.

config.
mongodb_3_6.
mongod.
resources.
resourcePresetId
string

Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в documentation.

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

Объем хранилища, доступного хосту, в байтах.

config.
mongodb_3_6.
mongod.
resources.
diskTypeId
string

Тип хранилища для хоста. Возможные значения:

  • network-hdd — сетевой HDD-диск;
  • network-nvme — сетевой SSD-диск;
  • local-nvme — локальное SSD-хранилище.
config.
mongodb_3_6.
mongocfg
object
config.
mongodb_3_6.
mongocfg.
config
object
config.
mongodb_3_6.
mongocfg.
config.
effectiveConfig
object

Действующие параметры для кластера MongoDB 3.6 (сочетание параметров, определенных в userConfig и [default_config]).

config.
mongodb_3_6.
mongocfg.
config.
effectiveConfig.
storage
object

storage section of mongocfg configuration.

config.
mongodb_3_6.
mongocfg.
config.
effectiveConfig.
storage.
wiredTiger
object

Конфигурация механизма хранения WiredTiger.

Конфигурация механизма хранения WiredTiger.

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

Конфигурация для механизма хранения WiredTiger.

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

Максимальный размер внутреннего кэша, который WiredTiger будет использовать для всех данных.

config.
mongodb_3_6.
mongocfg.
config.
effectiveConfig.
operationProfiling
object

operationProfiling section of mongocfg configuration.

config.
mongodb_3_6.
mongocfg.
config.
effectiveConfig.
operationProfiling.
mode
string
config.
mongodb_3_6.
mongocfg.
config.
effectiveConfig.
operationProfiling.
slowOpThreshold
integer (int64)

Порог времени для медленных операций, в миллисекундах. Операции, которые выполняются дольше этого порогового значения, считаются медленными.

Значение должно быть больше 0.

config.
mongodb_3_6.
mongocfg.
config.
effectiveConfig.
net
object

net section of mongocfg configuration.

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

Максимальное количество входящих подключений.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_3_6.
mongocfg.
config.
userConfig
object

Пользовательские настройки для кластера MongoDB 3.6.

config.
mongodb_3_6.
mongocfg.
config.
userConfig.
storage
object

storage section of mongocfg configuration.

config.
mongodb_3_6.
mongocfg.
config.
userConfig.
storage.
wiredTiger
object

Конфигурация механизма хранения WiredTiger.

Конфигурация механизма хранения WiredTiger.

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

Конфигурация для механизма хранения WiredTiger.

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

Максимальный размер внутреннего кэша, который WiredTiger будет использовать для всех данных.

config.
mongodb_3_6.
mongocfg.
config.
userConfig.
operationProfiling
object

operationProfiling section of mongocfg configuration.

config.
mongodb_3_6.
mongocfg.
config.
userConfig.
operationProfiling.
mode
string
config.
mongodb_3_6.
mongocfg.
config.
userConfig.
operationProfiling.
slowOpThreshold
integer (int64)

Порог времени для медленных операций, в миллисекундах. Операции, которые выполняются дольше этого порогового значения, считаются медленными.

Значение должно быть больше 0.

config.
mongodb_3_6.
mongocfg.
config.
userConfig.
net
object

net section of mongocfg configuration.

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

Максимальное количество входящих подключений.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_3_6.
mongocfg.
config.
defaultConfig
object
config.
mongodb_3_6.
mongocfg.
config.
defaultConfig.
storage
object

storage section of mongocfg configuration.

config.
mongodb_3_6.
mongocfg.
config.
defaultConfig.
storage.
wiredTiger
object

Конфигурация механизма хранения WiredTiger.

Конфигурация механизма хранения WiredTiger.

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

Конфигурация для механизма хранения WiredTiger.

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

Максимальный размер внутреннего кэша, который WiredTiger будет использовать для всех данных.

config.
mongodb_3_6.
mongocfg.
config.
defaultConfig.
operationProfiling
object

operationProfiling section of mongocfg configuration.

config.
mongodb_3_6.
mongocfg.
config.
defaultConfig.
operationProfiling.
mode
string
config.
mongodb_3_6.
mongocfg.
config.
defaultConfig.
operationProfiling.
slowOpThreshold
integer (int64)

Порог времени для медленных операций, в миллисекундах. Операции, которые выполняются дольше этого порогового значения, считаются медленными.

Значение должно быть больше 0.

config.
mongodb_3_6.
mongocfg.
config.
defaultConfig.
net
object

net section of mongocfg configuration.

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

Максимальное количество входящих подключений.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_3_6.
mongocfg.
resources
object

Ресурсы, выделенные хостам mongocfg.

config.
mongodb_3_6.
mongocfg.
resources.
resourcePresetId
string

Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в documentation.

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

Объем хранилища, доступного хосту, в байтах.

config.
mongodb_3_6.
mongocfg.
resources.
diskTypeId
string

Тип хранилища для хоста. Возможные значения:

  • network-hdd — сетевой HDD-диск;
  • network-nvme — сетевой SSD-диск;
  • local-nvme — локальное SSD-хранилище.
config.
mongodb_3_6.
mongos
object
config.
mongodb_3_6.
mongos.
config
object
config.
mongodb_3_6.
mongos.
config.
effectiveConfig
object

Действующие параметры для кластера MongoDB 3.6 (сочетание параметров, определенных в userConfig и [default_config]).

config.
mongodb_3_6.
mongos.
config.
effectiveConfig.
net
object
config.
mongodb_3_6.
mongos.
config.
effectiveConfig.
net.
maxIncomingConnections
integer (int64)

Максимальное количество входящих подключений.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_3_6.
mongos.
config.
userConfig
object

Пользовательские настройки для кластера MongoDB 3.6.

config.
mongodb_3_6.
mongos.
config.
userConfig.
net
object
config.
mongodb_3_6.
mongos.
config.
userConfig.
net.
maxIncomingConnections
integer (int64)

Максимальное количество входящих подключений.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_3_6.
mongos.
config.
defaultConfig
object

Конфигурация по умолчанию для кластера MongoDB 3.6.

config.
mongodb_3_6.
mongos.
config.
defaultConfig.
net
object
config.
mongodb_3_6.
mongos.
config.
defaultConfig.
net.
maxIncomingConnections
integer (int64)

Максимальное количество входящих подключений.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_3_6.
mongos.
resources
object

Ресурсы, выделенные хостам mongocfg.

config.
mongodb_3_6.
mongos.
resources.
resourcePresetId
string

Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в documentation.

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

Объем хранилища, доступного хосту, в байтах.

config.
mongodb_3_6.
mongos.
resources.
diskTypeId
string

Тип хранилища для хоста. Возможные значения:

  • network-hdd — сетевой HDD-диск;
  • network-nvme — сетевой SSD-диск;
  • local-nvme — локальное SSD-хранилище.
config.
mongodb_4_0
object
config включает только одно из полей mongodb_3_6, mongodb_4_0

config.
mongodb_4_0.
mongod
object

Конфигурация и распределение ресурсов для кластера MongoDB 4.0.

config.
mongodb_4_0.
mongod.
config
object

Конфигурация для хостов mongod 4.0.

config.
mongodb_4_0.
mongod.
config.
effectiveConfig
object

Действующие параметры для кластера MongoDB 4.0 (сочетание параметров, определенных в userConfig и [default_config]).

Конфигурация демона mongod. Поддерживаемые опции являются ограниченным подмножеством всех опций, описанных в MongoDB documentation.

config.
mongodb_4_0.
mongod.
config.
effectiveConfig.
storage
object

storage section of mongod configuration.

config.
mongodb_4_0.
mongod.
config.
effectiveConfig.
storage.
wiredTiger
object

Конфигурация механизма хранения WiredTiger.

Конфигурация механизма хранения WiredTiger.

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

Конфигурация для механизма хранения WiredTiger.

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

Максимальный размер внутреннего кэша, который WiredTiger будет использовать для всех данных.

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

Конфигурация коллекций для механизма хранения WiredTiger.

config.
mongodb_4_0.
mongod.
config.
effectiveConfig.
storage.
wiredTiger.
collectionConfig.
blockCompressor
string

Тип сжатия по умолчанию, который следует использовать для данных коллекции.

  • NONE: Без сжатия.
  • SNAPPY: Сжатие Snappy.
  • ZLIB: Сжатие zlib.
config.
mongodb_4_0.
mongod.
config.
effectiveConfig.
storage.
journal
object

Конфигурация journal MongoDB.

config.
mongodb_4_0.
mongod.
config.
effectiveConfig.
storage.
journal.
commitInterval
integer (int64)

Максимальный интервал между операциями в журнале, в миллисекундах. По умолчанию: 100.

Допустимые значения — от 1 до 500 включительно.

config.
mongodb_4_0.
mongod.
config.
effectiveConfig.
operationProfiling
object

operationProfiling section of mongod configuration.

config.
mongodb_4_0.
mongod.
config.
effectiveConfig.
operationProfiling.
mode
string

Режим, который определяет критерии для профилирования операций.

  • OFF: Профайлер выключен и не собирает никакие данные.
  • SLOW_OP: Профайлер собирает данные для операций, которые производятся дольше, чем значение slowOpThreshold.
  • ALL: Профайлер собирает данные для всех операций.
config.
mongodb_4_0.
mongod.
config.
effectiveConfig.
operationProfiling.
slowOpThreshold
integer (int64)

Порог времени для медленных операций, в миллисекундах. Операции, которые выполняются дольше этого порога, считаются медленными и обрабатываются профайлером, работающим в режиме SLOW_OP.

Значение должно быть больше 0.

config.
mongodb_4_0.
mongod.
config.
effectiveConfig.
net
object

net section of mongod configuration.

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

Максимальное количество одновременных подключений, которые принимает mongod.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_4_0.
mongod.
config.
userConfig
object

Пользовательские настройки для кластера MongoDB 4.0.

Конфигурация демона mongod. Поддерживаемые опции являются ограниченным подмножеством всех опций, описанных в MongoDB documentation.

config.
mongodb_4_0.
mongod.
config.
userConfig.
storage
object

storage section of mongod configuration.

config.
mongodb_4_0.
mongod.
config.
userConfig.
storage.
wiredTiger
object

Конфигурация механизма хранения WiredTiger.

Конфигурация механизма хранения WiredTiger.

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

Конфигурация для механизма хранения WiredTiger.

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

Максимальный размер внутреннего кэша, который WiredTiger будет использовать для всех данных.

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

Конфигурация коллекций для механизма хранения WiredTiger.

config.
mongodb_4_0.
mongod.
config.
userConfig.
storage.
wiredTiger.
collectionConfig.
blockCompressor
string

Тип сжатия по умолчанию, который следует использовать для данных коллекции.

  • NONE: Без сжатия.
  • SNAPPY: Сжатие Snappy.
  • ZLIB: Сжатие zlib.
config.
mongodb_4_0.
mongod.
config.
userConfig.
storage.
journal
object

Конфигурация journal MongoDB.

config.
mongodb_4_0.
mongod.
config.
userConfig.
storage.
journal.
commitInterval
integer (int64)

Максимальный интервал между операциями в журнале, в миллисекундах. По умолчанию: 100.

Допустимые значения — от 1 до 500 включительно.

config.
mongodb_4_0.
mongod.
config.
userConfig.
operationProfiling
object

operationProfiling section of mongod configuration.

config.
mongodb_4_0.
mongod.
config.
userConfig.
operationProfiling.
mode
string

Режим, который определяет критерии для профилирования операций.

  • OFF: Профайлер выключен и не собирает никакие данные.
  • SLOW_OP: Профайлер собирает данные для операций, которые производятся дольше, чем значение slowOpThreshold.
  • ALL: Профайлер собирает данные для всех операций.
config.
mongodb_4_0.
mongod.
config.
userConfig.
operationProfiling.
slowOpThreshold
integer (int64)

Порог времени для медленных операций, в миллисекундах. Операции, которые выполняются дольше этого порога, считаются медленными и обрабатываются профайлером, работающим в режиме SLOW_OP.

Значение должно быть больше 0.

config.
mongodb_4_0.
mongod.
config.
userConfig.
net
object

net section of mongod configuration.

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

Максимальное количество одновременных подключений, которые принимает mongod.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_4_0.
mongod.
config.
defaultConfig
object

Конфигурация по умолчанию для кластера MongoDB 4.0.

Конфигурация демона mongod. Поддерживаемые опции являются ограниченным подмножеством всех опций, описанных в MongoDB documentation.

config.
mongodb_4_0.
mongod.
config.
defaultConfig.
storage
object

storage section of mongod configuration.

config.
mongodb_4_0.
mongod.
config.
defaultConfig.
storage.
wiredTiger
object

Конфигурация механизма хранения WiredTiger.

Конфигурация механизма хранения WiredTiger.

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

Конфигурация для механизма хранения WiredTiger.

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

Максимальный размер внутреннего кэша, который WiredTiger будет использовать для всех данных.

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

Конфигурация коллекций для механизма хранения WiredTiger.

config.
mongodb_4_0.
mongod.
config.
defaultConfig.
storage.
wiredTiger.
collectionConfig.
blockCompressor
string

Тип сжатия по умолчанию, который следует использовать для данных коллекции.

  • NONE: Без сжатия.
  • SNAPPY: Сжатие Snappy.
  • ZLIB: Сжатие zlib.
config.
mongodb_4_0.
mongod.
config.
defaultConfig.
storage.
journal
object

Конфигурация journal MongoDB.

config.
mongodb_4_0.
mongod.
config.
defaultConfig.
storage.
journal.
commitInterval
integer (int64)

Максимальный интервал между операциями в журнале, в миллисекундах. По умолчанию: 100.

Допустимые значения — от 1 до 500 включительно.

config.
mongodb_4_0.
mongod.
config.
defaultConfig.
operationProfiling
object

operationProfiling section of mongod configuration.

config.
mongodb_4_0.
mongod.
config.
defaultConfig.
operationProfiling.
mode
string

Режим, который определяет критерии для профилирования операций.

  • OFF: Профайлер выключен и не собирает никакие данные.
  • SLOW_OP: Профайлер собирает данные для операций, которые производятся дольше, чем значение slowOpThreshold.
  • ALL: Профайлер собирает данные для всех операций.
config.
mongodb_4_0.
mongod.
config.
defaultConfig.
operationProfiling.
slowOpThreshold
integer (int64)

Порог времени для медленных операций, в миллисекундах. Операции, которые выполняются дольше этого порога, считаются медленными и обрабатываются профайлером, работающим в режиме SLOW_OP.

Значение должно быть больше 0.

config.
mongodb_4_0.
mongod.
config.
defaultConfig.
net
object

net section of mongod configuration.

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

Максимальное количество одновременных подключений, которые принимает mongod.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_4_0.
mongod.
resources
object

Ресурсы, выделенные хостам mongod.

config.
mongodb_4_0.
mongod.
resources.
resourcePresetId
string

Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в documentation.

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

Объем хранилища, доступного хосту, в байтах.

config.
mongodb_4_0.
mongod.
resources.
diskTypeId
string

Тип хранилища для хоста. Возможные значения:

  • network-hdd — сетевой HDD-диск;
  • network-nvme — сетевой SSD-диск;
  • local-nvme — локальное SSD-хранилище.
config.
mongodb_4_0.
mongocfg
object
config.
mongodb_4_0.
mongocfg.
config
object
config.
mongodb_4_0.
mongocfg.
config.
effectiveConfig
object

Действующие параметры для кластера MongoDB 4.0 (сочетание параметров, определенных в userConfig и [default_config]).

config.
mongodb_4_0.
mongocfg.
config.
effectiveConfig.
storage
object

storage section of mongocfg configuration.

config.
mongodb_4_0.
mongocfg.
config.
effectiveConfig.
storage.
wiredTiger
object

Конфигурация механизма хранения WiredTiger.

Конфигурация механизма хранения WiredTiger.

config.
mongodb_4_0.
mongocfg.
config.
effectiveConfig.
storage.
wiredTiger.
engineConfig
object

Конфигурация для механизма хранения WiredTiger.

config.
mongodb_4_0.
mongocfg.
config.
effectiveConfig.
storage.
wiredTiger.
engineConfig.
cacheSizeGb
number (double)

Максимальный размер внутреннего кэша, который WiredTiger будет использовать для всех данных.

config.
mongodb_4_0.
mongocfg.
config.
effectiveConfig.
operationProfiling
object

operationProfiling section of mongocfg configuration.

config.
mongodb_4_0.
mongocfg.
config.
effectiveConfig.
operationProfiling.
mode
string
config.
mongodb_4_0.
mongocfg.
config.
effectiveConfig.
operationProfiling.
slowOpThreshold
integer (int64)

Порог времени для медленных операций, в миллисекундах. Операции, которые выполняются дольше этого порогового значения, считаются медленными.

Значение должно быть больше 0.

config.
mongodb_4_0.
mongocfg.
config.
effectiveConfig.
net
object

net section of mongocfg configuration.

config.
mongodb_4_0.
mongocfg.
config.
effectiveConfig.
net.
maxIncomingConnections
integer (int64)

Максимальное количество одновременных подключений, которые принимает mongocfg.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_4_0.
mongocfg.
config.
userConfig
object

Пользовательские настройки для кластера MongoDB 4.0.

config.
mongodb_4_0.
mongocfg.
config.
userConfig.
storage
object

storage section of mongocfg configuration.

config.
mongodb_4_0.
mongocfg.
config.
userConfig.
storage.
wiredTiger
object

Конфигурация механизма хранения WiredTiger.

Конфигурация механизма хранения WiredTiger.

config.
mongodb_4_0.
mongocfg.
config.
userConfig.
storage.
wiredTiger.
engineConfig
object

Конфигурация для механизма хранения WiredTiger.

config.
mongodb_4_0.
mongocfg.
config.
userConfig.
storage.
wiredTiger.
engineConfig.
cacheSizeGb
number (double)

Максимальный размер внутреннего кэша, который WiredTiger будет использовать для всех данных.

config.
mongodb_4_0.
mongocfg.
config.
userConfig.
operationProfiling
object

operationProfiling section of mongocfg configuration.

config.
mongodb_4_0.
mongocfg.
config.
userConfig.
operationProfiling.
mode
string
config.
mongodb_4_0.
mongocfg.
config.
userConfig.
operationProfiling.
slowOpThreshold
integer (int64)

Порог времени для медленных операций, в миллисекундах. Операции, которые выполняются дольше этого порогового значения, считаются медленными.

Значение должно быть больше 0.

config.
mongodb_4_0.
mongocfg.
config.
userConfig.
net
object

net section of mongocfg configuration.

config.
mongodb_4_0.
mongocfg.
config.
userConfig.
net.
maxIncomingConnections
integer (int64)

Максимальное количество одновременных подключений, которые принимает mongocfg.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_4_0.
mongocfg.
config.
defaultConfig
object
config.
mongodb_4_0.
mongocfg.
config.
defaultConfig.
storage
object

storage section of mongocfg configuration.

config.
mongodb_4_0.
mongocfg.
config.
defaultConfig.
storage.
wiredTiger
object

Конфигурация механизма хранения WiredTiger.

Конфигурация механизма хранения WiredTiger.

config.
mongodb_4_0.
mongocfg.
config.
defaultConfig.
storage.
wiredTiger.
engineConfig
object

Конфигурация для механизма хранения WiredTiger.

config.
mongodb_4_0.
mongocfg.
config.
defaultConfig.
storage.
wiredTiger.
engineConfig.
cacheSizeGb
number (double)

Максимальный размер внутреннего кэша, который WiredTiger будет использовать для всех данных.

config.
mongodb_4_0.
mongocfg.
config.
defaultConfig.
operationProfiling
object

operationProfiling section of mongocfg configuration.

config.
mongodb_4_0.
mongocfg.
config.
defaultConfig.
operationProfiling.
mode
string
config.
mongodb_4_0.
mongocfg.
config.
defaultConfig.
operationProfiling.
slowOpThreshold
integer (int64)

Порог времени для медленных операций, в миллисекундах. Операции, которые выполняются дольше этого порогового значения, считаются медленными.

Значение должно быть больше 0.

config.
mongodb_4_0.
mongocfg.
config.
defaultConfig.
net
object

net section of mongocfg configuration.

config.
mongodb_4_0.
mongocfg.
config.
defaultConfig.
net.
maxIncomingConnections
integer (int64)

Максимальное количество одновременных подключений, которые принимает mongocfg.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_4_0.
mongocfg.
resources
object

Ресурсы, выделенные хостам mongocfg.

config.
mongodb_4_0.
mongocfg.
resources.
resourcePresetId
string

Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в documentation.

config.
mongodb_4_0.
mongocfg.
resources.
diskSize
string (int64)

Объем хранилища, доступного хосту, в байтах.

config.
mongodb_4_0.
mongocfg.
resources.
diskTypeId
string

Тип хранилища для хоста. Возможные значения:

  • network-hdd — сетевой HDD-диск;
  • network-nvme — сетевой SSD-диск;
  • local-nvme — локальное SSD-хранилище.
config.
mongodb_4_0.
mongos
object
config.
mongodb_4_0.
mongos.
config
object
config.
mongodb_4_0.
mongos.
config.
effectiveConfig
object

Действующие параметры для кластера MongoDB 4.0 (сочетание параметров, определенных в userConfig и [default_config]).

config.
mongodb_4_0.
mongos.
config.
effectiveConfig.
net
object
config.
mongodb_4_0.
mongos.
config.
effectiveConfig.
net.
maxIncomingConnections
integer (int64)

Максимальное количество одновременных подключений, которые принимает mongos.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_4_0.
mongos.
config.
userConfig
object

Пользовательские настройки для кластера MongoDB 4.0.

config.
mongodb_4_0.
mongos.
config.
userConfig.
net
object
config.
mongodb_4_0.
mongos.
config.
userConfig.
net.
maxIncomingConnections
integer (int64)

Максимальное количество одновременных подключений, которые принимает mongos.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_4_0.
mongos.
config.
defaultConfig
object

Конфигурация по умолчанию для кластера MongoDB 4.0.

config.
mongodb_4_0.
mongos.
config.
defaultConfig.
net
object
config.
mongodb_4_0.
mongos.
config.
defaultConfig.
net.
maxIncomingConnections
integer (int64)

Максимальное количество одновременных подключений, которые принимает mongos.

Допустимые значения — от 10 до 16384 включительно.

config.
mongodb_4_0.
mongos.
resources
object

Ресурсы, выделенные хостам mongocfg.

config.
mongodb_4_0.
mongos.
resources.
resourcePresetId
string

Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в documentation.

config.
mongodb_4_0.
mongos.
resources.
diskSize
string (int64)

Объем хранилища, доступного хосту, в байтах.

config.
mongodb_4_0.
mongos.
resources.
diskTypeId
string

Тип хранилища для хоста. Возможные значения:

  • network-hdd — сетевой HDD-диск;
  • network-nvme — сетевой SSD-диск;
  • local-nvme — локальное SSD-хранилище.
networkId string

Идентификатор сети, к которой принадлежит кластер.

health string

Агрегированная работоспособность кластера.

  • HEALTH_UNKNOWN: Состояние кластера неизвестно ([Host.health] для каждого хоста в кластере — UNKNOWN).
  • ALIVE: Кластер работает нормально ([Host.health] для каждого хоста в кластере — ALIVE).
  • DEAD: Кластер не работает ([Host.health] для каждого узла в кластере — DEAD).
  • DEGRADED: Кластер работает неоптимально ([Host.health] по крайней мере для одного узла в кластере не ALIVE).
status string

Текущее состояние кластера.

  • STATUS_UNKNOWN: Состояние кластера неизвестно.
  • CREATING: Кластер создается.
  • RUNNING: Кластер работает нормально.
  • ERROR: На кластере произошла ошибка, блокирующая работу.
  • UPDATING: Кластер изменяется.
  • STOPPING: Кластер останавливается.
  • STOPPED: Кластер остановлен.
  • STARTING: Кластер запускается.
sharded boolean (boolean)

Указывает текущее состояние шардирования кластера.

Методы

Метод Описание
addHosts Создает новые хосты для кластера.
addShard Создает новый шард.
backup Создает резервную копию для указанного кластера MongoDB.
create Создает кластер MongoDB в указанном каталоге.
delete Удаляет указанный кластер MongoDB.
deleteHosts Удаляет указанные хосты кластера.
deleteShard Удаляет указанный шард.
enableSharding Включает шардирование для кластера.
get Возвращает указанный ресурс Cluster для MongoDB.
getShard Возвращает указанный шард.
list Получает список ресурсов Cluster для MongoDB, принадлежащих указанному каталогу.
listBackups Получает список доступных резервных копий для указанного кластера MongoDB.
listHosts Получает список хостов для указанного кластера.
listLogs Получает логи для указанного кластера MongoDB. Логи подробно описаны в разделе Logs руководства разработчика.
listOperations Получает список ресурсов Operation для указанного кластера.
listShards Получает список шардов.
move Перемещает кластер MongoDB в указанный каталог.
restore Создает новый кластер MongoDB с использованием указанной резервной копии.
start Запускает указанный кластер MongoDB.
stop Останавливает указанный кластер MongoDB.
update Изменяет указанный кластер MongoDB.