Как настроить уведомления об истечении срока действия

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация

Используйте оповещение об истечении срока действия TLS, чтобы получать уведомления, когда срок действия сертификата TLS в среде подходит к концу.

О сертификатах TLS

TLS (Transport Layer Security) – это стандартная технология безопасности, которая позволяет установить зашифрованное соединение между веб-сервером и веб-клиентом, например браузером или приложением. Зашифрованное соединение гарантирует, что все данные, передаваемые между сервером и клиентом, останутся конфиденциальными.

Сертификат TLS – это цифровой файл, который идентифицирует объект в транзакции TLS. Edge использует сертификат TLS для настройки TLS для следующих целей:

У сертификата TLS есть срок действия. Если срок действия сертификата TLS истекает, TLS-подключение не будет работать, пока вы не обновите сертификат. Это означает, что все запросы к вашему API будут отклоняться, пока вы не обновите сертификат.

Оповещения об истечении срока действия

Вместо того чтобы ждать, пока срок действия сертификата истечет и запросы к API начнут завершаться неудачей, используйте оповещение об истечении срока действия, чтобы получать уведомления, когда срок действия любого сертификата TLS в среде подходит к концу. После того как сработает оповещение, вы можете обновить сертификат, чтобы клиенты не заметили перебоев в работе сервиса.

При настройке оповещения не указывайте отдельный сертификат, а выберите определенную среду. Оповещение срабатывает, когда срок действия любого развернутого сертификата истекает в указанном диапазоне времени.

Оповещение о сроке действия можно настроить на следующие даты:

  • за один день до истечения срока действия сертификата;
  • за 14 дней до истечения срока действия сертификата;
  • за 30 дней до истечения срока действия сертификата;
Подробнее о настройке оповещений и уведомлений…

Как добавить оповещения об истечении срока действия

Чтобы добавить уведомления об истечении срока действия:
  1. В интерфейсе Edge нажмите Analyze (Анализ) > Alert Rules (Правила оповещений).
  2. Нажмите + Оповещение.
  3. Укажите следующую общую информацию об оповещении:
    Поле Описание
    Название оповещения Название оповещения. Используйте название, которое описывает триггер и будет понятно вам. Длина названия не должна превышать 128 символов.
    Описание Описание оповещения.
    Тип оповещения Выберите Срок действия TLS. Подробнее о типах оповещений…
    Среда Выберите среду в раскрывающемся списке.
    Статус Переключатель, с помощью которого можно включать и отключать оповещения
  4. Задайте пороговое значение и параметр для условия, при котором будет срабатывать оповещение.
    Поле условия Описание
    Пороговое значение

    Настройте временной диапазон для сертификатов с истекающим сроком действия. Вы можете настроить оповещение, которое будет появляться, когда срок действия сертификата истекает через:

    • 1 день
    • 14 дней
    • 30 дней
    Параметр Параметр имеет фиксированное значение Любые сертификаты TLS, соответствующее любому сертификату TLS в среде.
  5. Нажмите + Уведомление, чтобы добавить оповещение.
    Данные об уведомлении Описание
    Канал Выберите канал уведомлений и укажите получателя: электронную почту, Slack, PagerDuty или веб-перехватчик.
    Место назначения Укажите целевой канал в зависимости от его типа:
    • Электронная почта – адрес электронной почты, например joe@company.com.
    • Slack – URL канала Slack, например https://hooks.slack.com/services/T00000000/B00000000/XXXXX.
    • PagerDuty – код PagerDuty, например abcd1234efgh56789.
    • Вебхук – URL вебхука, например https://apigee.com/test-webhook.

      Примечание. Для каждого уведомления можно указать только один пункт назначения. Чтобы указать несколько адресов для одного типа канала, добавьте дополнительные уведомления.
  6. Чтобы добавить другие уведомления, повторите предыдущий шаг.
  7. Если вы добавили уведомление, задайте следующие поля:
    Поле Описание
    Пособие для авторов (Необязательно.) Текстовое поле для краткого описания рекомендуемых действий по устранению оповещений при их активации. Вы также можете указать ссылку на внутреннюю вики-страницу или страницу сообщества, где описаны рекомендации. Информация из этого поля будет включена в уведомление. В этом поле можно ввести не более 1500 символов.
    Дроссель Частота отправки уведомлений. Выберите значение из раскрывающегося списка.
  8. Нажмите Сохранить.

Как просматривать оповещения на панели управления событиями

Когда Edge обнаруживает условие оповещения, оно автоматически регистрируется на панели управления События в интерфейсе Edge. Список событий на панели "События" включает все оповещения, как исправленные, так и сертификационные.

Чтобы посмотреть оповещение:

  1. В интерфейсе Edge нажмите Analyze > Events (Анализировать > События). Откроется новая панель "События".

  2. На информационной панели "События" можно отфильтровать данные по следующим параметрам:

    • Среда
    • Регион
    • срок;
  3. Выберите строку на панели управления событиями, чтобы посмотреть хранилище ключей, содержащее сертификат с истекающим сроком действия, и изучить оповещение. На странице "Хранилище ключей" можно загрузить новый сертификат и удалить старый, срок действия которого истекает.

Как использовать API оповещений с оповещениями об истечении срока действия

Большинство API, которые используются для создания и управления оповещениями об истечении срока действия, такие же, как и для оповещений с фиксированной датой. Следующие API оповещений работают одинаково для оповещений с фиксированной датой и с датой истечения срока действия:

Однако у некоторых API есть дополнительные свойства, которые используются для поддержки оповещений об аномалиях, в том числе:

Как создать или изменить оповещение об истечении срока действия

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

  • Чтобы указать, что оповещение связано с истечением срока действия, добавьте следующие новые свойства:

    "alertType": "cert"
"alertSubType": "certfixed"

    Значения по умолчанию для этих свойств:

    "alertType": "runtime"
"alertSubType": "fixed"

  • В массиве conditions:

    • Свойство metrics может принимать только значения expiration.
    • Свойство gracePeriodSeconds позволяет указать срок действия сертификата в секундах (максимум 30 дней).
    • Свойства threshold, durationSeconds и comparator не поддерживаются.
  • В элементе dimensions массива conditions:
    • Для свойства certificate необходимо задать значение ANY.
    • Для свойства proxy необходимо задать значение ALL.
    • Свойства statusCode, developerApp, collection, faultCodeCategory, faultCodeSubCategory и faultCodeName не поддерживаются.
  • Ресурс reportEnabled не поддерживается для оповещений об истечении срока действия.

В следующем примере вызова API создается оповещение об истечении срока действия, которое срабатывает, когда срок действия любого сертификата в среде prod истекает в течение следующих 30 дней. При срабатывании оповещения на указанный адрес электронной почты отправляется уведомление:

curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
 -X POST \
 -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -d '{
  "organization":"myorg",
  "name":"My Cert Expiry Alert",
  "description":"My Cert Expiry Alert",
  "environment":"prod",
  "enabled":true,
  "alertType": "cert",
  "alertSubType": "certfixed",
  "conditions":[
  {
    "description":"My Cert Expiry Alert",
    "dimensions":{
      "org":"myorg",
      "env":"prod",
      "proxy":"ALL",
      "certificate": "ANY"
    },
    "metric":"expiration",
    "gracePeriodSeconds": 2592000
  }],
  "notifications":[{
    "channel":"email",
    "destination":"ops@acme.com"
  }],
  "playbook":"http://acme.com/pb.html",
  "throttleIntervalSeconds":3600,
  "reportEnabled":false
}'

Установите для параметра $ACCESS_TOKEN токен доступа OAuth 2.0, как описано в разделе Получение токена доступа OAuth 2.0. Информацию о параметрах cURL, используемых в этом примере, можно найти в разделе Как использовать cURL.

Как получать уведомления об истечении срока действия

По умолчанию API Get Alerts возвращает информацию обо всех заданных оповещениях, как с фиксированной датой, так и с датой окончания. Теперь этот API принимает параметры запроса, позволяющие фильтровать результаты:

  • enabled – если в поле true указано, что нужно возвращать только включенные оповещения. Значение по умолчанию – false.
  • alertType – указывает тип оповещения, которое нужно вернуть. Допустимые значения: runtime (по умолчанию) и cert.
  • alertSubType – указывает подтип оповещения, который нужно вернуть. Значение по умолчанию не задано, то есть возвращаются все подтипы оповещений. Укажите certfixed, чтобы получать уведомления об истечении срока действия.

Например, чтобы получить только включенные оповещения для организации с названием myorg, используйте следующий вызов API:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

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

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=cert&alertSubType=certfixed'

Установите для параметра $ACCESS_TOKEN токен доступа OAuth 2.0, как описано в разделе Получение токена доступа OAuth 2.0. Информацию о параметрах cURL, используемых в этом примере, можно найти в разделе Как использовать cURL.