Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

тест-сигнализация

Описание

Проверяет сигнализацию, отображая баннер на консоли Amazon Lightsail. Если для указанной сигнализации настроена триггерная нотификация, тест также отправит уведомление в протокол уведомлений (Email и/или SMS ), настроенный для сигнализации.

Сигнализация используется для мониторинга одного метрического показателя для одного из ваших ресурсов. Когда выполняется условие метрики, сигнализация может уведомить вас по электронной почте, SMS-сообщением и баннером, отображаемым на консоли Amazon Lightsail. Дополнительная информация содержится в разделе Сигнализации в Amazon Lightsail.

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

Синтаксис

  test-alarm
--alarm-name <value>
--state <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]

Параметры

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

Название сигнализации для проверки.

--state (строка)

Состояние сигнализации для проверки.

Сигнализация может иметь следующие возможные состояния, которые могут быть проверены:

  • ALARM - Метрика находится вне заданного порога.
  • INSUFFICIENT_DATA - Сигнализация только что началась, метрика недоступна или для метрики недостаточно данных, чтобы определить состояние сигнализации.
  • OK - Метрика находится в пределах заданного порога.

Возможные значения:

  • OK
  • ALARM
  • INSUFFICIENT_DATA

--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-auto-prompt (логическое значение)

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

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

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

Вывод

операции -> (список)

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

(структура)

Описывает операцию API.

id -> (строка)

Идентификатор операции.

resourceName -> (строка)

Имя ресурса.

resourceType -> (строка)

Тип ресурса.

createdAt -> (метка времени)

Метка времени инициализации операции (1479816991.349).

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

Регион и зона доступности Amazon Web Services.

availabilityZone -> (строка)

Зона доступности. Следует формату us-east-2a (регистрозависимо).

regionName -> (строка)

Название региона Amazon Web Services.

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

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

operationDetails -> (строка)

Подробности об операции (Debian-1GB-Ohio-1).

operationType -> (строка)

Тип операции.

status -> (строка)

Состояние операции.

statusChangedAt -> (метка времени)

Метка времени изменения состояния (1479816991.349).

errorCode -> (строка)

Код ошибки.

errorDetails -> (строка)

Подробности об ошибке.

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

Spec-Zone.ru

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