Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Решения
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex Managed Service for SQL Server™
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Информация об имеющихся кластерах
    • Создание кластера
    • Подключение к базе данных
    • Остановка и запуск кластера
    • Изменение настроек кластера и базы данных
    • Управление хостами SQL Server
    • Управление базами данных
    • Управление пользователями
    • Назначение привилегий и ролей
    • Управление резервными копиями
    • Удаление кластера
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Классы хостов
    • Сеть в Managed Service for SQL Server
    • Квоты и лимиты
    • Типы хранилища
    • Резервные копии
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC
      • Обзор
      • BackupService
      • ClusterService
      • DatabaseService
      • OperationService
      • ResourcePresetService
      • UserService
      • OperationService
    • REST
      • Обзор
      • Backup
        • Обзор
        • get
        • list
      • Cluster
        • Обзор
        • backup
        • create
        • delete
        • get
        • list
        • listBackups
        • listHosts
        • listLogs
        • listOperations
        • move
        • restore
        • start
        • stop
        • update
      • Database
        • Обзор
        • create
        • delete
        • get
        • list
      • Operation
        • Обзор
        • get
      • ResourcePreset
        • Обзор
        • get
        • list
      • User
        • Обзор
        • create
        • delete
        • get
        • grantPermission
        • list
        • revokePermission
        • update
  • Вопросы и ответы
    • Общие вопросы
  1. Справочник API
  2. REST
  3. Cluster
  4. list

Метод list

  • HTTP-запрос
  • Query-параметры
  • Ответ

Получает список кластеров SQL Server, принадлежащих указанному каталогу.

HTTP-запрос

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

Query-параметры

Параметр Описание
folderId Обязательное поле. Идентификатор каталога, для которого нужно получить список кластеров SQL Server. Чтобы получить идентификатор каталога, используйте запрос list. Максимальная длина строки в символах — 50.
pageSize Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем page_size, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно.
pageToken Токен страницы. Установите значение page_token равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
filter Выражение, позволяющее отфильтровать информацию о ресурсах в ответе, оставив только нужную. В этом выражении должны быть указаны: 1. Имя поля, по которому нужно выполнить фильтрацию. В настоящее время фильтрацию можно использовать только по полю Cluster.name. 2. Условный оператор. Поддерживаются операторы = и != для одиночных значений, IN и NOT IN для списков значений. 3. Значение. Должно содержать от 1 до 63 символов и соответствовать регулярному выражению ^[a-zA-Z0-9_-]+$. Пример фильтра: name NOT IN 'test,beta'. Максимальная длина строки в символах — 1000.

Ответ

HTTP Code: 200 - OK

{
  "clusters": [
    {
      "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"
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
clusters[] object

Кластер SQL Server. Для получения дополнительной информации см. раздел документации Взаимосвязь ресурсов сервиса.

clusters[].
id
string

Идентификатор кластера SQL Server. Этот идентификатор Managed Service for SQL Server генерирует при создании.

clusters[].
folderId
string

Идентификатор каталога, которому принадлежит кластер SQL Server.

clusters[].
createdAt
string (date-time)

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

clusters[].
name
string

Имя кластера SQL Server.

Имя должно быть уникальным в каталоге, соответствовать RFC 1035 и иметь длину 1-63 символа.

clusters[].
description
string

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

clusters[].
labels
object

Пользовательские метки для кластера SQL Server в виде пар key:value. Максимум 64 на ресурс.

clusters[].
environment
string

Среда развертывания кластера SQL Server.

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

Описание систем мониторинга, относящихся к кластеру SQL Server.

clusters[].
monitoring[].
name
string

Название системы мониторинга.

clusters[].
monitoring[].
description
string

Описание системы мониторинга.

clusters[].
monitoring[].
link
string

Ссылка на графики системы мониторинга для кластера SQL Server.

clusters[].
config
object

Конфигурация кластера SQL Server.

clusters[].
config.
version
string

Версия SQL Server.

clusters[].
config.
resources
object
Ресурсы, выделенные хостам SQL Server.
clusters[].
config.
resources.
resourcePresetId
string

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

clusters[].
config.
resources.
diskSize
string (int64)

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

clusters[].
config.
resources.
diskTypeId
string

Тип хранилища для хоста.

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

  • network-hdd — сетевой HDD-диск;
  • network-ssd — сетевой SSD-диск;
  • local-ssd — локальное SSD-хранилище.
clusters[].
config.
backupWindowStart
object
Время запуска ежедневного резервного копирования, в часовом поясе UTC.

Время суток. Дата и часовой пояс либо не учитываются, либо задаются в других местах.

API может разрешить использование високосной секунды.

Связанные типы: google.type.Date и google.protobuf.Timestamp.

clusters[].
config.
backupWindowStart.
hours
integer (int32)

Часы. Допустимые значения: от 0 до 23.

API может разрешить использовать значение в формате "24:00:00" в требующих этого сценариях (например, для указания времени закрытия учреждения).

clusters[].
config.
backupWindowStart.
minutes
integer (int32)

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

clusters[].
config.
backupWindowStart.
seconds
integer (int32)

Секунды. Стандартные допустимые значения: от 0 до 59.

API может разрешить использовать значение 60, если также разрешено использование високосной секунды.

clusters[].
config.
backupWindowStart.
nanos
integer (int32)

Доли секунды (в наносекундах). Допустимые значения: от 0 до 999999999.

clusters[].
config.
sqlserverConfig_2016Sp2
object
Конфигурация экземпляра SQL Server 2016sp2.
clusters[].
config.
sqlserverConfig_2016Sp2.
effectiveConfig
object

Действующие настройки для кластера SQL Server 2016 SP2 (сочетание параметров, определенных в userConfig и defaultConfig).

Здесь перечислены поддерживаемые параметры конфигурации SQL Server 2016 SP2.

Подробное описание всех параметров доступно в документации SQL Server.

Любые параметры, не перечисленные здесь, не поддерживаются.

clusters[].
config.
sqlserverConfig_2016Sp2.
effectiveConfig.
maxDegreeOfParallelism
integer (int64)

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

См. подробное описание в документации SQL Server.

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

clusters[].
config.
sqlserverConfig_2016Sp2.
effectiveConfig.
costThresholdForParallelism
integer (int64)

Задает пороговое значение, при котором SQL Server создает и выполняет параллельные планы для запросов.

SQL Server создает и выполняет параллельный план для запроса только в том случае, если расчетная стоимость выполнения последовательного плана для того же запроса превышает значение этого параметра.

См. подробное описание в документации SQL Server.

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

clusters[].
config.
sqlserverConfig_2016Sp2.
effectiveConfig.
sqlcollation
string

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

См. подробное описание в документации SQL Server.

clusters[].
config.
sqlserverConfig_2016Sp2.
effectiveConfig.
auditLevel
integer (int64)

Настройки аудита входа, необходимого для мониторинга активности подключения к компоненту SQL Server Database Engine.

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

  • 0 — не регистрировать попытки входа в систему,
  • 1 — регистрировать только неудачные попытки входа в систему,
  • 2 — регистрировать только успешные попытки входа в систему (не рекомендуется),
  • 3 — регистрировать все попытки входа в систему (не рекомендуется).

См. подробное описание в документации SQL Server.

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

clusters[].
config.
sqlserverConfig_2016Sp2.
effectiveConfig.
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 включительно.

clusters[].
config.
sqlserverConfig_2016Sp2.
effectiveConfig.
fillFactorPercent
integer (int64)

Задает коэффициент заполнения. Когда индекс создается или перестраивается, коэффициент заполнения отображает процент заполнения пространства каждой страницы конечного уровня, что позволяет зарезервировать оставшееся пространство как свободное — для будущего расширения.

Значения 0 и 100 означают полное заполнение страницы (свободное место не резервируется).

См. подробное описание в документации SQL Server.

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

clusters[].
config.
sqlserverConfig_2016Sp2.
effectiveConfig.
inDoubtXactResolution
integer (int64)

Определяет результат по умолчанию для распределенных транзакций, которые не удалось разрешить координатору распределенных транзакций Microsoft (MS DTC). Такие транзакции называются сомнительными распределенными транзакциями.

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

  • 0 — нет автоматического разрешения. Восстановление завершится неуспешно, если MS DTC не сможет разрешить какую-либо сомнительную транзакцию.
  • 1 — сомнительные транзакции считаются подтвержденными,
  • 2 — сомнительные транзакции считаются неподтвержденными и будут откачены.

См. подробное описание в документации SQL Server.

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

clusters[].
config.
sqlserverConfig_2016Sp2.
effectiveConfig.
optimizeForAdHocWorkloads
boolean (boolean)

Определяет, следует ли кэшировать планы запросов только после второго выполнения. Позволяет избежать раздувания кэша SQL из-за одноразовых планов.

См. подробное описание в документации SQL Server.

clusters[].
config.
sqlserverConfig_2016Sp2.
effectiveConfig.
crossDbOwnershipChaining
boolean (boolean)

Включает цепочку владения между базами данных.

Пример: имея явный доступ к хранимой процедуре в одной базе данных, которая ссылается на объект в другой базе данных, к которой у вас нет явного доступа, вы сможете выполнить процедуру без ошибки, связанной с разрешением.

См. подробное описание в документации SQL Server.

clusters[].
config.
sqlserverConfig_2016Sp2.
userConfig
object

Пользовательские параметры для кластера SQL Server 2016 SP2.

Здесь перечислены поддерживаемые параметры конфигурации SQL Server 2016 SP2.

Подробное описание всех параметров доступно в документации SQL Server.

Любые параметры, не перечисленные здесь, не поддерживаются.

clusters[].
config.
sqlserverConfig_2016Sp2.
userConfig.
maxDegreeOfParallelism
integer (int64)

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

См. подробное описание в документации SQL Server.

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

clusters[].
config.
sqlserverConfig_2016Sp2.
userConfig.
costThresholdForParallelism
integer (int64)

Задает пороговое значение, при котором SQL Server создает и выполняет параллельные планы для запросов.

SQL Server создает и выполняет параллельный план для запроса только в том случае, если расчетная стоимость выполнения последовательного плана для того же запроса превышает значение этого параметра.

См. подробное описание в документации SQL Server.

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

clusters[].
config.
sqlserverConfig_2016Sp2.
userConfig.
sqlcollation
string

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

См. подробное описание в документации SQL Server.

clusters[].
config.
sqlserverConfig_2016Sp2.
userConfig.
auditLevel
integer (int64)

Настройки аудита входа, необходимого для мониторинга активности подключения к компоненту SQL Server Database Engine.

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

  • 0 — не регистрировать попытки входа в систему,
  • 1 — регистрировать только неудачные попытки входа в систему,
  • 2 — регистрировать только успешные попытки входа в систему (не рекомендуется),
  • 3 — регистрировать все попытки входа в систему (не рекомендуется).

См. подробное описание в документации SQL Server.

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

clusters[].
config.
sqlserverConfig_2016Sp2.
userConfig.
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 включительно.

clusters[].
config.
sqlserverConfig_2016Sp2.
userConfig.
fillFactorPercent
integer (int64)

Задает коэффициент заполнения. Когда индекс создается или перестраивается, коэффициент заполнения отображает процент заполнения пространства каждой страницы конечного уровня, что позволяет зарезервировать оставшееся пространство как свободное — для будущего расширения.

Значения 0 и 100 означают полное заполнение страницы (свободное место не резервируется).

См. подробное описание в документации SQL Server.

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

clusters[].
config.
sqlserverConfig_2016Sp2.
userConfig.
inDoubtXactResolution
integer (int64)

Определяет результат по умолчанию для распределенных транзакций, которые не удалось разрешить координатору распределенных транзакций Microsoft (MS DTC). Такие транзакции называются сомнительными распределенными транзакциями.

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

  • 0 — нет автоматического разрешения. Восстановление завершится неуспешно, если MS DTC не сможет разрешить какую-либо сомнительную транзакцию.
  • 1 — сомнительные транзакции считаются подтвержденными,
  • 2 — сомнительные транзакции считаются неподтвержденными и будут откачены.

См. подробное описание в документации SQL Server.

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

clusters[].
config.
sqlserverConfig_2016Sp2.
userConfig.
optimizeForAdHocWorkloads
boolean (boolean)

Определяет, следует ли кэшировать планы запросов только после второго выполнения. Позволяет избежать раздувания кэша SQL из-за одноразовых планов.

См. подробное описание в документации SQL Server.

clusters[].
config.
sqlserverConfig_2016Sp2.
userConfig.
crossDbOwnershipChaining
boolean (boolean)

Включает цепочку владения между базами данных.

Пример: имея явный доступ к хранимой процедуре в одной базе данных, которая ссылается на объект в другой базе данных, к которой у вас нет явного доступа, вы сможете выполнить процедуру без ошибки, связанной с разрешением.

См. подробное описание в документации SQL Server.

clusters[].
config.
sqlserverConfig_2016Sp2.
defaultConfig
object

Конфигурация кластера SQL Server 2016 SP2 по умолчанию.

Здесь перечислены поддерживаемые параметры конфигурации SQL Server 2016 SP2.

Подробное описание всех параметров доступно в документации SQL Server.

Любые параметры, не перечисленные здесь, не поддерживаются.

clusters[].
config.
sqlserverConfig_2016Sp2.
defaultConfig.
maxDegreeOfParallelism
integer (int64)

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

См. подробное описание в документации SQL Server.

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

clusters[].
config.
sqlserverConfig_2016Sp2.
defaultConfig.
costThresholdForParallelism
integer (int64)

Задает пороговое значение, при котором SQL Server создает и выполняет параллельные планы для запросов.

SQL Server создает и выполняет параллельный план для запроса только в том случае, если расчетная стоимость выполнения последовательного плана для того же запроса превышает значение этого параметра.

См. подробное описание в документации SQL Server.

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

clusters[].
config.
sqlserverConfig_2016Sp2.
defaultConfig.
sqlcollation
string

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

См. подробное описание в документации SQL Server.

clusters[].
config.
sqlserverConfig_2016Sp2.
defaultConfig.
auditLevel
integer (int64)

Настройки аудита входа, необходимого для мониторинга активности подключения к компоненту SQL Server Database Engine.

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

  • 0 — не регистрировать попытки входа в систему,
  • 1 — регистрировать только неудачные попытки входа в систему,
  • 2 — регистрировать только успешные попытки входа в систему (не рекомендуется),
  • 3 — регистрировать все попытки входа в систему (не рекомендуется).

См. подробное описание в документации SQL Server.

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

clusters[].
config.
sqlserverConfig_2016Sp2.
defaultConfig.
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 включительно.

clusters[].
config.
sqlserverConfig_2016Sp2.
defaultConfig.
fillFactorPercent
integer (int64)

Задает коэффициент заполнения. Когда индекс создается или перестраивается, коэффициент заполнения отображает процент заполнения пространства каждой страницы конечного уровня, что позволяет зарезервировать оставшееся пространство как свободное — для будущего расширения.

Значения 0 и 100 означают полное заполнение страницы (свободное место не резервируется).

См. подробное описание в документации SQL Server.

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

clusters[].
config.
sqlserverConfig_2016Sp2.
defaultConfig.
inDoubtXactResolution
integer (int64)

Определяет результат по умолчанию для распределенных транзакций, которые не удалось разрешить координатору распределенных транзакций Microsoft (MS DTC). Такие транзакции называются сомнительными распределенными транзакциями.

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

  • 0 — нет автоматического разрешения. Восстановление завершится неуспешно, если MS DTC не сможет разрешить какую-либо сомнительную транзакцию.
  • 1 — сомнительные транзакции считаются подтвержденными,
  • 2 — сомнительные транзакции считаются неподтвержденными и будут откачены.

См. подробное описание в документации SQL Server.

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

clusters[].
config.
sqlserverConfig_2016Sp2.
defaultConfig.
optimizeForAdHocWorkloads
boolean (boolean)

Определяет, следует ли кэшировать планы запросов только после второго выполнения. Позволяет избежать раздувания кэша SQL из-за одноразовых планов.

См. подробное описание в документации SQL Server.

clusters[].
config.
sqlserverConfig_2016Sp2.
defaultConfig.
crossDbOwnershipChaining
boolean (boolean)

Включает цепочку владения между базами данных.

Пример: имея явный доступ к хранимой процедуре в одной базе данных, которая ссылается на объект в другой базе данных, к которой у вас нет явного доступа, вы сможете выполнить процедуру без ошибки, связанной с разрешением.

См. подробное описание в документации SQL Server.

clusters[].
networkId
string

Идентификатор сети, к которой принадлежит кластер.

clusters[].
health
string

Здоровье кластера.

  • HEALTH_UNKNOWN: Состояние кластера неизвестно (health всех хостов в кластере — UNKNOWN).
  • ALIVE: Кластер работает нормально (health всех хостов в кластере — ALIVE).
  • DEAD: Кластер не работает (health всех хостов в кластере — DEAD).
  • DEGRADED: Кластер находится в состоянии деградации (health по крайней мере одного из хостов в кластере — не ALIVE).
clusters[].
status
string

Текущее состояние кластера.

  • STATUS_UNKNOWN: Состояние кластера неизвестно.
  • CREATING: Кластер создается.
  • RUNNING: Кластер работает нормально.
  • ERROR: В кластере произошла ошибка, блокирующая работу.
  • UPDATING: Кластер изменяется.
  • STOPPING: Кластер останавливается.
  • STOPPED: Кластер остановлен.
  • STARTING: Кластер запускается.
nextPageToken string

Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте next_page_token в качестве значения параметра pageToken в следующем запросе. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

В этой статье:
  • HTTP-запрос
  • Query-параметры
  • Ответ
Language
Вакансии
Политика конфиденциальности
Условия использования
© 2021 ООО «Яндекс.Облако»