list-health-checks
Описание
Получение списка проверок работоспособности, связанных с текущей учетной записью Amazon Web Services.
См. также: Документацию API AWS
list-health-checks — это операция с постраничной выборкой. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную выборку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной выборкой, аргумент --query должен извлечь данные из результатов следующих выражений запроса: HealthChecks
Синтаксис
list-health-checks
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--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]
Параметры
--max-items (строка)
Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды будет указано NextToken. Чтобы продолжить постраничную выборку, укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничная выборка в Руководстве пользователя AWS Command Line Interface.
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные через JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного через JSON, так как строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Маркер для указания начала постраничной выборки. Это NextToken из ранее укороченного ответа.
Примеры использования см. в разделе Постраничная выборка в Руководстве пользователя AWS Command Line Interface.
--page-size (строка)
Размер каждой страницы при вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничная выборка в Руководстве пользователя AWS Command Line Interface.
--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
- table
- yaml
- yaml-stream
--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-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запроса параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Подробности см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования, похожие на Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для перечисления проверок работоспособности, связанных с текущей учетной записью AWS
Следующая list-health-checks команда перечисляет подробную информацию о первых 100 проверках работоспособности, связанных с текущей учетной записью AWS:
aws route53 list-health-checks
Если у вас более 100 проверок работоспособности или если вы хотите перечислить их группами меньше 100, включите параметр --maxitems. Например, чтобы перечислить проверки работоспособности по одной, используйте следующую команду:
aws route53 list-health-checks --max-items 1
Чтобы просмотреть следующую проверку работоспособности, возьмите значение NextToken из ответа на предыдущую команду и включите его в параметр --starting-token, например:
aws route53 list-health-checks --max-items 1 --starting-token Z3M3LMPEXAMPLE
Вывод
HealthChecks -> (список)
Сложный тип, содержащий по одному элементу HealthCheck для каждой проверки работоспособности, связанной с текущей учетной записью Amazon Web Services.
(структура)
Сложный тип, содержащий информацию об одной проверке работоспособности, связанной с текущей учетной записью Amazon Web Services.
Id -> (строка)
CallerReference -> (строка)
LinkedService -> (структура)
Если проверка работоспособности была создана другим сервисом, то сервис, который создал проверку работоспособности. Когда проверка работоспособности создается другим сервисом, вы не можете ее редактировать или удалять с помощью Amazon Route 53.
ServicePrincipal -> (строка)
Description -> (строка)
HealthCheckConfig -> (структура)
Сложный тип, содержащий подробную информацию об одном контроле работоспособности.
IPAddress -> (строка)
IPv4 или IPv6 IP-адрес конечной точки, для которой Amazon Route 53 должен выполнить проверку работоспособности. Если вы не укажете значение для IPAddress, Route 53 отправляет запрос DNS для разрешения доменного имени, указанного в FullyQualifiedDomainName, с интервалом, указанным в RequestInterval. Используя IP-адрес, возвращенный DNS, Route 53 проверяет работоспособность конечной точки.
Используйте один из следующих форматов для значения IPAddress:
-
IPv4-адрес : четыре значения от 0 до 255, разделенные точками (.), например,
192.0.2.44. -
IPv6-адрес : восемь групп из четырех шестнадцатеричных значений, разделенных двоеточиями (:), например,
2001:0db8:85a3:0000:0000:abcd:0001:2345. Вы также можете сократить IPv6-адреса, как описано в RFC 5952, например,2001:db8:85a3::abcd:1:2345.
Если конечная точка является экземпляром EC2, рекомендуется создать Elastic IP-адрес, ассоциировать его с экземпляром EC2 и указать Elastic IP-адрес для IPAddress. Это гарантирует, что IP-адрес вашего экземпляра никогда не изменится.
Дополнительную информацию см. в разделе FullyQualifiedDomainName.
Ограничения: Route 53 не может проверять работоспособность конечных точек, IP-адреса которых находятся в локальных, частных, немаршрутизируемых или мультивещательных диапазонах. Дополнительную информацию об IP-адресах, для которых нельзя создать проверки работоспособности, см. в следующих документах:
- RFC 5735, Специальные IPv4-адреса
- RFC 6598, Зарезервированный IANA IPv4-префикс для общего адресного пространства
- RFC 5156, Специальные IPv6-адреса
Когда значение Type равно CALCULATED или CLOUDWATCH_METRIC, опустите IPAddress.
Port -> (целое число)
Порт на конечной точке, для которой Amazon Route 53 должен выполнить проверку работоспособности.
Примечание
Не указывайте значение дляPort, если вы указали значение для Type как CLOUDWATCH_METRIC или CALCULATED.Type -> (строка)
Тип проверки работоспособности, который вы хотите создать, указывающий, как Amazon Route 53 определяет, является ли конечная точка работоспособной.
Предупреждение
Вы не можете изменить значениеType после создания проверки работоспособности.Вы можете создать следующие типы проверок работоспособности:
- HTTP : Route 53 пытается установить TCP-соединение. В случае успеха Route 53 отправляет HTTP-запрос и ожидает HTTP-код состояния 200 или выше и меньше 400.
- HTTPS : Route 53 пытается установить TCP-соединение. В случае успеха Route 53 отправляет HTTPS-запрос и ожидает HTTP-код состояния 200 или выше и меньше 400.
Предупреждение
Если вы укажетеHTTPS в качестве значения для Type, конечная точка должна поддерживать TLS v1.0, v1.1 или v1.2.-
HTTP_STR_MATCH : Route 53 пытается установить TCP-соединение. В случае успеха Route 53 отправляет HTTP-запрос и ищет строку, которую вы указали в
SearchString, в первых 5120 байтах тела ответа. -
HTTPS_STR_MATCH : Route 53 пытается установить TCP-соединение. В случае успеха Route 53 отправляет
HTTPS-запрос и ищет строку, которую вы указали вSearchString, в первых 5120 байтах тела ответа. - TCP : Route 53 пытается установить TCP-соединение.
-
CLOUDWATCH_METRIC : Проверка работоспособности связана с сигнализацией CloudWatch. Если состояние сигнализации равно
OK, проверка работоспособности считается работоспособной. Если состояние равноALARM, проверка работоспособности считается неработоспособной. Если CloudWatch не имеет достаточных данных для определения, является ли состояниеOKилиALARM, статус проверки работоспособности зависит от настроекInsufficientDataHealthStatus:Healthy,UnhealthyилиLastKnownStatus. -
CALCULATED : Для проверок работоспособности, которые контролируют состояние других проверок работоспособности, Route 53 суммирует количество проверок работоспособности, которые Route 53-проверяющие считают работоспособными, и сравнивает это число со значением
HealthThreshold. -
RECOVERY_CONTROL : Проверка работоспособности связана с контролем маршрутизации Route53 Application Recovery Controller. Если состояние контроля маршрутизации равно
ON, проверка работоспособности считается работоспособной. Если состояние равноOFF, проверка работоспособности считается неработоспособной.
Дополнительную информацию см. в разделе Как Route 53 определяет работоспособность конечной точки в Руководстве разработчика Amazon Route 53.
ResourcePath -> (строка)
/welcome.html?language=jp&login=y.FullyQualifiedDomainName -> (строка)
Поведение Amazon Route 53 зависит от того, указываете ли вы значение для IPAddress.
IPAddress:Amazon Route 53 отправляет запросы на проверку работоспособности на указанный IPv4 или IPv6 адрес и передает значение FullyQualifiedDomainName в заголовке Host для всех проверок работоспособности, кроме проверок работоспособности TCP. Как правило, это полное доменное имя конечной точки, на которой вы хотите, чтобы Route 53 выполнял проверки работоспособности.
При проверке работоспособности конечной точки Route 53 строит заголовок Host следующим образом:
- Если вы указали значение
80дляPortиHTTPилиHTTP_STR_MATCHдляType, Route 53 передает значениеFullyQualifiedDomainNameконечной точке в заголовке Host. - Если вы указали значение
443дляPortиHTTPSилиHTTPS_STR_MATCHдляType, Route 53 передает значениеFullyQualifiedDomainNameконечной точке в заголовкеHost. - Если вы указали другое значение для
Portи любое значение, кромеTCP, дляType, Route 53 передаетFullyQualifiedDomainName:Portконечной точке в заголовкеHost.
Если вы не укажете значение для FullyQualifiedDomainName, Route 53 подставит значение IPAddress в заголовок Host в каждом из предыдущих случаев.
IPAddress:Route 53 отправляет запрос DNS в домен, который вы указали для FullyQualifiedDomainName, с интервалом, который вы указали для RequestInterval. Используя возвращенный DNS IPv4-адрес, Route 53 проверяет работоспособность конечной точки.
Примечание
Если вы не укажете значение дляIPAddress, Route 53 будет использовать только IPv4 для отправки проверок работоспособности конечной точке. Если нет записей ресурсов с типом A для имени, которое вы указали для FullyQualifiedDomainName, проверка работоспособности завершится с ошибкой "Не удалось разрешить DNS".Если вы хотите проверить работоспособность взвешенных, по задержке или по резервированию записей ресурсов, и вы выбираете указать конечную точку только по FullyQualifiedDomainName, рекомендуется создать отдельную проверку работоспособности для каждой конечной точки. Например, создайте проверку работоспособности для каждого HTTP-сервера, предоставляющего контент для www.example.com. В качестве значения для FullyQualifiedDomainName укажите доменное имя сервера (например, us-east-2-www.example.com), а не имя записей ресурсов (www.example.com).
Предупреждение
В этой конфигурации, если вы создаете проверку работоспособности, для которой значениеFullyQualifiedDomainName совпадает с именем записей ресурсов, и затем связываете проверку работоспособности с этими записями ресурсов, результаты проверки работоспособности будут непредсказуемыми.Кроме того, если значение, указанное для Type, равно HTTP, HTTPS, HTTP_STR_MATCH или HTTPS_STR_MATCH, Route 53 передает значение FullyQualifiedDomainName в заголовке Host, как и при указании значения для IPAddress. Если значение Type равно TCP, Route 53 не передает заголовок Host.
SearchString -> (строка)
Если значение Type равно HTTP_STR_MATCH или HTTPS_STR_MATCH, строка, которую вы хотите, чтобы Amazon Route 53 искал в теле ответа от указанного ресурса. Если строка появляется в теле ответа, Route 53 считает ресурс работоспособным.
Route 53 учитывает регистр при поиске SearchString в теле ответа.
RequestInterval -> (целое число)
Количество секунд между моментом, когда Amazon Route 53 получает ответ от вашей конечной точки, и моментом, когда он отправляет следующий запрос на проверку работоспособности. Каждый проверяющий Route 53 отправляет запросы с этим интервалом.
Предупреждение
Вы не можете изменить значениеRequestInterval после создания проверки работоспособности.Если вы не укажете значение для RequestInterval, значение по умолчанию составляет 30 секунд.
FailureThreshold -> (целое число)
Количество последовательных проверок работоспособности, которые должна пройти или не пройти конечная точка, чтобы Amazon Route 53 изменил текущий статус конечной точки с неработоспособного на работоспособный или наоборот. Дополнительную информацию см. в разделе Как Amazon Route 53 определяет работоспособность конечной точки в Руководстве разработчика Amazon Route 53.
Если вы не укажете значение для FailureThreshold, значение по умолчанию составляет три проверки.
MeasureLatency -> (булево)
Укажите, хотите ли вы, чтобы Amazon Route 53 измерял задержку между проверяющими в различных регионах Amazon Web Services и вашей конечной точкой, и отображал графики задержки CloudWatch на странице Проверки работоспособности в консоли Route 53.
Предупреждение
Вы не можете изменить значениеMeasureLatency после создания проверки работоспособности.Inverted -> (булево)
Disabled -> (булево)
Останавливает выполнение проверок работоспособности Route 53. При отключении проверки работоспособности происходит следующее:
- Проверки работоспособности, проверяющие состояние конечных точек: Route 53 прекращает отправку запросов к вашему приложению, серверу или другому ресурсу.
- Вычисленные проверки работоспособности: Route 53 прекращает агрегирование статуса связанных проверок работоспособности.
- Проверки работоспособности, отслеживающие оповещения CloudWatch: Route 53 прекращает мониторинг соответствующих метрик CloudWatch.
После отключения проверки работоспособности Route 53 считает статус проверки всегда работоспособным. Если вы настроите резервирование DNS, Route 53 продолжит маршрутизацию трафика к соответствующим ресурсам. Если вы хотите остановить маршрутизацию трафика к ресурсу, измените значение Inverted.
Плата за проверку работоспособности по-прежнему взимается, даже если проверка отключена. Для получения дополнительной информации см. Цены на Amazon Route 53.
HealthThreshold -> (целое число)
Количество дочерних проверок работоспособности, связанных с CALCULATED проверкой работоспособности, которое Amazon Route 53 должно считать работоспособным, чтобы CALCULATED проверка работоспособности считалась работоспособной. Для указания дочерних проверок работоспособности, которые вы хотите связать с CALCULATED проверкой работоспособности, используйте элемент ChildHealthChecks.
Обратите внимание на следующее:
- Если вы укажете число, большее, чем количество дочерних проверок работоспособности, Route 53 всегда будет считать эту проверку неработоспособной.
- Если вы укажете
0, Route 53 всегда будет считать эту проверку работоспособной.
ChildHealthChecks -> (список)
(Только вычисленные проверки работоспособности) Сложный тип, содержащий один элемент ChildHealthCheck для каждой проверки работоспособности, которую вы хотите связать с CALCULATED проверкой работоспособности.
(строка)
EnableSNI -> (булево)
Укажите, хотите ли вы, чтобы Amazon Route 53 отправлял значение FullyQualifiedDomainName конечной точке в сообщении client_hello во время TLS-переговоров. Это позволяет конечной точке отвечать на запросы проверки работоспособности HTTPS с соответствующим сертификатом SSL/TLS.
Некоторые конечные точки требуют, чтобы запросы HTTPS содержали имя хоста в сообщении client_hello. Если вы не включили SNI, статус проверки работоспособности будет SSL alert handshake_failure. Статус проверки работоспособности может быть таким и по другим причинам. Если SNI включен, а ошибка всё ещё возникает, проверьте конфигурацию SSL/TLS на вашей конечной точке и убедитесь, что ваш сертификат действителен.
Сертификат SSL/TLS на вашей конечной точке содержит имя домена в поле Common Name и, возможно, несколько других в поле Subject Alternative Names. Одно из имён доменов в сертификате должно соответствовать значению, которое вы указали для FullyQualifiedDomainName. Если конечная точка отвечает на сообщение client_hello с сертификатом, не содержащим имя домена, которое вы указали в FullyQualifiedDomainName, средство проверки работоспособности повторит рукопожатие. При второй попытке средство проверки работоспособности опустит FullyQualifiedDomainName из сообщения client_hello.
Regions -> (список)
Сложный тип, содержащий один элемент Region для каждого региона, из которого средства проверки работоспособности Amazon Route 53 должны проверять указанную конечную точку.
Если вы не укажете регионы, средства проверки работоспособности Route 53 автоматически выполнят проверки из всех регионов, перечисленных в Допустимые значения.
Если вы обновите проверку работоспособности, чтобы удалить регион, который выполнял проверки работоспособности, Route 53 временно продолжит проверки из этого региона, чтобы убедиться, что некоторые средства проверки работоспособности всегда проверяют конечную точку (например, если вы заменяете три региона четырьмя разными).
(строка)
AlarmIdentifier -> (структура)
Сложный тип, определяющий оповещение CloudWatch, которое вы хотите использовать средствам проверки работоспособности Amazon Route 53 для определения того, работоспособна ли указанная проверка работоспособности.
Region -> (строка)
Регион создания оповещения CloudWatch, которое вы хотите использовать средствам проверки работоспособности Route 53 для определения того, работоспособна ли эта проверка работоспособности.
Список текущих регионов CloudWatch см. в разделе «Конечные точки и квоты Amazon CloudWatch» в Справочнике Amazon Web Services General Reference.
Name -> (строка)
Имя оповещения CloudWatch, которое вы хотите использовать средствам проверки работоспособности Amazon Route 53 для определения того, работоспособна ли эта проверка работоспособности.
Примечание
Route 53 поддерживает оповещения CloudWatch со следующими функциями:
- Метрики с обычным разрешением. Метрики с высоким разрешением не поддерживаются. Дополнительную информацию см. в разделе «Метрики с высоким разрешением» в Руководстве пользователя Amazon CloudWatch.
- Статистики: среднее значение, минимальное, максимальное, сумма и количество выборок. Расширенные статистики не поддерживаются.
InsufficientDataHealthStatus -> (строка)
Когда у CloudWatch недостаточно данных о метрике для определения состояния оповещения, статус, который вы хотите назначить проверке работоспособности Amazon Route 53:
-
Healthy: Route 53 считает проверку работоспособности работоспособной. -
Unhealthy: Route 53 считает проверку работоспособности неработоспособной. -
LastKnownStatus: Route 53 использует статус проверки работоспособности с последнего момента, когда CloudWatch имело достаточно данных для определения состояния оповещения. Для новых проверок работоспособности, у которых нет последнего известного статуса, значение по умолчанию для статуса проверки работоспособности — работоспособный.
RoutingControlArn -> (строка)
Идентификатор ресурса Amazon (ARN) для управления маршрутизацией контроллера восстановления приложения Route 53.
Дополнительную информацию о контроллере восстановления приложения Route 53 см. в Руководстве разработчика контроллера восстановления приложения Route 53.
HealthCheckVersion -> (длинное целое число)
UpdateHealthCheck, чтобы предотвратить перезапись другого изменения в проверке работоспособности.CloudWatchAlarmConfiguration -> (структура)
Сложный тип, содержащий информацию об оповещении CloudWatch, которое Amazon Route 53 отслеживает для этой проверки работоспособности.
EvaluationPeriods -> (целое число)
Threshold -> (двойное число)
ComparisonOperator -> (строка)
Period -> (целое число)
MetricName -> (строка)
Namespace -> (строка)
Statistic -> (строка)
Dimensions -> (список)
Для метрики, с которой связано оповещение CloudWatch, сложный тип, содержащий информацию о измерениях метрики. Дополнительную информацию см. в разделе «Пространства имен, измерения и метрики Amazon CloudWatch» в Руководстве пользователя Amazon CloudWatch.
(структура)
Для метрики, с которой связано оповещение CloudWatch, сложный тип, содержащий информацию об одном измерении.
Name -> (строка)
Value -> (строка)
Marker -> (строка)
ListHealthChecks, значение Marker — это значение, которое вы указали для параметра marker в предыдущем запросе.IsTruncated -> (булево)
ListHealthChecks и указав значение NextMarker в параметре marker.NextMarker -> (строка)
IsTruncated равно true, значение NextMarker определяет первую проверку работоспособности, которую Amazon Route 53 возвращает, если вы отправите ещё один запрос ListHealthChecks и укажете значение NextMarker в параметре marker.MaxItems -> (строка)
maxitems в вызове ListHealthChecks, который произвёл текущий ответ.
© Copyright 2025, Amazon Web Services. Created using Sphinx.