Метод listHosts

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

Получает список хостов для указанного кластера.

HTTP-запрос

GET https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/{clusterId}/hosts

Path-параметры

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

Query-параметры

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

Параметр

Описание

pageSize

Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.

pageToken

Токен страницы. Установите значение pageToken равным значению поля 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,
      "shardName": "string",
      "type": "string"
    }
  ],
  "nextPageToken": "string"
}

Поле	Описание
hosts[]	object Список ресурсов Host.
hosts[]. name	string Имя хоста MongoDB. Имя хоста назначается MDB во время создания и не может быть изменено. Длина 1-63 символов. Имя уникально для всех существующих хостов MDB в Яндекс.Облаке, так как оно определяет полное доменное имя (FQDN) хоста.
hosts[]. clusterId	string Идентификатор хоста MongoDB. Этот идентификатор генерирует MDB при создании.
hosts[]. zoneId	string Идентификатор зоны доступности, в которой находится хост MongoDB.
hosts[]. resources	object Ресурсы, выделенные хосту MongoDB.
hosts[]. resources. resourcePresetId	string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в documentation.
hosts[]. resources. diskSize	string (int64) Объем хранилища, доступного хосту, в байтах.
hosts[]. resources. diskTypeId	string Тип хранилища для хоста. Возможные значения: network-hdd — сетевой HDD-диск; network-nvme — сетевой SSD-диск; local-nvme — локальное SSD-хранилище.
hosts[]. role	string Роль хоста в кластере. ROLE_UNKNOWN: Роль хоста в кластере неизвестна. PRIMARY: Хост является основным сервером MongoDB в кластере. SECONDARY: Хост является вторичным сервером MongoDB в кластере.
hosts[]. health	string Код работоспособности хоста. HEALTH_UNKNOWN: Состояние хоста неизвестно. ALIVE: Хозяин выполняет все свои функции нормально. DEAD: Хост не работает и не может выполнять свои основные функции. DEGRADED: Хост деградировал, и может выполнять только некоторые из своих основных функций.
hosts[]. services[]	object Сервисы, предоставляемые хостом.
hosts[]. services[]. type	string Тип сервиса, предоставляемого хостом. MONGOD: На хосте работает демон mongod. MONGOS: На хосте работает демон mongos. MONGOCFG: На хосте работает сервер конфигураций MongoDB.
hosts[]. services[]. health	string Код состояния доступности сервера. HEALTH_UNKNOWN: Работоспособность сервера неизвестна. ALIVE: Сервер работает нормально. DEAD: Сервер отключен или не отвечает.
hosts[]. subnetId	string Идентификатор подсети, к которой принадлежит хост.
hosts[]. assignPublicIp	boolean (boolean) Флаг, показывающий статус публичного IP-адреса для этого хоста.
hosts[]. shardName	string Шард, которому принадлежит этот этот хост.
hosts[]. type	string Тип хоста
nextPageToken	string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.