Подключиться
Yandex Managed Service for SQL Server™

Метод listHosts

Возвращает список хостов для указанного кластера SQL Server.

HTTP-запрос

GET https://mdb.api.cloud.yandex.net/mdb/sqlserver/v1alpha/clusters/{clusterId}/hosts

Path-параметры

Параметр Описание
clusterId Обязательное поле. Идентификатор кластера SQL Server. Чтобы получить идентификатор кластера SQL Server, используйте запрос list. Максимальная длина строки в символах — 50.

Query-параметры

Параметр Описание
pageSize Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем page_size, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно.
pageToken Токен страницы. Установите значение page_token равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

Ответ

HTTP Code: 200 - OK

{
  "hosts": [
    {
      "name": "string",
      "clusterId": "string",
      "zoneId": "string",
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      },
      "role": "string",
      "health": "string",
      "services": [
        {
          "type": "string",
          "health": "string"
        }
      ],
      "subnetId": "string",
      "assignPublicIp": true
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
hosts[] object

Список хостов SQL Server.
hosts[].
name		 string

Имя хоста SQL Server. Имя хоста Managed Service for SQL Server назначает во время создания, его нельзя изменить. Длина 1-63 символов.

Имя уникально для всех существующих хостов баз данных в Яндекс.Облаке, так как оно определяет полное доменное имя (FQDN) хоста.
hosts[].
clusterId		 string

Идентификатор хоста SQL Server. Этот идентификатор Managed Service for SQL Server генерирует при создании.
hosts[].
zoneId		 string

Идентификатор зоны доступности, в которой находится хост SQL Server.
hosts[].
resources		 object

Ресурсы, выделенные хосту.
hosts[].
resources.
resourcePresetId		 string

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

Объем хранилища, доступного хосту.
hosts[].
resources.
diskTypeId		 string

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

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

  • network-hdd — сетевой HDD-диск;
  • network-ssd — сетевой SSD-диск;
  • local-ssd — локальное SSD-хранилище.
hosts[].
role		 string

Роль хоста в кластере.

  • ROLE_UNKNOWN: Роль хоста в кластере неизвестна.
  • MASTER: Хост является мастером в кластере SQL Server.
  • REPLICA: Хост является репликой в кластере SQL Server.
hosts[].
health		 string

Код работоспособности хоста.

  • HEALTH_UNKNOWN: Состояние хоста неизвестно.
  • ALIVE: Хост работает и выполняет все свои функции.
  • DEAD: Хост не работает и не может выполнять свои основные функции.
  • DEGRADED: Хост деградировал, и может выполнять только некоторые из своих основных функций.
hosts[].
services[]		 object

Сервисы, предоставляемые хостом.
hosts[].
services[].
type		 string

Тип сервиса, предоставляемого хостом.

  • SQLSERVER: Служба SQL Server
hosts[].
services[].
health		 string

Код состояния доступности сервера.

  • HEALTH_UNKNOWN: Работоспособность сервера неизвестна.
  • ALIVE: Сервер работает нормально.
  • DEAD: Сервер отключен или не отвечает.
hosts[].
subnetId		 string

Идентификатор подсети, к которой принадлежит хост.
hosts[].
assignPublicIp		 boolean (boolean)

Флаг, показывающий статус публичного IP-адреса для этого хоста.
nextPageToken string

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