get-health-check

Описание

Получает информацию о заданном проверочном элементе.

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

Синтаксис

  get-health-check
--health-check-id <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]

Параметры

--health-check-id (строка)

Идентификатор, назначенный Amazon Route 53 проверочному элементу при его создании. При добавлении или обновлении записи ресурса вы используете это значение для указания проверочного элемента. Значение может содержать до 64 символов.

--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
текст
таблица
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.

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

Получение информации о проверочном элементе

Следующая get-health-check команда получает информацию о проверочном элементе с health-check-id 02ec8401-9879-4259-91fa-04e66d094674:

aws route53 get-health-check --health-check-id 02ec8401-9879-4259-91fa-04e66d094674

Вывод

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

Сложный тип, содержащий информацию об одном проверочном элементе, связанном с текущей учетной записью Amazon Web Services.

Id -> (строка)

CallerReference -> (строка)

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

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

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

ServicePrincipal -> (строка)

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

Description -> (строка)

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

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

Сложный тип, содержащий подробную информацию об одном контроле работоспособности.

IPAddress -> (строка)

IP-адрес IPv4 или IPv6 конечной точки, для которой Amazon Route 53 должен выполнить проверку работоспособности. Если вы не укажете значение для IPAddress, Route 53 отправляет запрос DNS для разрешения доменного имени, указанного в FullyQualifiedDomainName, с интервалом, заданным в RequestInterval. Используя IP-адрес, возвращенный DNS, Route 53 проверяет работоспособность конечной точки.

Используйте один из следующих форматов для значения IPAddress:

IP-адрес IPv4: четыре значения от 0 до 255, разделенные точками (.), например, 192.0.2.44.
IP-адрес IPv6: восемь групп из четырех шестнадцатеричных значений, разделенных двоеточиями (:), например, 2001:0db8:85a3:0000:0000:abcd:0001:2345. Вы также можете сократить IP-адреса IPv6, как описано в RFC 5952, например, 2001:db8:85a3::abcd:1:2345.

Если конечная точка является экземпляром EC2, рекомендуется создать Elastic IP-адрес, ассоциировать его с вашим экземпляром EC2 и указать Elastic IP-адрес для IPAddress. Это гарантирует, что IP-адрес вашего экземпляра никогда не изменится.

Дополнительную информацию см. в разделе FullyQualifiedDomainName.

Ограничения: Route 53 не может проверять работоспособность конечных точек, IP-адреса которых находятся в локальных, частных, немаршрутизируемых или мультивещательных диапазонах. Дополнительную информацию об IP-адресах, для которых вы не можете создать проверки работоспособности, см. в следующих документах:

RFC 5735, Специальные IP-адреса IPv4
RFC 6598, Зарезервированный префикс IPv4 IANA для общего адресного пространства
RFC 5156, IP-адреса 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 -> (строка)

Путь (если есть), который вы хотите, чтобы Amazon Route 53 запрашивал при выполнении проверок работоспособности. Путь может быть любым значением, при котором ваша конечная точка вернет HTTP-код состояния 2xx или 3xx, когда конечная точка работоспособна, например, файл /docs/route53-health-check.html. Вы также можете включить параметры запроса, например, /welcome.html?language=jp&login=y.

FullyQualifiedDomainName -> (строка)

Поведение Amazon Route 53 зависит от того, указываете ли вы значение для IPAddress.

Если вы указываете значение для IPAddress:

Amazon Route 53 отправляет запросы проверки работоспособности на указанный IP-адрес 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. Используя IP-адрес IPv4, возвращенный DNS, 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 -> (булево)

Укажите, хотите ли вы, чтобы Amazon Route 53 инвертировал статус проверки работоспособности, например, чтобы считать проверку работоспособности неработоспособной, когда в противном случае она считалась бы работоспособной.

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.

Name -> (строка)

Имя оповещения CloudWatch, которое вы хотите использовать средствам проверки работоспособности Amazon Route 53 для определения того, является ли эта проверка работоспособности здоровой.

Примечание

Route 53 поддерживает оповещения CloudWatch со следующими функциями:

Метрики с разрешением по умолчанию. Метрики с высоким разрешением не поддерживаются. Дополнительную информацию см. в разделе Метрики с высоким разрешением в Руководстве пользователя Amazon CloudWatch.
Статистики: Среднее, Минимальное, Максимальное, Сумма и SampleCount. Расширенные статистики не поддерживаются.

InsufficientDataHealthStatus -> (строка)

Когда у CloudWatch недостаточно данных о метрике для определения состояния оповещения, статус, который вы хотите, чтобы Amazon Route 53 присвоил проверке работоспособности:

Healthy: Route 53 считает проверку работоспособности здоровой.
Unhealthy: Route 53 считает проверку работоспособности нездоровой.
LastKnownStatus: Route 53 использует статус проверки работоспособности с последнего момента, когда у CloudWatch было достаточно данных для определения состояния оповещения. Для новых проверок работоспособности, у которых нет последнего известного статуса, по умолчанию статус проверки работоспособности — здоровый.

RoutingControlArn -> (строка)

Идентификатор ресурса Amazon (ARN) для управления маршрутизацией Route 53 Application Recovery Controller.

Дополнительную информацию о Route 53 Application Recovery Controller см. в Руководстве разработчика Route 53 Application Recovery Controller.

HealthCheckVersion -> (длинное целое число)

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

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

Сложный тип, содержащий информацию об оповещении CloudWatch, которое Amazon Route 53 отслеживает для этой проверки работоспособности.

EvaluationPeriods -> (целое число)

Для метрики, связанной с оповещением CloudWatch, количество периодов, в течение которых метрика сравнивается с пороговым значением.

Threshold -> (двойное значение)

Для метрики, связанной с оповещением CloudWatch, значение, с которым сравнивается метрика.

ComparisonOperator -> (строка)

Для метрики, связанной с оповещением CloudWatch, арифметическая операция, используемая для сравнения.

Period -> (целое число)

Для метрики, связанной с оповещением CloudWatch, продолжительность одного периода оценки в секундах.

MetricName -> (строка)

Имя метрики CloudWatch, связанной с оповещением.

Namespace -> (строка)

Имя пространства имён метрики, связанной с оповещением. Дополнительную информацию см. в разделе Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference в Руководстве пользователя Amazon CloudWatch.

Statistic -> (строка)

Для метрики, связанной с оповещением CloudWatch, статистика, применяемая к метрике.

Dimensions -> (список)

Для метрики, связанной с оповещением CloudWatch, сложный тип, содержащий информацию о измерениях для метрики. Дополнительную информацию см. в разделе Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference в Руководстве пользователя Amazon CloudWatch.

(структура)

Для метрики, связанной с оповещением CloudWatch, сложный тип, содержащий информацию об одном измерении.

Name -> (строка)

Для метрики, связанной с оповещением CloudWatch, имя одного измерения.

Value -> (строка)

Для метрики, связанной с оповещением CloudWatch, значение одного измерения.