API'yi kullanarak uyarıları ve bildirimleri yönetme

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Aşağıdaki bölümlerde, API'yi kullanarak uyarıların nasıl yönetileceği açıklanmaktadır.

Uyarılar API'si hakkında daha fazla bilgi için Uyarılar API'si başlıklı makaleyi inceleyin.

API'yi kullanarak uyarı ve bildirim oluşturma

Aşağıdaki kaynağa POST isteği göndererek uyarı ve bildirim ayarlayın: https://apimonitoring.enterprise.apigee.com/alerts.

Aşağıdaki bölümlerde, API'yi kullanarak uyarı ve bildirim oluşturma örnekleri verilmiştir:

API'yi kullanarak API proxy'si için 5xx durum kodu uyarısı oluşturma

Aşağıdaki örnekte, herhangi bir bölgenin üretim ortamındaki oteller API proxy'si için 10 dakika boyunca saniyede 100 işlemden (TPS) fazla bir hızda 5xx durum kodları oluştuğunda tetiklenen bir uyarının nasıl ayarlanacağı gösterilmektedir. Uyarı tetiklendiğinde belirtilen e-posta adresine bildirim gönderilir.

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

$ACCESS_TOKEN değerini, OAuth 2.0 erişim jetonu alma bölümünde açıklandığı gibi OAuth 2.0 erişim jetonunuza ayarlayın.

Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'yi kullanma bölümüne bakın.

API'yi kullanarak bir API proxy'si için 95. yüzdelik dilim gecikme uyarısı oluşturma

Aşağıdaki örnekte, herhangi bir bölgenin üretim ortamındaki otel API proxy'si için 95. yüzdelik dilimdeki toplam yanıt gecikmesi 5 dakika boyunca 100 ms'den fazla olursa tetiklenen bir uyarının nasıl ayarlanacağı gösterilmektedir.

Uyarı tetiklenirse belirtilen Webhook'a bildirim gönderilir.

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

$ACCESS_TOKEN değerini, OAuth 2.0 erişim jetonu alma bölümünde açıklandığı gibi OAuth 2.0 erişim jetonunuza ayarlayın.

Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'yi kullanma başlıklı makaleyi inceleyin.

API'yi kullanan tüm API proxy'leri için 404 (Uygulama Bulunamadı) durum kodu uyarısı ayarlama

Aşağıdaki örnekte, herhangi bir bölgedeki prod ortamındaki tüm API proxy'lerinde HTTP 404 durum kodları 5 dakika boyunca% 10'dan fazla bir oranda gerçekleştiğinde tetiklenen bir uyarının nasıl ayarlanacağı gösterilmektedir.

Uyarı tetiklendiğinde, belirtilen Slack kanalına bildirim gönderilir.

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

$ACCESS_TOKEN değerini, OAuth 2.0 erişim jetonu alma bölümünde açıklandığı gibi OAuth 2.0 erişim jetonunuza ayarlayın.

Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'yi kullanma başlıklı makaleyi inceleyin.

API'yi kullanan API'ler için API proxy sayısı uyarısı oluşturma

Aşağıda, API'ler için 5xx kod sayısı herhangi bir bölgede 5 dakika boyunca 200'ü aştığında tetiklenen bir uyarının nasıl ayarlanacağına dair bir örnek verilmiştir.

Bu örnekte API'ler, Kritik API Proxy'leri koleksiyonunda (UUID aeff4394-86b7-11e8-83d7-42010a840040 ile) yakalanır. Bir koleksiyonun UUID'sini almak için API'yi kullanarak tüm koleksiyonları görüntüleme başlıklı makaleyi inceleyin.

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

OAuth 2.0 erişim jetonu alma başlıklı makalede açıklandığı şekilde, $ACCESS_TOKEN öğesini OAuth 2.0 erişim jetonunuza ayarlayın.

Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'yi kullanma bölümüne bakın.

API'yi kullanarak hedef hizmetler için hata oranı uyarısı oluşturma

Aşağıda, hedef hizmetler için 500 kodu oranı herhangi bir bölgede 1 saat boyunca% 10'u aştığında tetiklenen bir uyarının nasıl ayarlanacağına dair bir örnek verilmiştir.

Bu örnekte, hedef hizmetler Kritik hedefler koleksiyonunda (UUID aeff4394-86b7-11e8-83d7-42010a840040 ile) yakalanır. Bir koleksiyonun UUID'sini almak için API'yi kullanarak tüm koleksiyonları görüntüleme başlıklı makaleyi inceleyin.

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

$ACCESS_TOKEN değerini, OAuth 2.0 erişim jetonu alma bölümünde açıklandığı gibi OAuth 2.0 erişim jetonunuza ayarlayın.

Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'yi kullanma başlıklı makaleyi inceleyin.

API'yi kullanarak Hizmet Açıklaması politikası için hata oranı uyarısı oluşturma

Aşağıda, ServiceCallout politikası tarafından belirtilen hizmetin 500 kodu oranı herhangi bir bölgede 1 saat boyunca% 10'u aştığında tetiklenen bir uyarının nasıl ayarlanacağına dair bir örnek verilmiştir.

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

$ACCESS_TOKEN değerini, OAuth 2.0 erişim jetonu alma bölümünde açıklandığı gibi OAuth 2.0 erişim jetonunuza ayarlayın.

Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'yi kullanma başlıklı makaleyi inceleyin.

API'yi kullanarak politika hata kodu uyarısı ayarlama

Aşağıdaki örnekte, aşağıdaki koşullardan biri karşılandığında tetiklenen bir uyarının nasıl ayarlanacağı gösterilmektedir:

  • SpikeArrestViolation hata kodu sayısı, herhangi bir bölgedeki üretim ortamındaki API'ler için 5 dakika boyunca 10'dan fazladır.
  • Tüm API protokolü hata kodlarının sayısı, herhangi bir bölgedeki üretim ortamındaki API'ler için 5 dakika boyunca% 3'ten fazladır.

Bu örnekte API'ler, Kritik API Proxy'leri koleksiyonunda (UUID aeff4394-86b7-11e8-83d7-42010a840040 ile) yakalanmıştır. Bir koleksiyonun UUID'sini almak için API'yi kullanarak tüm koleksiyonları görüntüleme başlıklı makaleyi inceleyin.

Uyarı tetiklendiğinde belirtilen PagerDuty koduna bildirim gönderilir.

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

OAuth 2.0 erişim jetonu alma başlıklı makalede açıklandığı şekilde, $ACCESS_TOKEN öğesini OAuth 2.0 erişim jetonunuza ayarlayın.

Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'yi kullanma başlıklı makaleyi inceleyin.

Uyarıları ve bildirimleri görüntüleme

Aşağıdaki bölümlerde, API kullanılarak uyarı tanımlarını ve tetiklenen uyarılarla ilgili bilgileri görüntüleme örnekleri sunulmaktadır:

Bir kuruluşun tüm uyarı tanımlarını görüntüleme

Aşağıdaki API'ye GET isteği göndererek tüm uyarı ve bildirim tanımlarını görüntüleyin: https://apimonitoring.enterprise.apigee.com/alerts.

org sorgu parametresini kullanarak kuruluşunuzun adını iletmeniz gerekir.

Örneğin:

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

Uyarının UUID'si, yanıtın uuid alanında gösterilir. Bir uyarı tanımına özgü bilgileri belirlemek için çağrı yapmak üzere bu UUID'ye ihtiyacınız vardır. Aşağıda yanıtın bir örneği verilmiştir:

[ 
 {
    "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"
  },
 ...
]

$ACCESS_TOKEN değerini, OAuth 2.0 erişim jetonu alma bölümünde açıklandığı gibi OAuth 2.0 erişim jetonunuza ayarlayın.

Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'yi kullanma başlıklı makaleyi inceleyin.

Belirli bir uyarı tanımını görüntüleme

Aşağıdaki kaynağa bir GET isteği göndererek belirli bir uyarı tanımını görüntüleyin: https://apimonitoring.enterprise.qwiklabs.com/alerts/alert_uuid. Burada alert_uuid, uyarı tanımının UUID'sini belirtir. Uyarıyı oluştururken UUID'yi alın veya tüm uyarıları ve ilişkili UUID'lerini listelemek için önceki bölümde gösterilen API çağrısını kullanın.

Örneğin:

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

Aşağıda yanıtın bir örneği verilmiştir:

  {
    "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"
  }

OAuth 2.0 erişim jetonu alma başlıklı makalede açıklandığı şekilde, $ACCESS_TOKEN öğesini OAuth 2.0 erişim jetonunuza ayarlayın.

Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'yi kullanma bölümüne bakın.

Bir kuruluş için tetiklenen tüm uyarıların geçmişini görüntüleme

Aşağıdaki kaynağa GET isteği göndererek bir kuruluş için tetiklenen tüm uyarıların geçmişini görüntüleyin: https://apimonitoring.enterprise.apigee.com/metrics/alerthistory.

org sorgu parametresini kullanarak kuruluşunuzun adını iletmeniz gerekir. İsteğe bağlı olarak, tetiklenen uyarıları aramak için kullanılan bir dönem belirtebilirsiniz. Varsayılan olarak son bir saat içinde tetiklenen tüm uyarılar döndürülür.

Örneğin:

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

Yanıt, istenen dönemde tetiklenen tüm uyarıların bir dizisini içerir. Yanıt gövdesinde id alanı, tetiklenen uyarının UUID'sini, shared_id alanı ise tetiklenen uyarıyla ilişkili uyarı tanımını UUID'sini belirtir.

Aşağıda, yanıta dair bir örnek verilmiştir. 

[
  {
    "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"
  },
 ...
]

$ACCESS_TOKEN değerini, OAuth 2.0 erişim jetonu alma bölümünde açıklandığı gibi OAuth 2.0 erişim jetonunuza ayarlayın.

Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'yi kullanma bölümüne bakın.

Belirli bir uyarının geçmişini görüntüleme

Aşağıdaki kaynağa bir GET isteği göndererek belirli bir uyarı tanımına ilişkin tetiklenen uyarıların geçmişini görüntüleyin: https://apimonitoring.enterprise.apigee.com/metrics/alerthistory

Kuruluşunuzun adını, org sorgu parametresini ve uyarı tanımının UUID'sini kullanarak iletmeniz gerekir. İsteğe bağlı olarak, uyarıları aramak için kullanılacak bir zaman aralığı belirtebilirsiniz. Varsayılan olarak, son bir saat içinde tetiklenen tüm uyarılar döndürülür.

Uyarı tanımı UUID'sini, önceki bölümde gösterildiği gibi uyarı geçmişinden (uyarı tanımını oluşturduğunuzda) veya Tüm uyarı tanımlarını görüntüleme bölümünde gösterilen API çağrısını kullanarak edinebilirsiniz.

Örneğin:

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"

Yanıt, belirtilen uyarı tanımı UUID'si için istenen dönemde tetiklenen tüm uyarıların bir dizisini içerir. Yanıt gövdesinde id alanı, tetiklenen uyarının UUID'sini belirtir. shared_id alanı ise tetiklenen uyarıyla ilişkili uyarı tanımının UUID'sini belirtir.

Aşağıda yanıtın bir örneği verilmiştir. 

[
  {
    "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"
  },
 ...
]

$ACCESS_TOKEN değerini, OAuth 2.0 erişim jetonu alma bölümünde açıklandığı gibi OAuth 2.0 erişim jetonunuza ayarlayın.

Bu örnekte kullanılan cURL seçenekleri hakkında bilgi edinmek için cURL'yi kullanma başlıklı makaleyi inceleyin.