Метод create

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

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

HTTP-запрос

POST https://mdb.api.cloud.yandex.net/mdb/sqlserver/v1alpha/clusters

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

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "configSpec": {
    "version": "string",
    "resources": {
      "resourcePresetId": "string",
      "diskSize": "string",
      "diskTypeId": "string"
    },
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },
    "sqlserverConfig_2016Sp2": {
      "maxDegreeOfParallelism": "integer",
      "costThresholdForParallelism": "integer",
      "sqlcollation": "string",
      "auditLevel": "integer",
      "filestreamAccessLevel": "integer",
      "fillFactorPercent": "integer",
      "inDoubtXactResolution": "integer",
      "optimizeForAdHocWorkloads": true,
      "crossDbOwnershipChaining": true
    }
  },
  "databaseSpecs": [
    {
      "name": "string"
    }
  ],
  "userSpecs": [
    {
      "name": "string",
      "password": "string",
      "permissions": [
        {
          "databaseName": "string",
          "roles": [
            "string"
          ]
        }
      ]
    }
  ],
  "hostSpecs": [
    {
      "zoneId": "string",
      "subnetId": "string",
      "assignPublicIp": true
    }
  ],
  "networkId": "string"
}

Поле	Описание
folderId	string Обязательное поле. Идентификатор каталога, в котором будет создан кластер SQL Server. Чтобы получить идентификатор каталога, используйте запрос list. Максимальная длина строки в символах — 50.
name	string Обязательное поле. Имя кластера SQL Server. Имя должно быть уникальным в рамках каталога. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению `[a-zA-Z0-9_-]*`.
description	string Описание кластера SQL Server. Максимальная длина строки в символах — 256.
labels	object Пользовательские метки для кластера SQL Server в виде пар `key:value`. Например, "project": "mvp" или "source": "dictionary". Не более 64 на ресурс. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению `[a-z][-_0-9a-z]`. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению `[-_0-9a-z]`.
environment	string Среда развертывания кластера SQL Server. PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления. PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
configSpec	object Конфигурация SQL Server и хостов для кластера.
configSpec. version	string Версия SQL Server, используемая в кластере. Возможные значения: 2016sp2
configSpec. resources	object Ресурсы, выделенные хостам SQL Server.
configSpec. resources. resourcePresetId	string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
configSpec. resources. diskSize	string (int64) Объем хранилища, доступного хосту.
configSpec. resources. diskTypeId	string Тип хранилища для хоста. Возможные значения: network-hdd — сетевой HDD-диск; network-ssd — сетевой SSD-диск; local-ssd — локальное SSD-хранилище.
configSpec. backupWindowStart	object Время запуска ежедневного резервного копирования, в часовом поясе UTC. Время суток. Дата и часовой пояс либо не учитываются, либо задаются в других местах. API может разрешить использование високосной секунды. Связанные типы: google.type.Date и google.protobuf.Timestamp.
configSpec. backupWindowStart. hours	integer (int32) Часы. Допустимые значения: от 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 до 999999999.
configSpec. sqlserverConfig_2016Sp2	object Конфигурация кластера SQL Server 2016 SP2. Здесь перечислены поддерживаемые параметры конфигурации SQL Server 2016 SP2. Подробное описание всех параметров доступно в документации SQL Server. Любые параметры, не перечисленные здесь, не поддерживаются.
configSpec. sqlserverConfig_2016Sp2. maxDegreeOfParallelism	integer (int64) Ограничивает число процессоров, задействованных для параллельного выполнения плана для каждой задачи. См. подробное описание в документации SQL Server. Допустимые значения — от 1 до 99 включительно.
configSpec. sqlserverConfig_2016Sp2. costThresholdForParallelism	integer (int64) Задает пороговое значение, при котором SQL Server создает и выполняет параллельные планы для запросов. SQL Server создает и выполняет параллельный план для запроса только в том случае, если расчетная стоимость выполнения последовательного плана для того же запроса превышает значение этого параметра. См. подробное описание в документации SQL Server. Допустимые значения — от 5 до 32767 включительно.
configSpec. sqlserverConfig_2016Sp2. sqlcollation	string Набор правил сортировки, используемых базами данных экземпляра. Определяет, являются ли базы данных экземпляра чувствительными к регистру, акценту и т. д. См. подробное описание в документации SQL Server.
configSpec. sqlserverConfig_2016Sp2. auditLevel	integer (int64) Настройки аудита входа, необходимого для мониторинга активности подключения к компоненту SQL Server Database Engine. Возможные значения: 0 — не регистрировать попытки входа в систему, 1 — регистрировать только неудачные попытки входа в систему, 2 — регистрировать только успешные попытки входа в систему (не рекомендуется), 3 — регистрировать все попытки входа в систему (не рекомендуется). См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 3 включительно.
configSpec. sqlserverConfig_2016Sp2. filestreamAccessLevel	integer (int64) Определяет уровень доступа `FILESTREAM` для экземпляра SQL Server. Технология `FILESTREAM` позволяет приложениям на базе SQL Server хранить BLOB-объекты, такие как документы и изображения, в файловой системе за пределами базы данных. Возможные значения: 0 — выключает `FILESTREAM`, 1 — включает `FILESTREAM` для доступа с помощью Transact-SQL, 2 — включает `FILESTREAM` для доступа с помощью Transact-SQL и потокового доступа Win32. См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 2 включительно.
configSpec. sqlserverConfig_2016Sp2. fillFactorPercent	integer (int64) Задает коэффициент заполнения. Когда индекс создается или перестраивается, коэффициент заполнения отображает процент заполнения пространства каждой страницы конечного уровня, что позволяет зарезервировать оставшееся пространство как свободное — для будущего расширения. Значения 0 и 100 означают полное заполнение страницы (свободное место не резервируется). См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 100 включительно.
configSpec. sqlserverConfig_2016Sp2. inDoubtXactResolution	integer (int64) Определяет результат по умолчанию для распределенных транзакций, которые не удалось разрешить координатору распределенных транзакций Microsoft (MS DTC). Такие транзакции называются сомнительными распределенными транзакциями. Возможные значения: 0 — нет автоматического разрешения. Восстановление завершится неуспешно, если MS DTC не сможет разрешить какую-либо сомнительную транзакцию. 1 — сомнительные транзакции считаются подтвержденными, 2 — сомнительные транзакции считаются неподтвержденными и будут откачены. См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 2 включительно.
configSpec. sqlserverConfig_2016Sp2. optimizeForAdHocWorkloads	boolean (boolean) Определяет, следует ли кэшировать планы запросов только после второго выполнения. Позволяет избежать раздувания кэша SQL из-за одноразовых планов. См. подробное описание в документации SQL Server.
configSpec. sqlserverConfig_2016Sp2. crossDbOwnershipChaining	boolean (boolean) Включает цепочку владения между базами данных. Пример: имея явный доступ к хранимой процедуре в одной базе данных, которая ссылается на объект в другой базе данных, к которой у вас нет явного доступа, вы сможете выполнить процедуру без ошибки, связанной с разрешением. См. подробное описание в документации SQL Server.
databaseSpecs[]	object Одна или несколько конфигураций баз данных, создаваемых в кластере SQL Server.
databaseSpecs[]. name	string Обязательное поле. Имя базы данных. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению `[a-zA-Z0-9_-]*`.
userSpecs[]	object Одна или несколько конфигураций пользователей баз данных, создаваемых в кластере SQL Server.
userSpecs[]. name	string Обязательное поле. Имя пользователя SQL Server. Максимальная длина строки в символах — 32. Значение должно соответствовать регулярному выражению `[a-zA-Z0-9_]*`.
userSpecs[]. password	string Обязательное поле. Пароль пользователя SQL Server. Длина строки в символах должна быть от 8 до 128.
userSpecs[]. permissions[]	object Набор разрешений, которые следует предоставить пользователю.
userSpecs[]. permissions[]. databaseName	string Имя базы данных, для которой предоставляется разрешение.
userSpecs[]. permissions[]. roles[]	string DB_OWNER: Члены этой роли могут выполнять все действия по настройке и обслуживанию базы данных, а также удалять базу данных SQL Server. DB_SECURITYADMIN: Члены этой роли могут управлять разрешениями и членством в пользовательских ролях. Они потенциально могут повысить свои привилегии, поэтому их действия должны контролироваться. DB_ACCESSADMIN: Члены этой роли могут управлять доступом к базе данных для пользователей Windows, групп Windows и пользователей SQL Server. DB_BACKUPOPERATOR: Члены этой роли могут создавать резервные копии базы данных. DB_DDLADMIN: Члены этой роли могут выполнять в базе данных любую команду языка описания данных (DDL). DB_DATAWRITER: Члены этой роли могут добавлять, удалять или изменять данные во всех пользовательских таблицах. DB_DATAREADER: Члены этой роли могут читать все данные из всех пользовательских таблиц. DB_DENYDATAWRITER: Члены этой роли не могут добавлять, изменять или удалять никакие данные в пользовательских таблицах базы данных. Подобное ограничение привилегий имеет более высокий приоритет, чем предоставление, поэтому вы можете использовать эту роль для быстрого ограничения привилегий без явного отзыва разрешений или ролей. DB_DENYDATAREADER: Члены этой фиксированной роли базы данных не могут читать никакие данные из пользовательских таблиц в базе данных. Подобное ограничение привилегий имеет более высокий приоритет, чем предоставление, поэтому вы можете использовать эту роль для быстрого ограничения привилегий без явного отзыва разрешений или ролей.
hostSpecs[]	object Одна или несколько конфигураций хостов, создаваемых в кластере SQL Server.
hostSpecs[]. zoneId	string Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос list. Максимальная длина строки в символах — 50.
hostSpecs[]. subnetId	string Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задан в поле Cluster.networkId. Максимальная длина строки в символах — 50.
hostSpecs[]. assignPublicIp	boolean (boolean) Должен ли хост получить публичный IP-адрес при создании. После создания узла этот параметр изменить нельзя. Чтобы удалить назначенный публичный IP-адрес или назначить публичный IP уже созданному хосту, пересоздайте хост с нужным значением поля `assignPublicIp`. Возможные значения: false — не назначать хосту публичный IP-адрес. true — назначить хосту публичный IP-адрес.
networkId	string Идентификатор сети, в которой нужно создать кластер SQL Server. Максимальная длина строки в символах — 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`.