Spec-Zone.ru › AWS CLI v2

[ aws . opensearch ]

describe-domain-health

Описание

Возвращает информацию о состоянии домена и узлов, резервную зону доступности, количество узлов в каждой зоне доступности и количество фрагментов на каждый узел.

См. также: Документацию API AWS

Синтаксис

  describe-domain-health
--domain-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--domain-name (строка)

Имя домена.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения перекроют значения, предоставленные через JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного через JSON, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если указано без значения или со значением input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, выведет пример YAML-ввода, который можно использовать с --cli-input-yaml. Если указано со значением output, проверяет входные данные команды и возвращает пример JSON-вывода для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости для сгенерированного JSON-скелета.

Глобальные параметры

--debug (логическое значение)

Включить отладочную запись.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

  • вкл
  • выкл
  • авто

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот параметр указан.

--ca-bundle (строка)

Файл с пакетом сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающегося в двоичном блоке, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла необходимо правильно отформатировать для заданной настройки cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить пагинацию CLI для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать входные параметры CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы входных параметров CLI.

Вывод

DomainState -> (строка)

Текущее состояние домена.

  • Processing - В домене выполняются обновления.
  • Active - Запрошенные изменения были обработаны и развернуты в домене.

AvailabilityZoneCount -> (строка)

Количество зон доступности, настроенных для домена. Если служба не может получить эту информацию, она вернет NotAvailable.

ActiveAvailabilityZoneCount -> (строка)

Количество активных зон доступности, настроенных для домена. Если служба не может получить эту информацию, она вернет NotAvailable.

StandByAvailabilityZoneCount -> (строка)

Количество резервных зон доступности, настроенных для домена. Если служба не может получить эту информацию, она вернет NotAvailable.

DataNodeCount -> (строка)

Количество узлов данных, настроенных для домена. Если служба не может получить эту информацию, она вернет NotAvailable.

DedicatedMaster -> (логическое значение)

Логическое значение, указывающее, активированы ли выделенные мастер-узлы для домена.

MasterEligibleNodeCount -> (строка)

Количество узлов, которые могут быть избраны в качестве мастер-узла. Если выделенные мастер-узлы включены, это значение равно количеству выделенных мастер-узлов, настроенных для домена. Если служба не может получить эту информацию, она вернет NotAvailable.

WarmNodeCount -> (строка)

Количество тёплых узлов, настроенных для домена.

MasterNode -> (строка)

Указывает, имеет ли домен избранный мастер-узел.

  • Доступно - Домен имеет избранный мастер-узел.
  • Недоступно - Мастер-узел еще не избран, и кворум для избрания нового мастер-узла еще не достигнут.

ClusterHealth -> (строка)

Текущее состояние здоровья вашего кластера.

  • Red - По крайней мере, один первичный фрагмент не назначен ни одному узлу.
  • Yellow - Все первичные фрагменты назначены узлам, но некоторые реплики нет.
  • Green - Все первичные фрагменты и их реплики назначены узлам.
  • NotAvailable - Невозможно получить состояние здоровья кластера.

TotalShards -> (строка)

Общее количество первичных и реплицированных фрагментов для домена.

TotalUnAssignedShards -> (строка)

Общее количество первичных и реплицированных фрагментов, не назначенных ни одному из узлов кластера.

EnvironmentInformation -> (список)

Список EnvironmentInfo для домена.

(структура)

Информация об активной среде домена.

AvailabilityZoneInformation -> (список)

Список AvailabilityZoneInfo для домена.

(структура)

Информация о зоне доступности в домене.

AvailabilityZoneName -> (строка)

Имя зоны доступности.

ZoneStatus -> (строка)

Текущее состояние зоны доступности. Текущие варианты — Active и StandBy.

  • Active - Узлы данных в зоне доступности используются.
  • StandBy - Узлы данных в зоне доступности находятся в режиме ожидания.
  • NotAvailable - Невозможно получить информацию.

ConfiguredDataNodeCount -> (строка)

Общее количество узлов данных, настроенных в зоне доступности.

AvailableDataNodeCount -> (строка)

Количество активных узлов данных в зоне доступности.

TotalShards -> (строка)

Общее количество первичных и реплицированных фрагментов в зоне доступности.

TotalUnAssignedShards -> (строка)

Общее количество первичных и реплицированных фрагментов, не назначенных ни одному из узлов в зоне доступности.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API