مدیریت هشدارها و اعلان ها با استفاده از API

شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید .
اطلاعات

بخش‌های زیر نحوه مدیریت هشدارها با استفاده از API را شرح می‌دهند.

برای اطلاعات بیشتر در مورد Alerts API به Alerts API مراجعه کنید.

هشدارها و اعلان ها را با استفاده از API تنظیم کنید

هشدارها و اعلان‌ها را با ارسال یک درخواست POST به منبع زیر تنظیم کنید: https://apimonitoring.enterprise.apigee.com/alerts .

بخش‌های زیر نمونه‌هایی از تنظیم هشدارها و اعلان‌ها با استفاده از API را ارائه می‌دهند:

با استفاده از API یک هشدار کد وضعیت 5xx برای یک پراکسی API تنظیم کنید

مثال زیر نحوه تنظیم هشداری را نشان می‌دهد که وقتی کدهای وضعیت 5xx با نرخی بیش از 100 تراکنش در ثانیه (TPS) به مدت 10 دقیقه برای پراکسی API هتل‌ها در محیط prod برای هر منطقه رخ می‌دهد، فعال می‌شود. هنگامی که هشدار فعال می شود، یک اعلان به آدرس ایمیل مشخص شده ارسال می شود.

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

همانطور که در دریافت نشانه دسترسی OAuth 2.0 توضیح داده شده است، $ACCESS_TOKEN روی نشانه دسترسی OAuth 2.0 خود تنظیم کنید.

برای اطلاعات در مورد گزینه های cURL استفاده شده در این مثال، استفاده از cURL را ببینید.

با استفاده از API، یک هشدار تاخیر صدک 95 را برای یک پراکسی API تنظیم کنید

مثال زیر نحوه تنظیم هشداری را نشان می‌دهد که اگر تأخیر کل پاسخ برای صدک 95 بیشتر از 100 میلی‌ثانیه برای 5 دقیقه برای پراکسی API هتل در محیط prod برای هر منطقه باشد، راه‌اندازی می‌شود.

در صورت ایجاد هشدار، یک اعلان به Webhook مشخص شده ارسال می شود.

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

همانطور که در دریافت نشانه دسترسی OAuth 2.0 توضیح داده شده است، $ACCESS_TOKEN روی نشانه دسترسی OAuth 2.0 خود تنظیم کنید.

برای اطلاعات در مورد گزینه های cURL استفاده شده در این مثال، استفاده از cURL را ببینید.

یک هشدار کد وضعیت 404 (Application Not Found) برای همه پراکسی های API با استفاده از API تنظیم کنید

مثال زیر نحوه تنظیم هشداری را نشان می‌دهد که وقتی کدهای وضعیت HTTP 404 با نرخی بیش از 10 درصد به مدت 5 دقیقه برای همه پراکسی‌های API در محیط prod برای هر منطقه رخ می‌دهند، راه‌اندازی می‌شود.

هنگامی که هشدار فعال می شود، یک اعلان به کانال Slack مشخص شده ارسال می شود.

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

همانطور که در دریافت نشانه دسترسی OAuth 2.0 توضیح داده شده است، $ACCESS_TOKEN روی نشانه دسترسی OAuth 2.0 خود تنظیم کنید.

برای اطلاعات در مورد گزینه های cURL استفاده شده در این مثال، استفاده از cURL را ببینید.

با استفاده از API یک هشدار شمارش پروکسی API برای API ها تنظیم کنید

در زیر نمونه‌ای از نحوه تنظیم هشداری ارائه می‌شود که وقتی تعداد کدهای 5xx برای APIها برای هر منطقه‌ای به مدت 5 دقیقه از 200 بیشتر شود، فعال می‌شود.

در این مثال، APIها در مجموعه Critical API Proxies (با UUID aeff4394-86b7-11e8-83d7-42010a840040) ثبت می شوند. برای به دست آوردن UUID برای یک مجموعه، مشاهده همه مجموعه ها با استفاده از 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
    }'

همانطور که در دریافت نشانه دسترسی OAuth 2.0 توضیح داده شده است، $ACCESS_TOKEN روی نشانه دسترسی OAuth 2.0 خود تنظیم کنید.

برای اطلاعات در مورد گزینه های cURL استفاده شده در این مثال، استفاده از cURL را ببینید.

با استفاده از API یک هشدار میزان خطا برای سرویس های هدف تنظیم کنید

در زیر مثالی از نحوه تنظیم هشداری ارائه می‌شود که وقتی نرخ کد 500 برای سرویس‌های هدف از 10٪ برای هر منطقه برای یک ساعت بیشتر شود، فعال می‌شود.

در این مثال، سرویس‌های هدف در مجموعه اهداف بحرانی (با UUID aeff4394-86b7-11e8-83d7-42010a840040) ثبت می‌شوند. برای به دست آوردن UUID برای یک مجموعه، مشاهده همه مجموعه ها با استفاده از 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
    }'

همانطور که در دریافت نشانه دسترسی OAuth 2.0 توضیح داده شده است، $ACCESS_TOKEN روی نشانه دسترسی OAuth 2.0 خود تنظیم کنید.

برای اطلاعات در مورد گزینه های cURL استفاده شده در این مثال، استفاده از cURL را ببینید.

با استفاده از API، یک هشدار میزان خطا برای خط مشی Callout Service تنظیم کنید

در زیر نمونه‌ای از نحوه تنظیم هشداری ارائه می‌شود که وقتی نرخ کد 500 برای سرویس مشخص‌شده توسط خط‌مشی ServiceCallout از 10٪ برای 1 ساعت برای هر منطقه بیشتر شود، فعال می‌شود.

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

همانطور که در دریافت نشانه دسترسی OAuth 2.0 توضیح داده شده است، $ACCESS_TOKEN روی نشانه دسترسی OAuth 2.0 خود تنظیم کنید.

برای اطلاعات در مورد گزینه های cURL استفاده شده در این مثال، استفاده از cURL را ببینید.

با استفاده از API یک هشدار کد خطای خط مشی تنظیم کنید

مثال زیر نحوه تنظیم یک هشدار را نشان می دهد که در صورت رعایت یکی از شرایط زیر فعال می شود:

  • تعداد کد خطا SpikeArrestViolation برای APIهای موجود در محیط prod برای هر منطقه، بیشتر از 10 به مدت 5 دقیقه است.
  • تعداد کدهای خطای پروتکل API برای APIهای موجود در محیط prod برای هر منطقه، بیش از 3 درصد به مدت 5 دقیقه است.

در این مثال، APIها در مجموعه Critical API Proxies (با UUID aeff4394-86b7-11e8-83d7-42010a840040) ثبت می شوند. برای به دست آوردن UUID برای یک مجموعه، مشاهده همه مجموعه ها با استفاده از API را ببینید.

هنگامی که هشدار فعال می شود، یک اعلان به کد PagerDuty مشخص شده ارسال می شود.

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 توضیح داده شده است، $ACCESS_TOKEN روی نشانه دسترسی OAuth 2.0 خود تنظیم کنید.

برای اطلاعات در مورد گزینه های cURL استفاده شده در این مثال، استفاده از cURL را ببینید.

مشاهده هشدارها و اعلان ها

بخش‌های زیر نمونه‌هایی از مشاهده تعاریف هشدار و اطلاعات مربوط به هشدارهای راه‌اندازی شده با استفاده از API را ارائه می‌دهند:

مشاهده تمام تعاریف هشدار برای یک سازمان

همه تعاریف هشدار و اعلان را با ارسال یک درخواست GET به API زیر مشاهده کنید: https://apimonitoring.enterprise.apigee.com/alerts .

شما باید نام سازمان خود را با استفاده از پارامتر org query ارسال کنید.

به عنوان مثال:

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

UUID هشدار در قسمت uuid پاسخ نشان داده شده است. شما به این UUID برای برقراری تماس برای تعیین اطلاعات خاص برای تعریف هشدار نیاز دارید. در زیر نمونه ای از پاسخ ارائه شده است:

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

همانطور که در دریافت نشانه دسترسی OAuth 2.0 توضیح داده شده است، $ACCESS_TOKEN روی نشانه دسترسی OAuth 2.0 خود تنظیم کنید.

برای اطلاعات در مورد گزینه های cURL استفاده شده در این مثال، استفاده از cURL را ببینید.

یک تعریف هشدار خاص را مشاهده کنید

با ارسال یک درخواست GET به منبع زیر، یک تعریف هشدار خاص را مشاهده کنید: https://apimonitoring.enterprise.apigee.com/alerts/ alert_uuid که در آن alert_uuid UUID تعریف هشدار را مشخص می کند. هنگام ایجاد هشدار، UUID را دریافت کنید یا از تماس API نشان داده شده در بخش قبل برای فهرست کردن همه هشدارها و UUID مرتبط با آنها استفاده کنید.

به عنوان مثال:

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

در زیر نمونه ای از پاسخ ارائه شده است:

  {
    "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 توضیح داده شده است، $ACCESS_TOKEN روی نشانه دسترسی OAuth 2.0 خود تنظیم کنید.

برای اطلاعات در مورد گزینه های cURL استفاده شده در این مثال، استفاده از cURL را ببینید.

مشاهده تاریخچه همه هشدارهای فعال شده برای یک سازمان

با ارسال یک درخواست GET به منبع زیر، تاریخچه همه هشدارهای ایجاد شده برای یک سازمان را مشاهده کنید: https://apimonitoring.enterprise.apigee.com/metrics/alerthistory .

شما باید نام سازمان خود را با استفاده از پارامتر org query ارسال کنید. شما می توانید به صورت اختیاری یک دوره زمانی مورد استفاده برای جستجوی هشدارهای راه اندازی شده را مشخص کنید. پیش‌فرض این است که همه هشدارهایی را که در ساعت گذشته فعال شده‌اند، بازگرداند.

به عنوان مثال:

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

پاسخ شامل آرایه‌ای از همه هشدارهایی است که در طول دوره زمانی درخواستی فعال شده‌اند. در بدنه پاسخ، فیلد id UUID هشدار راه‌اندازی شده را مشخص می‌کند و قسمت shared_id UUID تعریف هشدار مرتبط با هشدار راه‌اندازی شده را مشخص می‌کند.

در زیر نمونه ای از پاسخ ارائه شده است.

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

همانطور که در دریافت نشانه دسترسی OAuth 2.0 توضیح داده شده است، $ACCESS_TOKEN روی نشانه دسترسی OAuth 2.0 خود تنظیم کنید.

برای اطلاعات در مورد گزینه های cURL استفاده شده در این مثال، استفاده از cURL را ببینید.

مشاهده تاریخچه هشدار خاص

با ارسال یک درخواست GET به منبع زیر، تاریخچه هشدارهای راه اندازی شده را برای تعریف هشدار خاص مشاهده کنید: https://apimonitoring.enterprise.apigee.com/metrics/alerthistory .

شما باید نام سازمان خود را با استفاده از پارامتر org query و UUID تعریف هشدار ارسال کنید. شما می توانید به صورت اختیاری یک دوره زمانی مورد استفاده برای جستجوی هشدارها را مشخص کنید. پیش‌فرض این است که همه هشدارهایی را که در ساعت گذشته فعال شده‌اند، بازگرداند.

می‌توانید UUID تعریف هشدار را از تاریخچه هشدار همانطور که در بخش قبل نشان داده شده است، هنگام ایجاد تعریف هشدار، یا با استفاده از فراخوانی API نشان داده شده در مشاهده همه تعاریف هشدار دریافت کنید.

به عنوان مثال:

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"    

پاسخ شامل آرایه ای از همه هشدارها است که در طول دوره زمانی درخواست شده برای UUID تعریف هشدار مشخص شده راه اندازی شده اند. در بدنه پاسخ، فیلد id UUID هشدار راه‌اندازی شده را مشخص می‌کند و قسمت shared_id UUID تعریف هشدار مرتبط با هشدار راه‌اندازی شده را مشخص می‌کند.

در زیر نمونه ای از پاسخ ارائه شده است.

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

همانطور که در دریافت نشانه دسترسی OAuth 2.0 توضیح داده شده است، $ACCESS_TOKEN روی نشانه دسترسی OAuth 2.0 خود تنظیم کنید.

برای اطلاعات در مورد گزینه های cURL استفاده شده در این مثال، استفاده از cURL را ببینید.