Benachrichtigungen zur Ablaufzeit einrichten

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation. Weitere Informationen

Verwenden Sie eine TLS-Ablaufbenachrichtigung, um Eine Benachrichtigung, wenn das TLS-Zertifikat in einer Umgebung bald abläuft.

TLS-Zertifikate

TLS (Transport Layer Security) ist die standardmäßige Sicherheitstechnologie, zum Herstellen einer verschlüsselten Verbindung zwischen einem Webserver und einem Webclient wie einem Browser oder einem Durch eine verschlüsselte Verbindung wird sichergestellt, dass alle zwischen Server und Client übertragenen Daten erhalten bleiben. privat.

Ein TLS-Zertifikat ist eine digitale Datei, die eine Entität in einer TLS-Transaktion identifiziert. Edge verwendet ein TLS- Zertifikat zum Konfigurieren von TLS für:

  • Zugriff auf Ihre API-Proxys von API-Clients. Virtuelle Hosts verwenden um TLS zu konfigurieren.
  • Zugriff auf Ihre Back-End-Dienste durch Edge. Zielendpunkte und Zielserver verwenden im Edge Message Processor, um TLS zu konfigurieren.

Ein TLS-Zertifikat enthält ein Ablaufdatum. Wenn ein TLS-Zertifikat abläuft, schlägt die TLS-Verbindung fehl bis Sie das Zertifikat aktualisieren. Das bedeutet, dass alle Anfragen an Ihre API fehlschlagen, bis Sie das Zertifikat aktualisieren.

Ablaufbenachrichtigungen

Anstatt auf den Ablauf eines Zertifikats zu warten und Anfragen an Ihre API fehlschlagen zu lassen, verwenden Sie ein Warnung bei Ablauf, die ausgelöst werden soll, Eine Benachrichtigung, wenn ein TLS-Zertifikat in einer Umgebung bald abläuft. Nachdem die Benachrichtigung ausgelöst wurde, können Sie das Zertifikat aktualisieren, damit Ihre Kunden keine Serviceunterbrechungen feststellen.

Geben Sie beim Konfigurieren der Benachrichtigung kein einzelnes Zertifikat an, sondern eine bestimmte Umgebung. Die Benachrichtigung wird ausgelöst, wenn ein bereitgestelltes Zertifikat geplant ist im angegebenen Zeitraum abläuft.

Sie können festlegen, dass die Ablaufbenachrichtigung gesendet wird:

  • 1 Tag vor Ablauf eines Zertifikats
  • 14 Tage vor Ablauf eines Zertifikats
  • 30 Tage vor Ablauf eines Zertifikats
Weitere Informationen zu Warnungen finden Sie unter Einrichten von Warnungen und Benachrichtigungen.

Ablaufbenachrichtigungen und -benachrichtigungen hinzufügen

So fügen Sie Ablaufbenachrichtigungen und -benachrichtigungen hinzu: <ph type="x-smartling-placeholder">
    </ph>
  1. Klicken Sie auf Analysieren > Benachrichtigungsregeln in der Edge-Benutzeroberfläche.
  2. Klicken Sie auf +Benachrichtigung.
  3. Geben Sie die folgenden allgemeinen Informationen zur Benachrichtigung ein:
    Feld Beschreibung
    Name der Benachrichtigung Name der Benachrichtigung. Verwenden Sie einen Namen, der den Trigger beschreibt und für Sie aussagekräftig ist. Der Name darf nicht länger als 128 Zeichen sein.
    Beschreibung Beschreibung der Benachrichtigung.
    Benachrichtigungstyp Wählen Sie TLS Expiry aus. Weitere Informationen finden Sie unter Weitere Informationen zu Benachrichtigungstypen
    Umgebung Wählen Sie die Umgebung aus der Drop-down-Liste aus.
    Status Benachrichtigung aktivieren bzw. deaktivieren.
  4. Definieren Sie den Schwellenwert und die Dimension für die Bedingung, durch die die Benachrichtigung ausgelöst wird.
    Bedingungsfeld Beschreibung
    Grenzwert

    Konfigurieren Sie den Zeitraum für die ablaufenden Zertifikate. Sie können eine Benachrichtigung senden, wenn ein Zertifikat abläuft in:

    • 1 Tag
    • 14 Tage
    • 30 Tage
    Dimension Als Werte sind Alle TLS-Zertifikate festgelegt, die eines beliebigen TLS-Zertifikats in der Umgebung.
  5. Klicken Sie auf + Benachrichtigung, um eine Benachrichtigung hinzuzufügen.
    Benachrichtigungsdetails Beschreibung
    Kanal Wählen Sie den zu verwendenden Benachrichtigungskanal aus und geben Sie das Ziel an: E-Mail, Slack, PagerDuty oder Webhook.
    Ziel Geben Sie das Ziel basierend auf dem ausgewählten Kanaltyp an: <ph type="x-smartling-placeholder">
      </ph>
    • E-Mail - E-Mail-Adresse wie joe@company.com
    • Slack – Slack-Kanal-URL, z. B. https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty – PagerDuty-Code, z. B. abcd1234efgh56789
    • Webhook - Webhook-URL wie https://apigee.com/test-webhook

      Hinweis: Sie können nur ein Ziel pro Benachrichtigung angeben. So geben Sie mehrere Ziele an: für denselben Kanaltyp, füge zusätzliche Benachrichtigungen hinzu.
  6. Wenn Sie weitere Benachrichtigungen hinzufügen möchten, wiederholen Sie den vorherigen Schritt.
  7. Wenn Sie eine Benachrichtigung hinzugefügt haben, legen Sie die folgenden Felder fest:
    Feld Beschreibung
    Playbook Optional: Kostenloses Textfeld mit einer kurzen Beschreibung der empfohlenen Maßnahmen zum Lösen wenn sie ausgelöst werden. Sie können auch einen Link zu Ihrem internen Wiki oder Ihrer Community-Seite angeben, Sie verweisen auf Best Practices. Die Informationen in diesem Feld werden in der Benachrichtigung berücksichtigt. Der Inhalt in diesem Feld darf 1500 Zeichen nicht überschreiten.
    Throttle Häufigkeit, mit der Benachrichtigungen gesendet werden. Wählen Sie einen Wert aus der Drop-down-Liste aus.
  8. Klicken Sie auf Speichern.

Benachrichtigungen im Ereignis-Dashboard ansehen

Wenn Edge einen Alarmzustand erkennt, protokolliert er diese Bedingung automatisch im Ereignisse-Dashboard in der Edge-Benutzeroberfläche. Liste der im Ereignis-Dashboard angezeigten Ereignisse enthält alle Benachrichtigungen, sowohl feste als auch Zertifikate.

So rufen Sie eine Benachrichtigung auf:

  1. Klicken Sie auf Analysieren > Ereignisse in der Edge-Benutzeroberfläche. Das neue Ereignis-Dashboard wird angezeigt:

  2. Filtern Sie das Ereignis-Dashboard nach:

    • Umgebung
    • Region
    • Zeitraum
  3. Wählen Sie im Ereignis-Dashboard eine Zeile aus, um den Schlüsselspeicher mit dem ablaufenden Zertifikat anzuzeigen die Benachrichtigung weiter untersuchen. Auf der Schlüsselspeicher-Seite können Sie ein neues Zertifikat hochladen und ablaufendes Zertifikat.

APIs für Benachrichtigungen mit Ablaufbenachrichtigungen verwenden

Die meisten der APIs, die Sie zum Erstellen und Verwalten von Ablaufbenachrichtigungen verwenden, sind dieselben wie die, die Sie verwenden mit festen Benachrichtigungen. Die folgenden APIs für Benachrichtigungen funktionieren sowohl für feste Benachrichtigungen als auch für Ablaufbenachrichtigungen auf die gleiche Weise:

Einige APIs verfügen jedoch über zusätzliche Eigenschaften, die zur Unterstützung von Anomaliebenachrichtigungen verwendet werden, darunter:

Ablaufbenachrichtigung erstellen oder aktualisieren

Verwenden Sie dieselben APIs zum Erstellen oder aktualisieren wie es bei einer festen Benachrichtigung der Fall ist. Der Text des API-Aufrufs, der erstellt oder aktualisiert werden soll Eine Ablaufbenachrichtigung entspricht der für eine feste Benachrichtigung, mit folgenden Änderungen:

  • Sie müssen die folgenden neuen Attribute hinzufügen, um anzugeben, dass die Benachrichtigung eine Ablaufbenachrichtigung ist:

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

    Die Standardwerte dieser Attribute sind:

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

  • Im Array conditions:

    • Das Attribut metrics akzeptiert nur die Werte von expiration.
    • Mit dem Attribut gracePeriodSeconds können Sie den Zeitraum des Zertifikatsablaufs in Sekunden bis zu einer maximalen Dauer von 30 Tagen angeben.
    • Die Attribute threshold, durationSeconds und comparator werden nicht unterstützt.
  • Im dimensions-Element des conditions-Arrays: <ph type="x-smartling-placeholder">
      </ph>
    • Sie müssen den Wert des Attributs certificate auf ANY setzen.
    • Sie müssen den Wert des Attributs proxy auf ALL setzen.
    • statusCode, developerApp, collection, faultCodeCategory, faultCodeSubCategory- und faultCodeName-Properties werden nicht unterstützt.
  • Das Attribut reportEnabled wird für Ablaufbenachrichtigungen nicht unterstützt.

Mit dem folgenden beispielhaften API-Aufruf wird eine Ablaufbenachrichtigung erstellt, die ausgelöst wird, wenn eine beliebige Zertifizierung im Produktionsumgebung in den nächsten 30 Tagen abläuft. Eine Benachrichtigung wird an die angegebene E-Mail-Adresse gesendet wenn die Benachrichtigung ausgelöst wird:

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
}'

Stellen Sie $ACCESS_TOKEN auf Ihr OAuth 2.0-Zugriffstoken ein, wie unter OAuth 2.0-Zugriffstoken anfordern beschrieben. Informationen zu den in diesem Beispiel verwendeten cURL-Optionen finden Sie unter cURL verwenden.

Ablaufbenachrichtigungen erhalten

Standardmäßig enthält die Get Alerts API gibt Informationen über alle definierten Benachrichtigungen zurück, sowohl feste Benachrichtigungen als auch Ablauffristen. Diese API unterstützt nun Abfrageparameter zum Filtern von Ergebnissen:

  • enabled-Wenn true angibt, dass nur aktivierte Benachrichtigungen zurückgegeben werden sollen. Der Standardwert ist false.
  • alertType-Gibt den Benachrichtigungstyp an, der zurückgegeben werden soll. Die zulässigen Werte sind runtime, der Standardwert und cert.
  • alertSubType-Gibt den Warnungs-Untertyp an, der zurückgegeben werden soll. Der Standardwert ist nicht festgelegt, d. h., es werden alle Benachrichtigungstypen zurückgegeben. Geben Sie certfixed an, um Ablaufbenachrichtigungen zurückzugeben.

Mit dem folgenden API-Aufruf können Sie beispielsweise nur Aktivierungsbenachrichtigungen für die Organisation myorg zurückgeben:

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

Der folgende Aufruf gibt nur Ablaufbenachrichtigungen zurück, sowohl aktivierte als auch deaktivierte:

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

Stellen Sie $ACCESS_TOKEN auf Ihr OAuth 2.0-Zugriffstoken ein, wie unter OAuth 2.0-Zugriffstoken anfordern beschrieben. Informationen zu den in diesem Beispiel verwendeten cURL-Optionen finden Sie unter cURL verwenden.