Метод get
Возвращает указанный кластер SQL Server.
Чтобы получить список доступных кластеров SQL Server, выполните запрос list.
HTTP-запрос
GET https://mdb.api.cloud.yandex.net/mdb/sqlserver/v1alpha/clusters/{clusterId}
Path-параметры
Параметр | Описание |
---|---|
clusterId | Обязательное поле. Идентификатор кластера SQL Server. Чтобы получить идентификатор кластера, используйте запрос list. Максимальная длина строки в символах — 50. |
Ответ
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"environment": "string",
"monitoring": [
{
"name": "string",
"description": "string",
"link": "string"
}
],
"config": {
"version": "string",
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"backupWindowStart": {
"hours": "integer",
"minutes": "integer",
"seconds": "integer",
"nanos": "integer"
},
"sqlserverConfig_2016Sp2": {
"effectiveConfig": {
"maxDegreeOfParallelism": "integer",
"costThresholdForParallelism": "integer",
"sqlcollation": "string",
"auditLevel": "integer",
"filestreamAccessLevel": "integer",
"fillFactorPercent": "integer",
"inDoubtXactResolution": "integer",
"optimizeForAdHocWorkloads": true,
"crossDbOwnershipChaining": true
},
"userConfig": {
"maxDegreeOfParallelism": "integer",
"costThresholdForParallelism": "integer",
"sqlcollation": "string",
"auditLevel": "integer",
"filestreamAccessLevel": "integer",
"fillFactorPercent": "integer",
"inDoubtXactResolution": "integer",
"optimizeForAdHocWorkloads": true,
"crossDbOwnershipChaining": true
},
"defaultConfig": {
"maxDegreeOfParallelism": "integer",
"costThresholdForParallelism": "integer",
"sqlcollation": "string",
"auditLevel": "integer",
"filestreamAccessLevel": "integer",
"fillFactorPercent": "integer",
"inDoubtXactResolution": "integer",
"optimizeForAdHocWorkloads": true,
"crossDbOwnershipChaining": true
}
}
},
"networkId": "string",
"health": "string",
"status": "string"
}
Кластер SQL Server.
Для получения дополнительной информации см. раздел документации Взаимосвязь ресурсов сервиса.
Поле | Описание |
---|---|
id | string Идентификатор кластера SQL Server. Этот идентификатор Managed Service for SQL Server генерирует при создании. |
folderId | string Идентификатор каталога, которому принадлежит кластер SQL Server. |
createdAt | string (date-time) Строка в формате RFC3339. |
name | string Имя кластера SQL Server. Имя должно быть уникальным в каталоге, соответствовать RFC 1035 и иметь длину 1-63 символа. |
description | string Описание кластера SQL Server. Длина описания должна быть от 0 до 256 символов. |
labels | object Пользовательские метки для кластера SQL Server в виде пар |
environment | string Среда развертывания кластера SQL Server.
|
monitoring[] | object Описание систем мониторинга, относящихся к кластеру SQL Server. |
monitoring[]. name |
string Название системы мониторинга. |
monitoring[]. description |
string Описание системы мониторинга. |
monitoring[]. link |
string Ссылка на графики системы мониторинга для кластера SQL Server. |
config | object Конфигурация кластера SQL Server. |
config. version |
string Версия SQL Server. |
config. resources |
object Ресурсы, выделенные хостам SQL Server. |
config. resources. resourcePresetId |
string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
config. resources. diskSize |
string (int64) Объем хранилища, доступного хосту. |
config. resources. diskTypeId |
string Тип хранилища для хоста. Возможные значения:
|
config. backupWindowStart |
object Время запуска ежедневного резервного копирования, в часовом поясе UTC. Время суток. Дата и часовой пояс либо не учитываются, либо задаются в других местах. API может разрешить использование високосной секунды. Связанные типы: google.type.Date и google.protobuf.Timestamp. |
config. backupWindowStart. hours |
integer (int32) Часы. Допустимые значения: от 0 до 23. API может разрешить использовать значение в формате "24:00:00" в требующих этого сценариях (например, для указания времени закрытия учреждения). |
config. backupWindowStart. minutes |
integer (int32) Минуты. Допустимые значения: от 0 до 59. |
config. backupWindowStart. seconds |
integer (int32) Секунды. Стандартные допустимые значения: от 0 до 59. API может разрешить использовать значение 60, если также разрешено использование високосной секунды. |
config. backupWindowStart. nanos |
integer (int32) Доли секунды (в наносекундах). Допустимые значения: от 0 до 999999999. |
config. sqlserverConfig_2016Sp2 |
object Конфигурация экземпляра SQL Server 2016sp2. |
config. sqlserverConfig_2016Sp2. effectiveConfig |
object Действующие настройки для кластера SQL Server 2016 SP2 (сочетание параметров, определенных в Здесь перечислены поддерживаемые параметры конфигурации SQL Server 2016 SP2. Подробное описание всех параметров доступно в документации SQL Server. Любые параметры, не перечисленные здесь, не поддерживаются. |
config. sqlserverConfig_2016Sp2. effectiveConfig. maxDegreeOfParallelism |
integer (int64) Ограничивает число процессоров, задействованных для параллельного выполнения плана для каждой задачи. См. подробное описание в документации SQL Server. Допустимые значения — от 1 до 99 включительно. |
config. sqlserverConfig_2016Sp2. effectiveConfig. costThresholdForParallelism |
integer (int64) Задает пороговое значение, при котором SQL Server создает и выполняет параллельные планы для запросов. SQL Server создает и выполняет параллельный план для запроса только в том случае, если расчетная стоимость выполнения последовательного плана для того же запроса превышает значение этого параметра. См. подробное описание в документации SQL Server. Допустимые значения — от 5 до 32767 включительно. |
config. sqlserverConfig_2016Sp2. effectiveConfig. sqlcollation |
string Набор правил сортировки, используемых базами данных экземпляра. Определяет, являются ли базы данных экземпляра чувствительными к регистру, акценту и т. д. См. подробное описание в документации SQL Server. |
config. sqlserverConfig_2016Sp2. effectiveConfig. auditLevel |
integer (int64) Настройки аудита входа, необходимого для мониторинга активности подключения к компоненту SQL Server Database Engine. Возможные значения:
См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 3 включительно. |
config. sqlserverConfig_2016Sp2. effectiveConfig. filestreamAccessLevel |
integer (int64) Определяет уровень доступа Возможные значения:
См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 2 включительно. |
config. sqlserverConfig_2016Sp2. effectiveConfig. fillFactorPercent |
integer (int64) Задает коэффициент заполнения. Когда индекс создается или перестраивается, коэффициент заполнения отображает процент заполнения пространства каждой страницы конечного уровня, что позволяет зарезервировать оставшееся пространство как свободное — для будущего расширения. Значения 0 и 100 означают полное заполнение страницы (свободное место не резервируется). См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 100 включительно. |
config. sqlserverConfig_2016Sp2. effectiveConfig. inDoubtXactResolution |
integer (int64) Определяет результат по умолчанию для распределенных транзакций, которые не удалось разрешить координатору распределенных транзакций Microsoft (MS DTC). Такие транзакции называются сомнительными распределенными транзакциями. Возможные значения:
См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 2 включительно. |
config. sqlserverConfig_2016Sp2. effectiveConfig. optimizeForAdHocWorkloads |
boolean (boolean) Определяет, следует ли кэшировать планы запросов только после второго выполнения. Позволяет избежать раздувания кэша SQL из-за одноразовых планов. См. подробное описание в документации SQL Server. |
config. sqlserverConfig_2016Sp2. effectiveConfig. crossDbOwnershipChaining |
boolean (boolean) Включает цепочку владения между базами данных. Пример: имея явный доступ к хранимой процедуре в одной базе данных, которая ссылается на объект в другой базе данных, к которой у вас нет явного доступа, вы сможете выполнить процедуру без ошибки, связанной с разрешением. См. подробное описание в документации SQL Server. |
config. sqlserverConfig_2016Sp2. userConfig |
object Пользовательские параметры для кластера SQL Server 2016 SP2. Здесь перечислены поддерживаемые параметры конфигурации SQL Server 2016 SP2. Подробное описание всех параметров доступно в документации SQL Server. Любые параметры, не перечисленные здесь, не поддерживаются. |
config. sqlserverConfig_2016Sp2. userConfig. maxDegreeOfParallelism |
integer (int64) Ограничивает число процессоров, задействованных для параллельного выполнения плана для каждой задачи. См. подробное описание в документации SQL Server. Допустимые значения — от 1 до 99 включительно. |
config. sqlserverConfig_2016Sp2. userConfig. costThresholdForParallelism |
integer (int64) Задает пороговое значение, при котором SQL Server создает и выполняет параллельные планы для запросов. SQL Server создает и выполняет параллельный план для запроса только в том случае, если расчетная стоимость выполнения последовательного плана для того же запроса превышает значение этого параметра. См. подробное описание в документации SQL Server. Допустимые значения — от 5 до 32767 включительно. |
config. sqlserverConfig_2016Sp2. userConfig. sqlcollation |
string Набор правил сортировки, используемых базами данных экземпляра. Определяет, являются ли базы данных экземпляра чувствительными к регистру, акценту и т. д. См. подробное описание в документации SQL Server. |
config. sqlserverConfig_2016Sp2. userConfig. auditLevel |
integer (int64) Настройки аудита входа, необходимого для мониторинга активности подключения к компоненту SQL Server Database Engine. Возможные значения:
См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 3 включительно. |
config. sqlserverConfig_2016Sp2. userConfig. filestreamAccessLevel |
integer (int64) Определяет уровень доступа Возможные значения:
См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 2 включительно. |
config. sqlserverConfig_2016Sp2. userConfig. fillFactorPercent |
integer (int64) Задает коэффициент заполнения. Когда индекс создается или перестраивается, коэффициент заполнения отображает процент заполнения пространства каждой страницы конечного уровня, что позволяет зарезервировать оставшееся пространство как свободное — для будущего расширения. Значения 0 и 100 означают полное заполнение страницы (свободное место не резервируется). См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 100 включительно. |
config. sqlserverConfig_2016Sp2. userConfig. inDoubtXactResolution |
integer (int64) Определяет результат по умолчанию для распределенных транзакций, которые не удалось разрешить координатору распределенных транзакций Microsoft (MS DTC). Такие транзакции называются сомнительными распределенными транзакциями. Возможные значения:
См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 2 включительно. |
config. sqlserverConfig_2016Sp2. userConfig. optimizeForAdHocWorkloads |
boolean (boolean) Определяет, следует ли кэшировать планы запросов только после второго выполнения. Позволяет избежать раздувания кэша SQL из-за одноразовых планов. См. подробное описание в документации SQL Server. |
config. sqlserverConfig_2016Sp2. userConfig. crossDbOwnershipChaining |
boolean (boolean) Включает цепочку владения между базами данных. Пример: имея явный доступ к хранимой процедуре в одной базе данных, которая ссылается на объект в другой базе данных, к которой у вас нет явного доступа, вы сможете выполнить процедуру без ошибки, связанной с разрешением. См. подробное описание в документации SQL Server. |
config. sqlserverConfig_2016Sp2. defaultConfig |
object Конфигурация кластера SQL Server 2016 SP2 по умолчанию. Здесь перечислены поддерживаемые параметры конфигурации SQL Server 2016 SP2. Подробное описание всех параметров доступно в документации SQL Server. Любые параметры, не перечисленные здесь, не поддерживаются. |
config. sqlserverConfig_2016Sp2. defaultConfig. maxDegreeOfParallelism |
integer (int64) Ограничивает число процессоров, задействованных для параллельного выполнения плана для каждой задачи. См. подробное описание в документации SQL Server. Допустимые значения — от 1 до 99 включительно. |
config. sqlserverConfig_2016Sp2. defaultConfig. costThresholdForParallelism |
integer (int64) Задает пороговое значение, при котором SQL Server создает и выполняет параллельные планы для запросов. SQL Server создает и выполняет параллельный план для запроса только в том случае, если расчетная стоимость выполнения последовательного плана для того же запроса превышает значение этого параметра. См. подробное описание в документации SQL Server. Допустимые значения — от 5 до 32767 включительно. |
config. sqlserverConfig_2016Sp2. defaultConfig. sqlcollation |
string Набор правил сортировки, используемых базами данных экземпляра. Определяет, являются ли базы данных экземпляра чувствительными к регистру, акценту и т. д. См. подробное описание в документации SQL Server. |
config. sqlserverConfig_2016Sp2. defaultConfig. auditLevel |
integer (int64) Настройки аудита входа, необходимого для мониторинга активности подключения к компоненту SQL Server Database Engine. Возможные значения:
См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 3 включительно. |
config. sqlserverConfig_2016Sp2. defaultConfig. filestreamAccessLevel |
integer (int64) Определяет уровень доступа Возможные значения:
См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 2 включительно. |
config. sqlserverConfig_2016Sp2. defaultConfig. fillFactorPercent |
integer (int64) Задает коэффициент заполнения. Когда индекс создается или перестраивается, коэффициент заполнения отображает процент заполнения пространства каждой страницы конечного уровня, что позволяет зарезервировать оставшееся пространство как свободное — для будущего расширения. Значения 0 и 100 означают полное заполнение страницы (свободное место не резервируется). См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 100 включительно. |
config. sqlserverConfig_2016Sp2. defaultConfig. inDoubtXactResolution |
integer (int64) Определяет результат по умолчанию для распределенных транзакций, которые не удалось разрешить координатору распределенных транзакций Microsoft (MS DTC). Такие транзакции называются сомнительными распределенными транзакциями. Возможные значения:
См. подробное описание в документации SQL Server. Допустимые значения — от 0 до 2 включительно. |
config. sqlserverConfig_2016Sp2. defaultConfig. optimizeForAdHocWorkloads |
boolean (boolean) Определяет, следует ли кэшировать планы запросов только после второго выполнения. Позволяет избежать раздувания кэша SQL из-за одноразовых планов. См. подробное описание в документации SQL Server. |
config. sqlserverConfig_2016Sp2. defaultConfig. crossDbOwnershipChaining |
boolean (boolean) Включает цепочку владения между базами данных. Пример: имея явный доступ к хранимой процедуре в одной базе данных, которая ссылается на объект в другой базе данных, к которой у вас нет явного доступа, вы сможете выполнить процедуру без ошибки, связанной с разрешением. См. подробное описание в документации SQL Server. |
networkId | string Идентификатор сети, к которой принадлежит кластер. |
health | string Здоровье кластера.
|
status | string Текущее состояние кластера.
|