Метод update
Изменяет указанный кластер SQL Server.
HTTP-запрос
PATCH https://mdb.api.cloud.yandex.net/mdb/sqlserver/v1alpha/clusters/{clusterId}
Path-параметры
Параметр | Описание |
---|---|
clusterId | Обязательное поле. Идентификатор кластера SQL Server, который следует изменить. Чтобы получить идентификатор кластера SQL Server, используйте запрос list. Максимальная длина строки в символах — 50. |
Параметры в теле запроса
{
"updateMask": "string",
"description": "string",
"labels": "object",
"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
}
},
"name": "string"
}
Поле | Описание |
---|---|
updateMask | string Маска, которая указывает, какие атрибуты кластера SQL Server должны быть изменены. Имена всех обновляемых полей, разделенные запятыми. Только значения указанных полей будут изменены. Остальные останутся нетронутыми. Если поле указано в параметре Если в запросе не передается |
description | string Новое описание кластера SQL Server. Максимальная длина строки в символах — 256. |
labels | object Пользовательские метки для кластера SQL Server в виде пар Например, "project": "mvp" или "source": "dictionary". Новый набор меток полностью заменит старый. Чтобы добавить метку, запросите текущий набор меток с помощью метода get, затем отправьте запрос update, добавив новую метку в этот набор. Не более 64 на ресурс. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению |
configSpec | object Новая конфигурация и ресурсы для хостов кластера SQL Server. |
configSpec. version |
string Версия SQL Server, используемая в кластере. Возможные значения:
|
configSpec. resources |
object Ресурсы, выделенные хостам SQL Server. |
configSpec. resources. resourcePresetId |
string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
configSpec. resources. diskSize |
string (int64) Объем хранилища, доступного хосту. |
configSpec. resources. diskTypeId |
string Тип хранилища для хоста. Возможные значения:
|
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. Возможные значения:
См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 3 включительно. |
configSpec. sqlserverConfig_2016Sp2. filestreamAccessLevel |
integer (int64) Определяет уровень доступа Возможные значения:
См. подробное описание в документации 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). Такие транзакции называются сомнительными распределенными транзакциями. Возможные значения:
См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 2 включительно. |
configSpec. sqlserverConfig_2016Sp2. optimizeForAdHocWorkloads |
boolean (boolean) Определяет, следует ли кэшировать планы запросов только после второго выполнения. Позволяет избежать раздувания кэша SQL из-за одноразовых планов. См. подробное описание в документации SQL Server. |
configSpec. sqlserverConfig_2016Sp2. crossDbOwnershipChaining |
boolean (boolean) Включает цепочку владения между базами данных. Пример: имея явный доступ к хранимой процедуре в одной базе данных, которая ссылается на объект в другой базе данных, к которой у вас нет явного доступа, вы сможете выполнить процедуру без ошибки, связанной с разрешением. См. подробное описание в документации SQL Server. |
name | string Новое имя кластера SQL Server. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению |
Ответ
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) Если значение равно |
metadata | object Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля |
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, в описании метода приведена структура соответствующего ему поля |