Spec-Zone.ru › AWS CLI v2

[ aws ]

Здоровье

Описание

API «Здоровье» предоставляет доступ к информации о состоянии, отображаемой на панели мониторинга здоровья. Вы можете использовать операции API, чтобы получить информацию о событиях, которые могут повлиять на ваши Amazon Web Services-сервисы и ресурсы.

Для использования API «Здоровье» требуется план поддержки Business, Enterprise On-Ramp или Enterprise от Amazon Web Services Support. Если вы вызываете API «Здоровье» из учетной записи Amazon Web Services, у которой нет плана Business, Enterprise On-Ramp или Enterprise Support, вы получите ошибку SubscriptionRequiredException.

Для доступа к API необходимы идентификатор ключа доступа и секретный ключ доступа. Используйте временные учетные данные вместо долгосрочных ключей доступа, когда это возможно. Временные учетные данные включают идентификатор ключа доступа, секретный ключ доступа и маркер безопасности, указывающий срок действия учетных данных. Дополнительную информацию см. в разделе «Рекомендации по управлению ключами доступа Amazon Web Services» в Справочнике по Amazon Web Services.

Для вызова операций API «Здоровье» можно использовать конечную точку health.us-east-1.amazonaws.com (HTTPS). API «Здоровье» поддерживает многорегиональную архитектуру приложения и имеет две региональные конечные точки в конфигурации актив/резерв. Вы можете использовать пример высокодоступной конечной точки для определения активного региона Amazon Web Services, чтобы получать последнюю информацию из API. Дополнительную информацию см. в разделе «Доступ к API «Здоровье» в Руководстве пользователя API «Здоровье».

Для аутентификации запросов API «Здоровье» используется процесс подписи версии 4.

Если ваша учетная запись Amazon Web Services входит в состав Организаций, вы можете использовать функцию организационного представления API «Здоровье». Эта функция предоставляет централизованный обзор событий «Здоровья» по всем учетным записям в вашей организации. Вы можете агрегировать события «Здоровья» в режиме реального времени, чтобы определить учетные записи в вашей организации, которые затронуты операционным событием, или получить уведомления о уязвимостях безопасности. Используйте операции API организационного представления, чтобы включить эту функцию и получить информацию о событиях. Дополнительную информацию см. в разделе «Агрегирование событий «Здоровья» в Руководстве пользователя API «Здоровье».

Примечание

При использовании операций API «Здоровье» для возврата событий «Здоровья», имейте в виду следующие рекомендации:

  • Используйте параметр eventScopeCode, чтобы указать, нужно ли возвращать общедоступные или частные события «Здоровья».
  • Используйте постраничный вывод, чтобы просмотреть все события из ответа. Например, если вы вызываете операцию DescribeEventsForOrganization для получения всех событий в вашей организации, вы можете получить несколько страниц результатов. Укажите nextToken в следующем запросе, чтобы получить больше результатов.

Доступные команды

  • описать-затронутые-учетные-записи-для-организации
  • описать-затронутые-сущности
  • описать-затронутые-сущности-для-организации
  • описать-сущности-агрегаты
  • описать-сущности-агрегаты-для-организации
  • описать-агрегаты-событий
  • описать-детали-события
  • описать-детали-события-для-организации
  • описать-типы-событий
  • описать-события
  • описать-события-для-организации
  • описать-статус-сервиса-здоровья-для-организации
  • отключить-доступ-к-сервису-здоровья-для-организации
  • включить-доступ-к-сервису-здоровья-для-организации

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

Spec-Zone.ru

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