Метод update

Изменяет указанный кластер MongoDB.

HTTP-запрос

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

Path-параметры

Параметр Описание
clusterId Обязательное поле. Идентификатор изменяемого ресурса Cluster для MongoDB. Чтобы получить идентификатор кластера MongoDB, используйте запрос list. Максимальная длина строки в символах — 50.

Параметры в теле запроса

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

    // `configSpec` включает только одно из полей `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"
        }
      }
    },
    // конец списка возможных полей`configSpec`

  }
}
Поле Описание
updateMask string

Маска, которая указывает, какие поля ресурса Cluster для MongoDB должны быть изменены.

Имена всех обновляемых полей, разделенные запятыми. Только значения указанных полей будут изменены. Остальные останутся нетронутыми. Если поле указано в параметре updateMask и в запросе не было отправлено значение для этого поля, значение поля будет сброшено на значение по умолчанию. Значение по умолчанию для большинства полей — null или 0.

Если в запросе не передается updateMask, значения всех полей будут обновлены. Для полей, указанных в запросе, будут использованы переданные значения. Значения остальных полей будут сброшены на значения по умолчанию.

description string

Новое описание кластера MongoDB.

Максимальная длина строки в символах — 256.

labels object

Пользовательские метки для кластера MongoDB как "key:value `` pairs. Maximum 64 per resource. For example,project": "mvp" или "source": "dictionary".

Новый набор меток полностью заменит старый. Чтобы добавить метку, запросите текущий набор меток с помощью метода get, затем отправьте запрос update, добавив новую метку в этот набор.

Не более 64 на ресурс. Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z].

configSpec object

Новая конфигурация и ресурсы для хостов кластера.

configSpec.
version
string

Версия MongoDB, используемая в кластере. Возможные значения:

  • 3.6
  • 4.0
configSpec.
featureCompatibilityVersion
string

Функционально совместимая версия MongoDB. Возможные значения:

  • 3.6
  • 4.0
configSpec.
backupWindowStart
object
Время запуска ежедневного резервного копирования, в часовом поясе UTC.

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
Конфигурация и распределение ресурсов для кластера MongoDB 3.6.
configSpec включает только одно из полей mongodbSpec_3_6, mongodbSpec_4_0

configSpec.
mongodbSpec_3_6.
mongod
object

Конфигурация и выделенные ресурсы для узла mongod.

configSpec.
mongodbSpec_3_6.
mongod.
config
object

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

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

configSpec.
mongodbSpec_3_6.
mongod.
config.
storage
object

storage section of mongod configuration.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

configSpec.
mongodbSpec_3_6.
mongod.
config.
operationProfiling
object

operationProfiling section of mongod configuration.

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

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

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

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

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

configSpec.
mongodbSpec_3_6.
mongod.
config.
net
object

net section of mongod configuration.

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

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

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

configSpec.
mongodbSpec_3_6.
mongod.
resources
object

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

configSpec.
mongodbSpec_3_6.
mongod.
resources.
resourcePresetId
string

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

configSpec.
mongodbSpec_3_6.
mongod.
resources.
diskSize
string (int64)

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

configSpec.
mongodbSpec_3_6.
mongod.
resources.
diskTypeId
string

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

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

Конфигурация и распределение ресурсов для хоста mongocfg.

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

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

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

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

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

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

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

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)

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

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

configSpec.
mongodbSpec_3_6.
mongocfg.
config.
net
object

net section of mongocfg configuration.

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

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

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

configSpec.
mongodbSpec_3_6.
mongocfg.
resources
object

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

configSpec.
mongodbSpec_3_6.
mongocfg.
resources.
resourcePresetId
string

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

configSpec.
mongodbSpec_3_6.
mongocfg.
resources.
diskSize
string (int64)

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

configSpec.
mongodbSpec_3_6.
mongocfg.
resources.
diskTypeId
string

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

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

Конфигурация и распределение ресурсов для узла mongos.

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)

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

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

configSpec.
mongodbSpec_3_6.
mongos.
resources
object

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

configSpec.
mongodbSpec_3_6.
mongos.
resources.
resourcePresetId
string

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

configSpec.
mongodbSpec_3_6.
mongos.
resources.
diskSize
string (int64)

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

configSpec.
mongodbSpec_3_6.
mongos.
resources.
diskTypeId
string

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

  • network-hdd — сетевой HDD-диск;
  • network-nvme — сетевой SSD-диск;
  • local-nvme — локальное SSD-хранилище.
configSpec.
mongodbSpec_4_0
object
Конфигурация и распределение ресурсов для кластера MongoDB 4.0.
configSpec включает только одно из полей mongodbSpec_3_6, mongodbSpec_4_0

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

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

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

configSpec.
mongodbSpec_4_0.
mongod.
config.
storage
object

storage section of mongod configuration.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

configSpec.
mongodbSpec_4_0.
mongod.
config.
operationProfiling
object

operationProfiling section of mongod configuration.

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

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

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

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

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

configSpec.
mongodbSpec_4_0.
mongod.
config.
net
object

net section of mongod configuration.

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

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

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

configSpec.
mongodbSpec_4_0.
mongod.
resources
object

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

configSpec.
mongodbSpec_4_0.
mongod.
resources.
resourcePresetId
string

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

configSpec.
mongodbSpec_4_0.
mongod.
resources.
diskSize
string (int64)

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

configSpec.
mongodbSpec_4_0.
mongod.
resources.
diskTypeId
string

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

  • network-hdd — сетевой HDD-диск;
  • network-nvme — сетевой SSD-диск;
  • local-nvme — локальное SSD-хранилище.
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

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

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

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

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

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

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

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)

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

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

configSpec.
mongodbSpec_4_0.
mongocfg.
config.
net
object

net section of mongocfg configuration.

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

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

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

configSpec.
mongodbSpec_4_0.
mongocfg.
resources
object

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

configSpec.
mongodbSpec_4_0.
mongocfg.
resources.
resourcePresetId
string

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

configSpec.
mongodbSpec_4_0.
mongocfg.
resources.
diskSize
string (int64)

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

configSpec.
mongodbSpec_4_0.
mongocfg.
resources.
diskTypeId
string

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

  • network-hdd — сетевой HDD-диск;
  • network-nvme — сетевой SSD-диск;
  • local-nvme — локальное SSD-хранилище.
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)

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

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

configSpec.
mongodbSpec_4_0.
mongos.
resources
object

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

configSpec.
mongodbSpec_4_0.
mongos.
resources.
resourcePresetId
string

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

configSpec.
mongodbSpec_4_0.
mongos.
resources.
diskSize
string (int64)

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

configSpec.
mongodbSpec_4_0.
mongos.
resources.
diskTypeId
string

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

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

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  включает только одно из полей `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // конец списка возможных полей

}

Ресурс Operation. Дополнительные сведения см. в разделе Объект Operation.

Поле Описание
id string

Только для вывода. Идентификатор операции.

description string

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

createdAt string (date-time)

Только для вывода. Время создания ресурса в формате в RFC3339.

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

createdBy string

Только для вывода. Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.

modifiedAt string (date-time)

Только для вывода. Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.

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

done boolean (boolean)

Только для вывода. Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.

metadata object

Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.

error object
Описание ошибки в случае сбоя или отмены операции.
включает только одно из полей error, response

Описание ошибки в случае сбоя или отмены операции.

error.
code
integer (int32)

Код ошибки. Значение из списка google.rpc.Code.

error.
message
string

Текст ошибки.

error.
details[]
object

Список сообщений с подробными сведениями об ошибке.

response object
включает только одно из полей error, response

Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.