Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen
Verwenden Sie eine TLS-Ablaufwarnung, um eine Benachrichtigung zu senden, wenn das TLS-Zertifikat in einer Umgebung bald abläuft.
Informationen zu TLS-Zertifikaten
TLS (Transport Layer Security) ist die Standardsicherheitstechnologie zum Einrichten einer verschlüsselten Verbindung zwischen einem Webserver und einem Webclient, z. B. einem Browser oder einer Anwendung. Ein verschlüsselter Link sorgt dafür, dass alle Daten, die zwischen dem Server und dem Client übertragen werden, privat bleiben.
Ein TLS-Zertifikat ist eine digitale Datei, die eine Entität in einer TLS-Transaktion identifiziert. Edge verwendet ein TLS-Zertifikat, um TLS für Folgendes zu konfigurieren:
- Zugriff auf Ihre API-Proxys von API-Clients. Verwenden Sie virtuelle Hosts, um TLS zu konfigurieren.
- Zugriff auf Ihre Back-End-Dienste über Edge. Verwenden Sie Zielendpunkte und Zielserver auf dem Edge Message Processor, um TLS zu konfigurieren.
Ein TLS-Zertifikat hat 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 die API fehlschlagen, bis Sie das Zertifikat aktualisieren.
Ablaufbenachrichtigungen
Anstatt darauf zu warten, dass ein Zertifikat abläuft und Anfragen an Ihre API fehlschlagen, können Sie mit einer Ablaufbenachrichtigung eine Benachrichtigung senden, 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 Dienstunterbrechungen sehen.
Geben Sie bei der Konfiguration der Benachrichtigung kein einzelnes Zertifikat an, sondern eine bestimmte Umgebung. Die Benachrichtigung wird ausgelöst, wenn ein bereitgestelltes Zertifikat innerhalb des angegebenen Zeitraums abläuft.
Sie können die Ablaufbenachrichtigung so festlegen:
- 1 Tag vor Ablauf eines Zertifikats
- 14 Tage vor Ablauf eines Zertifikats
- 30 Tage vor Ablauf eines Zertifikats
Ablaufbenachrichtigungen und Benachrichtigungen hinzufügen
So fügen Sie Ablaufbenachrichtigungen und Benachrichtigungen hinzu:- Klicken Sie in der Edge-Benutzeroberfläche auf Analysieren > Benachrichtigungsregeln.
- Klicken Sie auf +Benachrichtigung.
- 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 von Bedeutung ist. Der Name darf nicht länger als 128 Zeichen sein. Beschreibung Beschreibung der Benachrichtigung Benachrichtigungstyp Wählen Sie TLS-Ablauf aus. Weitere Informationen finden Sie unter Benachrichtigungstypen. Umgebung Wählen Sie die Umgebung aus der Drop-down-Liste aus. Status Aktivieren oder deaktivieren Sie die Benachrichtigung. - Definieren Sie den Schwellenwert und die Dimension für die Bedingung, die die Benachrichtigung auslösen soll.
Bedingungsfeld Beschreibung Grenzwert Konfigurieren Sie den Zeitraum für die ablaufenden Zertifikate. Sie können eine Benachrichtigung erhalten, wenn ein Zertifikat abläuft in:
- 1 Tag
- 14 Tage
- 30 Tage
Dimension Die Größe ist auf den Wert Alle TLS-Zertifikate festgelegt, der jedem TLS-Zertifikat in der Umgebung entspricht. - Klicken Sie auf + Benachrichtigung, um eine Benachrichtigung hinzuzufügen.
Benachrichtigungsdetails Beschreibung Kanal Wählen Sie den Benachrichtigungskanal aus, den Sie verwenden möchten, und geben Sie das Ziel an: E-Mail, Slack, PagerDuty oder Webhook. Ziel Geben Sie das Ziel basierend auf dem ausgewählten Kanaltyp an: - E-Mail-Adresse – 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. Wenn Sie mehrere Ziele für denselben Kanaltyp angeben möchten, fügen Sie zusätzliche Benachrichtigungen hinzu.
- E-Mail-Adresse – E-Mail-Adresse wie
- Wenn Sie weitere Benachrichtigungen hinzufügen möchten, wiederholen Sie den vorherigen Schritt.
- Wenn Sie eine Benachrichtigung hinzugefügt haben, legen Sie die folgenden Felder fest:
Feld Beschreibung Playbook (Optional) Kostenloses Textfeld zur Angabe einer kurzen Beschreibung der empfohlenen Maßnahmen zum Beheben der Benachrichtigungen, wenn diese ausgelöst werden. Sie können auch einen Link zu Ihrem internen Wiki oder Ihrer Community-Seite angeben, auf der Sie auf Best Practices verweisen. Die Informationen in diesem Feld werden in die Benachrichtigung aufgenommen. Der Inhalt dieses Felds darf nicht länger als 1500 Zeichen sein. Drosseln Häufigkeit, mit der Benachrichtigungen gesendet werden. Wählen Sie einen Wert aus der Drop-down-Liste aus. - Klicken Sie auf Speichern.
Benachrichtigungen im Ereignis-Dashboard ansehen
Wenn Edge eine Warnungsbedingung erkennt, protokolliert es diese automatisch im Dashboard Ereignisse in der Edge-Benutzeroberfläche. Die Liste der im Dashboard „Ereignisse“ angezeigten Ereignisse enthält alle Benachrichtigungen, sowohl feste als auch zertifizierte.
So rufen Sie eine Benachrichtigung auf:
Klicken Sie in der Edge-Benutzeroberfläche auf Analysieren > Ereignisse. Das neue Dashboard „Ereignisse“ wird angezeigt:
Filtern Sie das Ereignis-Dashboard nach:
- Umgebung
- Region
- Zeitraum
- Wählen Sie eine Zeile im Ereignisdashboard aus, um den Schlüsselspeicher mit dem ablaufenden Zertifikat aufzurufen und die Benachrichtigung weiter zu untersuchen. Auf der Seite „Schlüsselspeicher“ können Sie ein neues Zertifikat hochladen und das ablaufende Zertifikat löschen.
Benachrichtigungs-APIs mit Ablaufbenachrichtigungen verwenden
Die meisten APIs, die Sie zum Erstellen und Verwalten von Ablaufbenachrichtigungen verwenden, sind dieselben wie die APIs, die Sie mit festen Benachrichtigungen verwenden. Die folgenden Benachrichtigungs-APIs funktionieren für Benachrichtigungen bei festen und Ablaufbenachrichtigungen auf dieselbe Weise:
- Benachrichtigungen erhalten – Sie erhalten eine Definition für feste Benachrichtigungen oder für Anomalien.
- Benachrichtigungsverlauf abrufen – Rufen Sie Messwerte zum Benachrichtigungsverlauf ab.
- Benachrichtigung löschen: Sie haben die Möglichkeit, die Definition einer festen Benachrichtigung oder einer Anomalie-Benachrichtigung zu löschen.
- Benachrichtigungsinstanz abrufen – Informationen zu einer ausgelösten Benachrichtigung abrufen.
- Anzahl der Benachrichtigungen abrufen: Rufen Sie die Gesamtzahl der Benachrichtigungen ab.
Einige APIs verfügen jedoch über zusätzliche Eigenschaften, die zur Unterstützung von Anomaliebenachrichtigungen verwendet werden, darunter:
- Benachrichtigungen erhalten: Es werden alle Benachrichtigungen angezeigt, einschließlich korrigierter Benachrichtigungen und Anomaliebenachrichtigungen.
- Benachrichtigung erstellen – Sie können eine korrigierte Benachrichtigung oder eine Anomaliebenachrichtigung erstellen.
- Benachrichtigung aktualisieren: Aktualisieren Sie die Definition einer korrigierten Warnung oder einer Anomaliewarnung.
Ablaufbenachrichtigung erstellen oder aktualisieren
Verwenden Sie zum Erstellen oder Aktualisieren einer Ablaufbenachrichtigung dieselben APIs wie für die feste Benachrichtigung. Der Text des API-Aufrufs zum Erstellen oder Aktualisieren einer Ablaufbenachrichtigung ist derselbe wie bei einer festen Benachrichtigung, mit den folgenden Änderungen:
Sie müssen die folgenden neuen Eigenschaften hinzufügen, um anzugeben, dass es sich um eine Ablaufbenachrichtigung handelt:
"alertType": "cert" "alertSubType": "certfixed"
Die Standardwerte dieser Attribute sind:
"alertType": "runtime" "alertSubType": "fixed"
Im Array
conditions
:- Das Attribut
metrics
akzeptiert nur die Werte vonexpiration
. - Mit dem Attribut
gracePeriodSeconds
können Sie den Zeitraum des Zertifikats in Sekunden bis zu einer maximalen Dauer von 30 Tagen angeben. - Die Attribute
threshold
,durationSeconds
undcomparator
werden nicht unterstützt.
- Das Attribut
- Im
dimensions
-Element desconditions
-Arrays:- Sie müssen den Wert des Attributs
certificate
aufANY
setzen. - Sie müssen den Wert des Attributs
proxy
aufALL
setzen. - Die Attribute
statusCode
,developerApp
,collection
,faultCodeCategory
,faultCodeSubCategory
undfaultCodeName
werden nicht unterstützt.
- Sie müssen den Wert des Attributs
- Das Attribut
reportEnabled
wird für Ablaufbenachrichtigungen nicht unterstützt.
Mit dem folgenden API-Beispielaufruf wird eine Ablaufbenachrichtigung erstellt, die ausgelöst wird, wenn eine Zertifizierung in der Produktumgebung in den nächsten 30 Tagen abläuft. Wenn die Benachrichtigung ausgelöst wird, wird eine Benachrichtigung an die angegebene E-Mail-Adresse gesendet:
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 gibt die Get Alerts API Informationen zu allen definierten Benachrichtigungen zurück, sowohl zu festgelegten Benachrichtigungen als auch zu festgelegten Benachrichtigungen mit Ablaufdatum. Diese API unterstützt nun Abfrageparameter zum Filtern von Ergebnissen:
enabled
-Wenntrue
angibt, dass nur aktivierte Benachrichtigungen zurückgegeben werden sollen. Der Standardwert istfalse
.alertType
-Gibt den Benachrichtigungstyp an, der zurückgegeben werden soll. Die zulässigen Werte sindruntime
, der Standardwert undcert
.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 Siecertfixed
an, um Ablaufbenachrichtigungen zurückzugeben.
Verwenden Sie beispielsweise den folgenden API-Aufruf, um nur Aktivierungsbenachrichtigungen für die Organisation myorg
zurückzugeben:
curl -H "Authorization: Bearer $ACCESS_TOKEN" \ 'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'
Der folgende Aufruf gibt nur aktivierte und deaktivierte Ablaufbenachrichtigungen zurück:
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.