Verwalten von Warnungen und Benachrichtigungen mithilfe der API

Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an. info

In den folgenden Abschnitten wird beschrieben, wie Sie Benachrichtigungen mithilfe der API verwalten.

Weitere Informationen zur Warnmeldungs-API finden Sie unter Warnmeldungs-API.

Warnmeldungen und Benachrichtigungen mit der API einrichten

Richten Sie Warnungen und Benachrichtigungen ein, indem Sie eine POST-Anforderung an die folgende Ressource ausgeben: https://apimonitoring.enterprise.apigee.com/alerts

In den folgenden Abschnitten finden Sie Beispiele zum Einrichten von Warnungen und Benachrichtigungen mithilfe der API:

5xx-Statuscode für einen API-Proxy mithilfe der API einrichten

Das folgende Beispiel zeigt, wie Sie eine Warnung einrichten, die ausgelöst wird, wenn 5xx Statuscodes mit einer Rate von mehr als 100 Transaktionen pro Sekunde (TPS) für 10 Minuten für den Hotels-API-Proxy in der Produktumgebung für eine Region angezeigt werden. 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":"5xx Alert",
     "description":"My 5xx alert",
     "environment":"prod",
     "enabled":true,
     "conditions":[
     {
        "description":"",
        "dimensions":{
            "org":"myorg", 
            "env":"prod", 
            "proxy":"hotels",
            "region":"ANY",
            "statusCode":"5xx"
        },
        "metric":"tps",
        "threshold":100,
        "durationSeconds":600,
        "comparator":">"
     }
     ],
     "notifications":[{ 
         "channel":"email", 
         "destination":"ops@acme.com"
     }],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
    }'

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.

Eine 95-Prozent-Latenzwarnung für einen API-Proxy einrichten

Das folgende Beispiel zeigt, wie Sie eine Warnung einrichten, die ausgelöst wird, wenn die Gesamtantwortlatenz für das 95. Perzentil 5 Minuten lang für den Hotel-API-Proxy in der Produktumgebung für eine beliebige Region mehr als 100 ms beträgt.

Eine Benachrichtigung wird an den angegebenen Webhook 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 Alert",
     "description":"My first alert",
     "environment":"prod",
     "enabled":true,
     "conditions":[
     {
        "description":"",
        "dimensions":{
            "org":"myorg", 
            "env":"prod",
            "proxy" : "hotels",
            "region":"ANY",
            "percentile":"95"
        },
        "metric":"totalLatency",
        "threshold":100,
        "durationSeconds":300,
        "comparator":">"
     }
     ],
     "notifications":[{ "channel":"webhook", "destination":"https://apigee.com/test-webhook"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

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.

Für alle API-Proxys einen 404-Statuscode-Warnung (Application Not Found) mit der API einrichten

Das folgende Beispiel zeigt, wie Sie eine Warnung einrichten, die ausgelöst wird, wenn HTTP 404-Statuscodes für 5 Minuten für alle API-Proxys in der Produktumgebung für eine beliebige Region mit einer Rate von mehr als 10 % auftreten.

Wenn der Alarm ausgelöst wird, wird eine Benachrichtigung an den angegebenen Slack-Kanal 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":"404 Application Not Found Alert",
     "description":"My 404 alert",
     "environment":"prod",
     "enabled":true,
     "conditions":[
     {
        "description":"",
        "dimensions":{"org":"myorg", 
            "env":"prod", 
            "proxy":"ALL",
            "region":"ANY",
            "statusCode":"404"},
        "metric":"rate",
        "threshold":0.05,
        "durationSeconds":300,
        "comparator":">"
     }],
     "notifications":[{ "channel":"slack", "destination":"https://hooks.slack.com/services/T00000000/B00000000/XXXXX"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

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.

API-Proxy-Zählungsbenachrichtigung für APIs mithilfe der API einrichten

Im Folgenden finden Sie ein Beispiel zum Einrichten einer Warnung, die ausgelöst wird, wenn die Anzahl der 5xx-Codes für unternehmenskritische APIs für 5 Minuten für eine beliebige Region 200 übersteigt.

In diesem Beispiel werden die geschäftskritischen APIs in der Critical API Proxies-Sammlung erfasst (mit der UUID aeff4394-86b7-11e8-83d7-42010a840040). Informationen zum Abrufen der UUID für eine Sammlung finden Sie unter Alle Sammlungen mit der API ansehen.

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":"Proxy Count Alert",
     "description":"My proxy count alert",
     "environment":"prod",
     "enabled":true,
     "conditions":[
     {
        "description":"",
        "dimensions":{
            "collection":"aeff4394-86b7-11e8-83d7-42010a840040",
            "org":"myorg", 
            "env":"prod",
            "proxy" : "ANY",
            "region":"ANY",
            "statusCode":"5xx"
        },
        "metric":"count",
        "threshold":200,
        "durationSeconds":300,
        "comparator":">"
     }
     ],
     "notifications":[{ 
         "channel":"email", 
         "destination":"ops@acme.com"
     }],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
    }'

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.

Warnung für Fehlerraten für Zieldienste mit der API einrichten

Im Folgenden finden Sie ein Beispiel zum Einrichten einer Warnung, die ausgelöst wird, wenn die 500-Code-Rate für Zieldienste 1 Stunde lang für eine Region 10 % übersteigt.

In diesem Beispiel werden die geschäftskritischen Zieldienste in der Sammlung kritischer Ziele erfasst (mit der UUID aeff4394-86b7-11e8-83d7-42010a840040). Informationen zum Abrufen der UUID für eine Sammlung finden Sie unter Alle Sammlungen mit der API ansehen.

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":"Error rate Alert",
     "description":"My error rate alert",
     "environment":"prod",
     "enabled":true,
     "conditions":[
     {
        "description":"",
        "dimensions":{
            "collection":"aeff4394-86b7-11e8-83d7-42010a840040",
            "org":"myorg", 
            "env":"prod",
            "proxy" : "ANY",
            "region":"ANY",
            "statusCode":"500"
        },
        "metric":"rate",
        "threshold":0.1,
        "durationSeconds":3600,
        "comparator":">"
     }
     ],
     "notifications":[{ 
         "channel":"email", 
         "destination":"ops@acme.com"
     }],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
    }'

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.

Warnung für Fehlerraten für die ServiceCallout-Richtlinie mit der API einrichten

Im Folgenden finden Sie ein Beispiel zum Einrichten einer Warnung, die ausgelöst wird, wenn die 500-Code-Rate für den durch die ServiceCallout-Richtlinie angegebenen Dienst für eine Region 1 Stunde lang 10 % übersteigt.

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":"Error rate Alert",
     "description":"My error rate alert",
     "environment":"prod",
     "enabled":true,
     "conditions":[
     {
        "description":"",
        "dimensions":{
            "target": "sc://docstore-api",
            "org":"myorg", 
            "env":"prod",
            "proxy" : "ANY",
            "region":"ANY",
            "statusCode":"500"
        },
        "metric":"rate",
        "threshold":0.1,
        "durationSeconds":3600,
        "comparator":">"
     }
     ],
     "notifications":[{ 
         "channel":"email", 
         "destination":"ops@acme.com"
     }],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
    }'

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.

Richten Sie mit der API eine Richtlinienfehlercode-Warnung ein

Das folgende Beispiel zeigt, wie Sie eine Warnung einrichten, die ausgelöst wird, wenn eine der folgenden Bedingungen erfüllt ist:

  • SpikeArrestViolation Die Anzahl der Fehlercodes ist 5 Minuten lang für APIs in der Produktumgebung einer Region größer als 10.
  • Die Anzahl aller Fehlercodes des API-Protokolls beträgt mehr als 3 % für 5 Minuten für APIs in der Produktumgebung für jede Region.

In diesem Beispiel werden die geschäftskritischen APIs in der Critical API Proxies-Sammlung erfasst (mit der UUID aeff4394-86b7-11e8-83d7-42010a840040). Informationen zum Abrufen der UUID für eine Sammlung finden Sie unter Alle Sammlungen mit der API ansehen.

Eine Benachrichtigung wird an den angegebenen PagerDuty-Code 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 Fault Code Alert",
     "description":"My fault code alert",
     "environment":"prod",
     "enabled":true,
     "conditions":[
     {
        "description":"",
        "dimensions": { 
            "collection":"aeff4394-86b7-11e8-83d7-42010a840040",
            "org":"myorg",
            "env":"prod",
            "proxy":"ANY",
            "region":"ANY",
            "faultCodeCategory":"Traffic Mgmt Policy",
            "faultCodeSubCategory":"Spike Arrest",
            "faultCodeName":"SpikeArrest Violation"
        },
        "metric":"count,
        "threshold":10,
        "durationSeconds":300,
        "comparator":">"
     },
     {
       "description":"",
       "dimensions": { 
           "collection":"aeff4394-86b7-11e8-83d7-42010a840040",
           "org":"myorg",
           "env":"prod",
           "proxy":"ANY",
           "region":"ANY",
           "faultCodeCategory":"API Protocol",
           "faultCodeSubCategory":"ALL"
       },
       "metric":"rate",
       "threshold":0.03,
       "durationSeconds":300,
       "comparator":">"
     }   
     ],
     "notifications":[{ "channel":"pagerduty", "destination":"abcd1234efgh56789"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

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.

Warnungen und Benachrichtigungen verwalten

In den folgenden Abschnitten finden Sie Beispiele zum Anzeigen von Warnmeldungsdefinitionen und Informationen zu ausgelösten Warnmeldungen mithilfe der API:

Alle Warnungsdefinitionen für eine Organisation anzeigen

Zeigen Sie alle Warn- und Benachrichtigungsdefinitionen an, indem Sie eine GET-Anfrage an die folgende API senden: https://apimonitoring.enterprise.apigee.com/alerts.

Sie müssen den Namen Ihrer Organisation mit dem Abfrageparameter org verwenden.

Beispiel:

curl 'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg'
    -X GET
    -H 'Accept: application/json, text/plain, */*'
    -H "Authorization: Bearer $ACCESS_TOKEN"

Die UUID der Benachrichtigung wird im Feld uuid der Antwort angezeigt. Sie benötigen diese UUID für Aufrufe, um Informationen zu einer Benachrichtigungsdefinition zu ermitteln. Im Folgenden finden Sie ein Beispiel für die Antwort:

[ 
 {
    "uuid": "4fa49a87-3463023ea7c4",
    "name": "PublicAPI latency alert",
    "enabled": true,
    "description": "Public API Latency alerts, 90th %ile > 6secs for 5 minute window trigger this alert",
    "conditions": [
      {
        "uuid": "4fa49a87-3463023ea7c4",
        "description": "",
        "dimensions": {
          "env": "prod",
          "org": "myorg",
          "percentile": "90",
          "proxy": "PublicAPI",
          "region": "ANY"
        },
        "metric": "totalLatency",
        "threshold": 6000,
        "durationSeconds": 300,
        "comparator": ">",
        "updatedBy": "me@foo.com"
      }
    ],
    "playbook": "PublicAPI Latency alert, setup to go off when 90th %ile is > 4 secs for 5 minute window",
    "throttleIntervalSeconds": 3600,
    "self": "/alerts/4fa49a87-3463023ea7c4",
    "feed": "/o/myorg/events/4fa49a87-3463023ea7c4",
    "organization": "myorg",
    "environment": "prod",
    "notifications": [
      {
        "channel": "email",
        "destination": "me@foo.com"
      }
    ],
    "updatedAt": "2018-07-19T18:19:31.654738Z",
    "updatedBy": "me@foo.com"
  },
  {
    "uuid": "ef1a5249-345ed3023ea7c4",
    "name": "Minty API Latency alert",
    "enabled": true,
    "description": "Minty API Latency alerts, 90th %ile > 6secs for 5 minute window trigger this alert",
    "conditions": [
      {
        "uuid": "ef1a5249-345ed3023ea7c4",
        "description": "",
        "dimensions": {
          "env": "prod",
          "org": "myorg",
          "percentile": "90",
          "proxy": "minty",
          "region": "ANY"
        },
        "metric": "totalLatency",
        "threshold": 6000,
        "durationSeconds": 300,
        "comparator": ">",
        "updatedBy": "me@foo.com"
      }
    ],
    "playbook": "Minty API",
    "throttleIntervalSeconds": 3600,
    "self": "/alerts/ef1a5249-345ed3023ea7c4",
    "feed": "/o/myorg/events/ef1a5249-345ed3023ea7c4",
    "organization": "myorg",
    "environment": "prod",
    "notifications": [
      {
        "channel": "email",
        "destination": "me@foo.com"
      }
    ],
    "updatedAt": "2018-07-19T18:19:33.22479Z",
    "updatedBy": "me@foo.com"
  },
 ...
]

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.

Eine bestimmte Warnungsdefinition anzeigen

Zeigen Sie eine bestimmte Benachrichtigungsdefinition an, indem Sie eine GET-Anfrage an die folgende Ressource senden: https://apimonitoring.enterprise.apigee.com/alerts/alert_uuid wobei alert_uuid die UUID der Alert-Definition angibt. Rufen Sie die UUID ab, wenn Sie die Benachrichtigung erstellen, oder verwenden Sie den API-Aufruf aus dem vorherigen Abschnitt, um alle Benachrichtigungen und die zugehörige UUID aufzulisten.

Beispiel:

curl 'https://apimonitoring.enterprise.apigee.com/alerts/4fa49a87-3463023ea7c4'
    -X GET
    -H 'Accept: application/json, text/plain, */*'
    -H "Authorization: Bearer $ACCESS_TOKEN"

Im Folgenden finden Sie ein Beispiel für die Antwort:

  {
    "uuid": "4fa49a87-3463023ea7c4",
    "name": "PublicAPI latency alert",
    "enabled": true,
    "description": "Public API Latency alerts, 90th %ile > 6secs for 5 minute window trigger this alert",
    "conditions": [
      {
        "uuid": "4fa49a87-3463023ea7c4",
        "description": "",
        "dimensions": {
          "env": "prod",
          "org": "myorg",
          "percentile": "90",
          "proxy": "PublicAPI",
          "region": "ANY"
        },
        "metric": "totalLatency",
        "threshold": 6000,
        "durationSeconds": 300,
        "comparator": ">",
        "updatedBy": "me@foo.com"
      }
    ],
    "playbook": "PublicAPI Latency alert, setup to go off when 90th %ile is > 4 secs for 5 minute window",
    "throttleIntervalSeconds": 3600,
    "self": "/alerts/4fa49a87-3463023ea7c4",
    "feed": "/o/myorg/events/4fa49a87-3463023ea7c4",
    "organization": "myorg",
    "environment": "prod",
    "notifications": [
      {
        "channel": "email",
        "destination": "me@foo.com"
      }
    ],
    "updatedAt": "2018-07-19T18:19:31.654738Z",
    "updatedBy": "me@foo.com"
  }

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.

Den Verlauf aller ausgelösten Warnungen für eine Organisation anzeigen

Zeigen Sie den Verlauf aller für eine Organisation ausgelösten Warnungen an, indem Sie eine GET-Anfrage an die folgende Ressource ausgeben: https://apimonitoring.enterprise.apigee.com/metrics/alerthistory.

Sie müssen den Namen Ihrer Organisation mit dem Abfrageparameter org verwenden. Sie können optional einen Zeitraum angeben, in dem nach ausgelösten Warnungen gesucht wird. Standardmäßig werden alle Benachrichtigungen zurückgegeben, die in der letzten Stunde ausgelöst wurden.

Beispiel:

curl 'https://apimonitoring.enterprise.apigee.com/metrics/alerthistory?org=myorg'
    -X GET
    -H 'Accept: application/json, text/plain, */*'
    -H "Authorization: Bearer $ACCESS_TOKEN"

Die Antwort enthält ein Array aller Warnungen, die während des angeforderten Zeitraums ausgelöst wurden. Im Antworttext gibt das Feld id die UUID der ausgelösten Benachrichtigung und das Feld shared_id die UUID der Benachrichtigungsdefinition an, die der ausgelösten Benachrichtigung zugeordnet ist.

Im Folgenden finden Sie ein Beispiel für die Antwort: 

[
  {
    "id": "80cbe560-f6e0-475c6f7ed2d",
    "shared_id": "4fa49a87-3463023ea7c4",
    "organization": "myorg",
    "environment": "prod",
    "name": "PublicAPI latency alert",
    "type": "Alert",
    "source": "null/current",
    "raw_payload": "{\"reportUUID\":\"\",\"reportEnabled\":false,\"organization\":\"myorg\",\"name\":\"emgmt-api 404\",\"self\":\"/alerts/4fa49a87-3463023ea7c4\",\"description\":\"go/apigee-extensions-playbook\",\"conditions\":[
  {\"comparator\":\">\",\"metric\":\"rate\",\"durationSeconds\":300,\"name\":\"PublicAPI latency alert\",\"description\":\"\",\"threshold\":0.05,\"dimensions\":{\"proxy\":\"emgmt-api\",\"org\":\"myorg\",\"env\":\"prod\",\"region\":\"any\",\"statusCode\":\"404\"}}],\"uuid\":\"4fa49a87-3463023ea7c4\",\"playbook\":\"go/apigee-extensions-playbook\"}",
    "time": "2019-03-25T15:30:18Z"
  },
  {
    "id": "8131d740-6680-45b9c72c3",
    "shared_id": "1a64885b-f9-42010a850039",
    "organization": "apigee-pinpoint",
    "environment": "prod",
    "name": "Demo 5xx alert",
    "type": "Alert",
    "source": "null/current",
    "raw_payload": "{\"reportUUID\":\"\",\"reportEnabled\":false,\"organization\":\"myorg\",\"name\":\"Demo 5xx alert\",\"self\":\"/alerts/1a64885b-f9-42010a850039\",\"description\":\"Demo 5xx alert\",\"conditions\":[
  {\"comparator\":\">\",\"metric\":\"rate\",\"durationSeconds\":300,\"name\":\"Demo 5xx alert\",\"description\":\"\",\"threshold\":0.4,\"dimensions\":{\"proxy\":\"ALL\",\"org\":\"myorg\",\"env\":\"prod\",\"region\":\"any\",\"statusCode\":\"5xx\"}}],\"uuid\":\"1a64885b-f9-42010a850039\",\"playbook\":\"Recommended Playbook\"}",
    "time": "2019-03-25T15:57:30Z"
  },
 ...
]

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.

Verlauf bestimmter Benachrichtigungen ansehen

Sehen Sie sich den Verlauf der ausgelösten Benachrichtigungen für eine bestimmte Benachrichtigungsdefinition an. Senden Sie dazu eine GET-Anfrage an die folgende Ressource: https://apimonitoring.enterprise.apigee.com/metrics/alerthistory.

Sie müssen den Namen Ihrer Organisation mit dem Abfrageparameter org und der UUID der Benachrichtigungsdefinition übergeben. Sie können optional einen Zeitraum für die Suche nach Benachrichtigungen angeben. Standardmäßig werden alle Warnungen zurückgegeben, die in der letzten Stunde ausgelöst wurden.

Sie können die UUID der Benachrichtigungsdefinition aus dem Warnungsverlauf abrufen, wie im vorherigen Abschnitt beschrieben, wenn Sie die Benachrichtigungsdefinition erstellt haben, oder indem Sie den in Alle Benachrichtigungsdefinitionen anzeigen angezeigten API-Aufruf verwenden.

Beispiel:

curl 'https://apimonitoring.enterprise.apigee.com/metrics/alerthistory?org=myorg&alertId=4fa49a87-3463023ea7c4'
    -X GET
    -H 'Accept: application/json, text/plain, */*'
    -H "Authorization: Bearer $ACCESS_TOKEN"

Die Antwort enthält ein Array aller Benachrichtigungen, die im angeforderten Zeitraum für die angegebene Benachrichtigungsdefinitions-UUID ausgelöst wurden. Im Antworttext gibt das Feld id die UUID der ausgelösten Benachrichtigung an und das Feld shared_id gibt die UUID der Benachrichtigungsdefinition an, die mit der ausgelösten Benachrichtigung verknüpft ist.

Im Folgenden finden Sie ein Beispiel für die Antwort: 

[
  {
    "id": "80cbe560-f6e0-475c6f7ed2d",
    "shared_id": "4fa49a87-3463023ea7c4",
    "organization": "myorg",
    "environment": "prod",
    "name": "PublicAPI latency alert",
    "type": "Alert",
    "source": "null/current",
    "raw_payload": "{\"reportUUID\":\"\",\"reportEnabled\":false,\"organization\":\"myorg\",\"name\":\"emgmt-api 404\",\"self\":\"/alerts/4fa49a87-3463023ea7c4\",\"description\":\"go/apigee-extensions-playbook\",\"conditions\":[
  {\"comparator\":\">\",\"metric\":\"rate\",\"durationSeconds\":300,\"name\":\"PublicAPI latency alert\",\"description\":\"\",\"threshold\":0.05,\"dimensions\":{\"proxy\":\"emgmt-api\",\"org\":\"myorg\",\"env\":\"prod\",\"region\":\"any\",\"statusCode\":\"404\"}}],\"uuid\":\"4fa49a87-3463023ea7c4\",\"playbook\":\"go/apigee-extensions-playbook\"}",
    "time": "2019-03-25T15:30:18Z"
  },
  {
    "id": "9fc442d5-d607-40ef118c4e7",
    "shared_id": "4fa49a87-3463023ea7c4",
    "organization": "myorg",
    "environment": "prod",
    "name": "PublicAPI latency alert",
    "type": "Alert",
    "source": "null/current",
    "raw_payload": "{\"reportUUID\":\"\",\"reportEnabled\":false,\"organization\":\"myorg\",\"name\":\"emgmt-api 404\",\"self\":\"/alerts/4fa49a87-3463023ea7c4\",\"description\":\"go/apigee-extensions-playbook\",\"conditions\":[{\"comparator\":\">\",\"metric\":\"rate\",\"durationSeconds\":300,\"name\":\"PublicAPI latency alert\",\"description\":\"\",\"threshold\":0.05,\"dimensions\":{\"proxy\":\"emgmt-api\",\"org\":\"myorg\",\"env\":\"prod\",\"region\":\"any\",\"statusCode\":\"404\"}}],\"uuid\":\"4fa49a87-3463023ea7c4\",\"playbook\":\"go/apigee-extensions-playbook\"}",
    "time": "2019-03-25T15:17:55Z"
  },
 ...
]

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.