Spec-Zone.ru › AWS CLI v2

[ aws . servicediscovery ]

get-instances-health-status

Описание

Получает текущий статус работоспособности (Healthy , Unhealthy , или Unknown ) одного или нескольких экземпляров, связанных с указанной службой.

Примечание

Существует небольшая задержка между регистрацией экземпляра и доступностью статуса его работоспособности.

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

Синтаксис

  get-instances-health-status
--service-id <value>
[--instances <value>]
[--max-results <value>]
[--next-token <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]

Параметры

--service-id (строка)

Идентификатор службы, к которой прикреплён экземпляр.

--instances (список)

Массив, содержащий идентификаторы всех экземпляров, для которых требуется получить статус работоспособности.

Если вы опустите Instances , Cloud Map возвращает статус работоспособности для всех экземпляров, связанных с указанной службой.

Примечание

Чтобы получить идентификаторы зарегистрированных экземпляров, используйте запрос ListInstances.

(строка)

Синтаксис:

"string" "string" ...

--max-results (целое число)

Максимальное количество экземпляров, которое Cloud Map должен вернуть в ответ на запрос GetInstancesHealthStatus. Если вы не укажете значение для MaxResults , Cloud Map вернёт до 100 экземпляров.

--next-token (строка)

Для первого запроса GetInstancesHealthStatus опустите это значение.

Если более MaxResults экземпляров соответствуют указанным критериям, можно отправить другой запрос GetInstancesHealthStatus для получения следующей группы результатов. Укажите значение NextToken из предыдущего ответа в следующем запросе.

--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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы с AWS CLI в руководстве пользователя AWS CLI.

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

Чтобы получить статус работоспособности экземпляров, связанных со службой

Следующий пример get-instances-health-status получает статус работоспособности экземпляров, связанных с указанной службой.

aws servicediscovery get-instances-health-status \
    --service-id srv-e4anhexample0004

Вывод:

{
    "Status": {
        "i-abcd1234": "HEALTHY",
        "i-abcd1235": "UNHEALTHY"
    }
}

Дополнительную информацию см. в разделе Экземпляры службы AWS Cloud Map в руководстве разработчика AWS Cloud Map.

Вывод

Статус -> (карта)

Сложный тип, содержащий идентификаторы и статус работоспособности экземпляров, указанных в запросе GetInstancesHealthStatus.

ключ -> (строка)

значение -> (строка)

NextToken -> (строка)

Если более MaxResults экземпляров соответствуют указанным критериям, можно отправить другой запрос GetInstancesHealthStatus для получения следующей группы результатов. Укажите значение NextToken из предыдущего ответа в следующем запросе.

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

Spec-Zone.ru

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