Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
Yandex Managed Service for MongoDB
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Информация об имеющихся кластерах
    • Создание кластера
    • Подключение к базе данных
      • Обзор способов подключения к базе данных
      • Подключение к нешардированному кластеру
      • Подключение к шардированному кластеру
    • Остановка и запуск кластера
    • Изменение настроек кластера и базы данных
    • Переключение первичной реплики
    • Обновление версии MongoDB
    • Управление базами данных
    • Управление хостами кластера
    • Управление пользователями БД
    • Управление резервными копиями
    • Управление шардами
    • Просмотр логов кластера
    • Удаление кластера
    • Мониторинг состояния кластера и хостов
    • Диагностика производительности
    • Инструменты для анализа производительности
  • Практические руководства
    • Все сценарии
    • Шардирование коллекций
    • Миграция данных в Managed Service for MongoDB
    • Миграция коллекций из стороннего кластера MongoDB
    • Анализ производительности и оптимизация MongoDB
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Классы хостов
      • Действующие классы хостов
      • Архив
        • До 1 июня 2020 года
      • Использование устаревших классов хостов
    • Сеть в Managed Service for MongoDB
    • Редакции MongoDB
    • Квоты и лимиты
    • Хранилище в Managed Service for MongoDB
    • Резервные копии
    • Репликация
    • Шардирование
    • Пользователи и роли
    • Техническое обслуживание
    • Поддерживаемые клиенты
    • Настройки MongoDB
  • Управление доступом
  • Правила тарификации
    • Действующие правила
    • Архив
      • До 1 января 2019 года
      • С 1 января до 1 марта 2019 года
      • С 1 марта 2019 года до 1 февраля 2020 года
  • Справочник API
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • BackupService
      • ClusterService
      • DatabaseService
      • ResourcePresetService
      • UserService
      • OperationService
    • REST (англ.)
      • Overview
      • Backup
        • Overview
        • delete
        • get
        • list
      • Cluster
        • Overview
        • addHosts
        • addShard
        • backup
        • create
        • delete
        • deleteHosts
        • deleteShard
        • enableSharding
        • get
        • getShard
        • list
        • listBackups
        • listHosts
        • listLogs
        • listOperations
        • listShards
        • move
        • rescheduleMaintenance
        • resetupHosts
        • restartHosts
        • restore
        • start
        • stepdownHosts
        • stop
        • streamLogs
        • update
      • Database
        • Overview
        • create
        • delete
        • get
        • list
      • ResourcePreset
        • Overview
        • get
        • list
      • User
        • Overview
        • create
        • delete
        • get
        • grantPermission
        • list
        • revokePermission
        • update
      • Operation
        • Overview
        • get
  • История изменений
  • Вопросы и ответы
    • Общие вопросы
    • Вопросы о MongoDB
    • Все вопросы на одной странице
  1. Справочник API
  2. REST (англ.)
  3. Cluster
  4. listHosts

Managed Service for MongoDB API, REST: Cluster.listHosts

Статья создана
Yandex Cloud
,
улучшена
amatol
  • HTTP request
  • Path parameters
  • Query parameters
  • Response

Retrieves a list of hosts for the specified cluster.

HTTP request

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

Path parameters

Parameter Description
clusterId

Required. ID of the MongoDB cluster. To get the MongoDB cluster ID, use a list request.

The maximum string length in characters is 50.

Query parameters

Parameter Description
pageSize

The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. Default value: 100.

The maximum value is 1000.

pageToken

Page token. To get the next page of results, set pageToken to the nextPageToken returned by the previous list request.

The maximum string length in characters is 100.

Response

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"
}
Field Description
hosts[] object

List of Host resources.

hosts[].
name
string

Name of the MongoDB host. The host name is assigned by MDB at creation time, and cannot be changed. 1-63 characters long.

The name is unique across all MDB hosts that exist on the platform, as it defines the FQDN of the host.

hosts[].
clusterId
string

ID of the MongoDB host. The ID is assigned by MDB at creation time.

hosts[].
zoneId
string

ID of the availability zone where the MongoDB host resides.

hosts[].
resources
object

Resources allocated to the MongoDB host.

hosts[].
resources.
resourcePresetId
string

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.

hosts[].
resources.
diskSize
string (int64)

Volume of the storage available to a host, in bytes.

hosts[].
resources.
diskTypeId
string

Type of the storage environment for the host. Possible values:

  • network-hdd - network HDD drive,
  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.
hosts[].
role
string

Role of the host in the cluster.

  • ROLE_UNKNOWN: Role of the host in the cluster is unknown.
  • PRIMARY: Host is the primary MongoDB server in the cluster.
  • SECONDARY: Host is a secondary MongoDB server in the cluster.
hosts[].
health
string

Status code of the aggregated health of the host.

  • HEALTH_UNKNOWN: Health of the host is unknown.
  • ALIVE: The host is performing all its functions normally.
  • DEAD: The host is inoperable, and cannot perform any of its essential functions.
  • DEGRADED: The host is degraded, and can perform only some of its essential functions.
hosts[].
services[]
object

Services provided by the host.

hosts[].
services[].
type
string

Type of the service provided by the host.

  • MONGOD: The host is running a mongod daemon.
  • MONGOS: The host is running a mongos daemon.
  • MONGOCFG: The host is running a MongoDB config server.
hosts[].
services[].
health
string

Status code of server availability.

  • HEALTH_UNKNOWN: Health of the server is unknown.
  • ALIVE: The server is working normally.
  • DEAD: The server is dead or unresponsive.
hosts[].
subnetId
string

ID of the subnet that the host belongs to.

hosts[].
assignPublicIp
boolean (boolean)

Flag showing public IP assignment status to this host.

hosts[].
shardName
string

Shard which this host belongs to.

hosts[].
type
string

Host type

  • MONGOD: A mongod host.
  • MONGOS: A mongos host.
  • MONGOCFG: A mongocfg host.
  • MONGOINFRA: A mongoinfra (mongos+mongocfg) host.
nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.

Была ли статья полезна?

Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
В этой статье:
  • HTTP request
  • Path parameters
  • Query parameters
  • Response