Метод create

Создает кластер MongoDB в указанном каталоге.

HTTP-запрос

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

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

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "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`

  },
  "databaseSpecs": [
    {
      "name": "string"
    }
  ],
  "userSpecs": [
    {
      "name": "string",
      "password": "string",
      "permissions": [
        {
          "databaseName": "string",
          "roles": [
            "string"
          ]
        }
      ]
    }
  ],
  "hostSpecs": [
    {
      "zoneId": "string",
      "subnetId": "string",
      "assignPublicIp": true,
      "type": "string",
      "shardName": "string"
    }
  ],
  "networkId": "string"
}
Поле Описание
folderId string

Обязательное поле. Идентификатор каталога, в котором нужно создать кластер MongoDB.

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

name string

Обязательное поле. Имя кластера MongoDB. Имя должно быть уникальным в каталоге.

Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]*.

description string

Описание кластера MongoDB.

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

labels object

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

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

environment string

Обязательное поле. Среда развертывания кластера MongoDB.

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

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

Обязательное поле. Конфигурация и ресурсы для хостов, которые должны быть созданы для кластера MongoDB.

configSpec.
version
string

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

  • 3.6.
  • 4.0
configSpec.
featureCompatibilityVersion
string

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

Возможные значения:

  • 3.6 — сохранить совместимость данных с версией 3.6. После установки этого параметра данные не будут совместимы с версией 3.4 или ниже.
  • 4.0 — сохранить совместимость данных с версией 4.0. После установки этого параметра данные не будут совместимы с версией 3.6 или ниже.
configSpec.
backupWindowStart
object
Время запуска ежедневного резервного копирования, в часовом поясе UTC.

Описывает время суток. Дата и часовой пояс либо не имеют значения, либо указаны другим образом. API может разрешить високосные секунды. Связанные типы: [google.type.Date][google.type.Date] и google.protobuf.Timestamp.

configSpec.
backupWindowStart.
hours
integer (int32)

Час в 24-часовом формате. Допустимые значения — от 0 до 23. API может разрешить значение "24:00:00" для таких сценариев, как время закрытия заведения.

configSpec.
backupWindowStart.
minutes
integer (int32)

Минута часа. Допустимые значения — от 0 до 59.

configSpec.
backupWindowStart.
seconds
integer (int32)

Секунда минуты. Обычно допустимые значения — от 0 до 59. API может разрешить значение 60, если поддерживаются високосные секунды.

configSpec.
backupWindowStart.
nanos
integer (int32)

Доли секунды, в наносекундах. Допустимые значения — от 0 до 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 3.6.

configSpec.
mongodbSpec_3_6.
mongod.
config
object

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

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

configSpec.
mongodbSpec_3_6.
mongod.
config.
storage
object

Секция storage конфигурации mongod.

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 конфигурации mongod.

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 конфигурации mongod.

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-ssd — сетевой SSD-диск;
  • local-ssd — локальное SSD-хранилище.
configSpec.
mongodbSpec_3_6.
mongocfg
object

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

configSpec.
mongodbSpec_3_6.
mongocfg.
config
object

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

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

Уровень профилирования операций. Подробнее см. в MongoDB documentation.

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

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

Значение должно быть больше 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-ssd — сетевой SSD-диск;
  • local-ssd — локальное SSD-хранилище.
configSpec.
mongodbSpec_3_6.
mongos
object

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

configSpec.
mongodbSpec_3_6.
mongos.
config
object

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

configSpec.
mongodbSpec_3_6.
mongos.
config.
net
object

Сетевые настройки для mongos.

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-ssd — сетевой SSD-диск;
  • local-ssd — локальное SSD-хранилище.
configSpec.
mongodbSpec_4_0
object
Конфигурация и распределение ресурсов для кластера MongoDB 4.0.
configSpec включает только одно из полей mongodbSpec_3_6, mongodbSpec_4_0

configSpec.
mongodbSpec_4_0.
mongod
object

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

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-ssd — сетевой SSD-диск;
  • local-ssd — локальное SSD-хранилище.
configSpec.
mongodbSpec_4_0.
mongocfg
object

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

configSpec.
mongodbSpec_4_0.
mongocfg.
config
object

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

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

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

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

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

Значение должно быть больше 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-ssd — сетевой SSD-диск;
  • local-ssd — локальное SSD-хранилище.
configSpec.
mongodbSpec_4_0.
mongos
object

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

configSpec.
mongodbSpec_4_0.
mongos.
config
object

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

configSpec.
mongodbSpec_4_0.
mongos.
config.
net
object

Сетевые настройки для mongos.

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-ssd — сетевой SSD-диск;
  • local-ssd — локальное SSD-хранилище.
databaseSpecs[] object

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

Должен содержать хотя бы один элемент.

databaseSpecs[].
name
string

Обязательное поле. Имя базы данных MongoDB. Длина 1-63 символов.

Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]{1,63}.

userSpecs[] object

Обязательное поле. Описания пользователей базы данных, которых нужно создать в кластере MongoDB.

Должен содержать хотя бы один элемент.

userSpecs[].
name
string

Обязательное поле. Имя пользователя базы данных MongoDB.

Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]*.

userSpecs[].
password
string

Обязательное поле. Пароль пользователя MongoDB.

Длина строки в символах должна быть от 8 до 128.

userSpecs[].
permissions[]
object

Набор разрешений, которые следует предоставить пользователю.

userSpecs[].
permissions[].
databaseName
string

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

userSpecs[].
permissions[].
roles[]
string

Роли MongoDB базы данных databaseName, которые предоставляет разрешение.

hostSpecs[] object

Обязательное поле. Конфигурации для отдельных хостов, которые должны быть созданы для кластера MongoDB.

Должен содержать хотя бы один элемент.

hostSpecs[].
zoneId
string

Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос list.

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

hostSpecs[].
subnetId
string

Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети устанавливается в поле Cluster.networkId.

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

hostSpecs[].
assignPublicIp
boolean (boolean)

Должен ли хост получить публичный IP-адрес при создании.

После создания узла этот параметр изменить нельзя. Чтобы удалить назначенный публичный IP-адрес или назначить публичный IP уже созданному хосту, пересоздайте хост с нужным значением поля assignPublicIp.

Возможные значения:

  • false — не назначать хосту публичный IP-адрес.
  • true — у хоста должен быть публичный IP-адрес.
hostSpecs[].
type
string

Тип развертываемого хоста.

  • MONGOD: Хост mongod.
  • MONGOS: Хост mongos.
  • MONGOCFG: Хост mongocfg.
hostSpecs[].
shardName
string

Имя шарда, которому принадлежит хост.

Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

networkId string

Обязательное поле. Идентификатор сети, в которой нужно создать кластер.

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

Ответ

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.