Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację
Apigee X. info
W kolejnych sekcjach opisujemy, jak zarządzać alertami za pomocą interfejsu API.
- Konfigurowanie alertów i powiadomień za pomocą interfejsu API
- Wyświetlanie alertów i powiadomień za pomocą interfejsu API
Więcej informacji o interfejsie Alerts API znajdziesz w jego dokumentacji.
Konfigurowanie alertów i powiadomień za pomocą interfejsu API
Skonfiguruj alerty i powiadomienia, wysyłając żądanie POST do tego zasobu: https://apimonitoring.enterprise.apigee.com/alerts.
W kolejnych sekcjach znajdziesz przykłady konfigurowania alertów i powiadomień za pomocą interfejsu API:
- Konfigurowanie alertu o kodzie stanu 5xx dla serwera proxy interfejsu API za pomocą interfejsu API
- Konfigurowanie alertu o opóźnieniu na poziomie 95 centyla dla serwera proxy interfejsu API za pomocą interfejsu API
- Konfigurowanie alertu o kodzie stanu 404 (nie znaleziono aplikacji) dla wszystkich serwerów proxy interfejsu API za pomocą interfejsu API
- Konfigurowanie alertu o liczbie serwerów proxy interfejsu API dla interfejsów API za pomocą interfejsu API
- Konfigurowanie alertu o współczynniku błędów dla usług docelowych za pomocą interfejsu API
- Konfigurowanie alertu o współczynniku błędów dla zasady Service Callout za pomocą interfejsu API
- Konfigurowanie alertu o kodzie błędu dla interfejsów API za pomocą interfejsu API
Konfigurowanie alertu o kodzie stanu 5xx dla serwera proxy interfejsu API za pomocą interfejsu API
Poniższy przykład pokazuje, jak skonfigurować alert, który jest wywoływany, gdy kody stanu 5xx występują z częstotliwością większą niż 100 transakcji na sekundę (TPS) przez 10 minut w przypadku serwera proxy interfejsu API hoteli w środowisku produkcyjnym w dowolnym regionie. Gdy alert zostanie wywołany, na podany adres e-mail zostanie wysłane powiadomienie.
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
}'
Ustaw $ACCESS_TOKEN na token dostępu OAuth 2.0 zgodnie z opisem w artykule Uzyskiwanie tokena dostępu OAuth 2.0.
Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w artykule Korzystanie z cURL.
Konfigurowanie alertu o opóźnieniu na poziomie 95 centyla dla serwera proxy interfejsu API za pomocą interfejsu API
Poniższy przykład pokazuje, jak skonfigurować alert, który jest wywoływany, gdy całkowite opóźnienie odpowiedzi na poziomie 95 centyla jest większe niż 100 ms przez 5 minut w przypadku serwera proxy interfejsu API hoteli w środowisku produkcyjnym w dowolnym regionie.
Gdy alert zostanie wywołany, na podany adres URL webhooka zostanie wysłane powiadomienie.
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
}'
Ustaw $ACCESS_TOKEN na token dostępu OAuth 2.0 zgodnie z opisem w artykule Uzyskiwanie tokena dostępu OAuth 2.0.
Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w artykule Korzystanie z cURL.
Konfigurowanie alertu o kodzie stanu 404 (nie znaleziono aplikacji) dla wszystkich serwerów proxy interfejsu API za pomocą interfejsu API
Poniższy przykład pokazuje, jak skonfigurować alert, który jest wywoływany, gdy kody stanu HTTP 404 występują z częstotliwością większą niż 10% przez 5 minut w przypadku wszystkich serwerów proxy interfejsu API w środowisku produkcyjnym w dowolnym regionie.
Gdy alert zostanie wywołany, na podany kanał Slacka zostanie wysłane powiadomienie.
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
}'
Ustaw $ACCESS_TOKEN na token dostępu OAuth 2.0 zgodnie z opisem w artykule Uzyskiwanie tokena dostępu OAuth 2.0.
Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w artykule Korzystanie z cURL.
Konfigurowanie alertu o liczbie serwerów proxy interfejsu API dla interfejsów API za pomocą interfejsu API
Poniżej znajdziesz przykład konfigurowania alertu, który jest wywoływany, gdy liczba kodów 5xx w przypadku interfejsów API przekracza 200 przez 5 minut w dowolnym regionie.
W tym przykładzie interfejsy API są przechwytywane w kolekcji Krytyczne serwery proxy interfejsu API (z identyfikatorem UUID aeff4394-86b7-11e8-83d7-42010a840040). Aby uzyskać identyfikator UUID kolekcji, zapoznaj się z sekcją Wyświetlanie wszystkich kolekcji za pomocą interfejsu API.
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
}'
Ustaw $ACCESS_TOKEN na token dostępu OAuth 2.0 zgodnie z opisem w artykule Uzyskiwanie tokena dostępu OAuth 2.0.
Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w artykule Korzystanie z cURL.
Konfigurowanie alertu o współczynniku błędów dla usług docelowych za pomocą interfejsu API
Poniżej znajdziesz przykład konfigurowania alertu, który jest wywoływany, gdy współczynnik kodów 500 w przypadku usług docelowych przekracza 10% przez 1 godzinę w dowolnym regionie.
W tym przykładzie usługi docelowe są przechwytywane w kolekcji Krytyczne cele (z identyfikatorem UUID aeff4394-86b7-11e8-83d7-42010a840040). Aby uzyskać identyfikator UUID kolekcji, zapoznaj się z sekcją Wyświetlanie wszystkich kolekcji za pomocą interfejsu API.
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
}'
Ustaw $ACCESS_TOKEN na token dostępu OAuth 2.0 zgodnie z opisem w artykule Uzyskiwanie tokena dostępu OAuth 2.0.
Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w artykule Korzystanie z cURL.
Konfigurowanie alertu o współczynniku błędów dla zasady Service Callout za pomocą interfejsu API
Poniżej znajdziesz przykład konfigurowania alertu, który jest wywoływany, gdy współczynnik kodów 500 w przypadku usługi określonej przez zasadę ServiceCallout przekracza 10% przez 1 godzinę w dowolnym regionie.
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
}'
Ustaw $ACCESS_TOKEN na token dostępu OAuth 2.0 zgodnie z opisem w artykule Uzyskiwanie tokena dostępu OAuth 2.0.
Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w artykule Korzystanie z cURL.
Konfigurowanie alertu o kodzie błędu zasady za pomocą interfejsu API
Poniższy przykład pokazuje, jak skonfigurować alert, który jest wywoływany, gdy spełniony jest jeden z tych warunków:
- Liczba kodów błędu
SpikeArrestViolationjest większa niż 10 przez 5 minut w przypadku interfejsów API w środowisku produkcyjnym w dowolnym regionie. - Liczba wszystkich kodów błędu protokołu interfejsu API jest większa niż 3% przez 5 minut w przypadku interfejsów API w środowisku produkcyjnym w dowolnym regionie.
W tym przykładzie interfejsy API są przechwytywane w kolekcji Krytyczne serwery proxy interfejsu API (z identyfikatorem UUID aeff4394-86b7-11e8-83d7-42010a840040). Aby uzyskać identyfikator UUID kolekcji, zapoznaj się z sekcją Wyświetlanie wszystkich kolekcji za pomocą interfejsu API.
Gdy alert zostanie wywołany, na podany kod PagerDuty zostanie wysłane powiadomienie.
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
}'
Ustaw $ACCESS_TOKEN na token dostępu OAuth 2.0 zgodnie z opisem w artykule Uzyskiwanie tokena dostępu OAuth 2.0.
Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w artykule Korzystanie z cURL.
Wyświetlanie alertów i powiadomień
W kolejnych sekcjach znajdziesz przykłady wyświetlania definicji alertów i informacji o wywołanych alertach za pomocą interfejsu API:
- Wyświetlanie wszystkich definicji alertów w organizacji
- Wyświetlanie konkretnej definicji alertu
- Wyświetlanie historii wywołanych alertów w organizacji
- Wyświetlanie historii konkretnego alertu
Wyświetlanie wszystkich definicji alertów w organizacji
Wyświetl wszystkie definicje alertów i powiadomień, wysyłając żądanie GET do tego interfejsu API: https://apimonitoring.enterprise.apigee.com/alerts.
Musisz przekazać nazwę swojej organizacji za pomocą parametru zapytania org.
Na przykład:
curl 'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg'
-X GET
-H 'Accept: application/json, text/plain, */*'
-H "Authorization: Bearer $ACCESS_TOKEN"
Identyfikator UUID alertu jest widoczny w polu uuid odpowiedzi. Ten identyfikator UUID jest potrzebny do wykonywania wywołań w celu określenia informacji dotyczących definicji alertu. Oto przykład odpowiedzi:
[ { "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" }, ... ]
Ustaw $ACCESS_TOKEN na token dostępu OAuth 2.0 zgodnie z opisem w artykule Uzyskiwanie tokena dostępu OAuth 2.0.
Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w artykule Korzystanie z cURL.
Wyświetlanie konkretnej definicji alertu
Wyświetl konkretną definicję alertu, wysyłając żądanie GET do tego zasobu: https://apimonitoring.enterprise.apigee.com/alerts/alert_uuid , gdzie alert_uuid określa identyfikator UUID definicji alertu. Identyfikator UUID możesz uzyskać podczas tworzenia alertu lub za pomocą wywołania interfejsu API pokazanego w poprzedniej sekcji, aby wyświetlić listę wszystkich alertów i powiązanych z nimi identyfikatorów UUID.
Na przykład:
curl 'https://apimonitoring.enterprise.apigee.com/alerts/4fa49a87-3463023ea7c4'
-X GET
-H 'Accept: application/json, text/plain, */*'
-H "Authorization: Bearer $ACCESS_TOKEN"
Oto przykład odpowiedzi:
{ "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" }
Ustaw $ACCESS_TOKEN na token dostępu OAuth 2.0 zgodnie z opisem w artykule Uzyskiwanie tokena dostępu OAuth 2.0.
Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w artykule Korzystanie z cURL.
Wyświetlanie historii wszystkich wywołanych alertów w organizacji
Wyświetl historię wszystkich alertów wywołanych w organizacji, wysyłając żądanie GET do tego zasobu: https://apimonitoring.enterprise.apigee.com/metrics/alerthistory.
Musisz przekazać nazwę swojej organizacji za pomocą parametru zapytania org.
Opcjonalnie możesz określić okres, w którym mają być wyszukiwane wywołane alerty. Domyślnie zwracane są wszystkie alerty wywołane w ciągu ostatniej godziny.
Na przykład:
curl 'https://apimonitoring.enterprise.apigee.com/metrics/alerthistory?org=myorg'
-X GET
-H 'Accept: application/json, text/plain, */*'
-H "Authorization: Bearer $ACCESS_TOKEN"
Odpowiedź zawiera tablicę wszystkich alertów wywołanych w żądanym okresie.
W treści odpowiedzi pole id określa identyfikator UUID wywołanego alertu,
a pole shared_id określa identyfikator UUID definicji alertu powiązanej
z wywołanym alertem.
Oto przykład odpowiedzi.
[ { "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" }, ... ]
Ustaw $ACCESS_TOKEN na token dostępu OAuth 2.0 zgodnie z opisem w artykule Uzyskiwanie tokena dostępu OAuth 2.0.
Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w artykule Korzystanie z cURL.
Historia wyświetlania konkretnego alertu
Wyświetl historię wywołanych alertów dla konkretnej definicji alertu, wysyłając żądanie GET do tego zasobu: https://apimonitoring.enterprise.apigee.com/metrics/alerthistory.
Musisz przekazać nazwę swojej organizacji za pomocą parametru zapytania org oraz identyfikator UUID definicji alertu. Opcjonalnie możesz określić okres, w którym mają być wyszukiwane alerty. Domyślnie zwracane są wszystkie alerty wywołane w ciągu ostatniej godziny.
Identyfikator UUID definicji alertu możesz uzyskać z historii alertów, jak pokazano w poprzedniej sekcji, podczas tworzenia definicji alertu lub za pomocą wywołania interfejsu API pokazanego w sekcji Wyświetlanie wszystkich definicji alertów.
Na przykład:
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"
Odpowiedź zawiera tablicę wszystkich alertów wywołanych w żądanym okresie dla określonego identyfikatora UUID definicji alertu. W treści odpowiedzi pole
id określa identyfikator UUID wywołanego alertu, a pole
shared_id określa identyfikator UUID definicji alertu
powiązanej z wywołanym alertem.
Oto przykład odpowiedzi.
[ { "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" }, ... ]
Ustaw $ACCESS_TOKEN na token dostępu OAuth 2.0 zgodnie z opisem w artykule Uzyskiwanie tokena dostępu OAuth 2.0.
Informacje o opcjach cURL użytych w tym przykładzie znajdziesz w artykule Korzystanie z cURL.