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

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

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

برای اطلاعات بیشتر درباره «میانای برنامه‌سازی کاربردی هشدارها»، میانای برنامه‌سازی کاربردی هشدارها را ببینید.

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

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

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

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

مثال زیر نشان می‌دهد چگونه هشداری راه‌اندازی کنید که وقتی کدهای وضعیت ۵xx با نرخی بیشتر از ۱۰۰ تراکنش در ثانیه (TPS) به‌مدت ۱۰ دقیقه برای پراکسی 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
    }'

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

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

راه‌اندازی هشدار تأخیر صدک ۹۵ برای پراکسی میانای برنامه‌سازی کاربردی بااستفاده از میانای برنامه‌سازی کاربردی

مثال زیر نشان می‌دهد چگونه هشداری راه‌اندازی کنید که اگر تأخیر کل پاسخ برای صدک ۹۵ به‌مدت ۵ دقیقه برای کارگزار 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
}'

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

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

برای همه پراکسی‌های میانای برنامه‌سازی کاربردی که از میانای برنامه‌سازی کاربردی استفاده می‌کنند، هشدار کد وضعیت ۴۰۴ (برنامه پیدا نشد) راه‌اندازی کنید

مثال زیر نشان می‌دهد چگونه هشداری راه‌اندازی کنید که وقتی کدهای وضعیت HTTP 404 با نرخی بیشتر از ۱۰٪ برای ۵ دقیقه برای همه پراکسی‌های API در محیط تولید برای هر منطقه رخ می‌دهد، راه‌اندازی شود.

وقتی هشدار راه‌اندازی می‌شود، اعلانی به کانال 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
}'

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

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

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

در زیر نمونه‌ای از نحوه تنظیم هشدار ارائه شده است که وقتی تعداد کد ۵xx برای APIها در هر منطقه در ۵ دقیقه از ۲۰۰ فراتر رود، راه‌اندازی می‌شود.

در این مثال، میاناهای برنامه‌سازی کاربردی در مجموعه «پراکسی‌های API حیاتی» (با 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
    }'

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

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

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

در زیر نمونه‌ای از نحوه تنظیم هشدار ارائه شده است که وقتی نرخ کد ۵۰۰ برای خدمات هدف در هر منطقه‌ای به‌مدت ۱ ساعت از ۱۰٪ فراتر رود، راه‌اندازی می‌شود.

در این مثال، خدمات هدف در مجموعه «هدف‌های حیاتی» (با 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
    }'

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

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

بااستفاده از «میانای برنامه‌سازی کاربردی»، هشدار نرخ خطا را برای خط‌مشی «خدمات پیامک ویژه» راه‌اندازی کنید

در زیر نمونه‌ای از نحوه تنظیم هشدار ارائه شده است که وقتی نرخ کد ۵۰۰ برای سرویس مشخص‌شده توسط خط‌مشی «تماس با سرویس» برای ۱ ساعت در هر منطقه‌ای از ۱۰٪ فراتر رود راه‌اندازی می‌شود.

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

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

راه‌اندازی هشدار کد خطای خط‌مشی بااستفاده از «میانای برنامه‌سازی کاربردی»

مثال زیر نحوه راه‌اندازی هشداری را نشان می‌دهد که وقتی یکی از شرایط زیر برآورده شود راه‌اندازی می‌شود:

  • تعداد کد خطای SpikeArrestViolation برای ۵ دقیقه برای APIها در محیط تولید برای هر منطقه‌ای بیشتر از ۱۰ است.
  • تعداد همه کدهای خطای پروتکل API برای ۵ دقیقه برای APIهای موجود در محیط تولید برای هر منطقه بیشتر از ۳٪ است.

در این مثال، میاناهای برنامه‌سازی کاربردی در مجموعه «پراکسی‌های API حیاتی» (با 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
}'

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

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

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

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

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

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

باید نام سازمانتان را بااستفاده از پارامتر پُرسمان org ارسال کنید.

برای مثال:

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": "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 را روی کد دسترسی OAuth 2.0 تنظیم کنید، همان‌طور که در دریافت کد دسترسی OAuth 2.0 توضیح داده شده است.

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

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

با صدور درخواست GET به منبع زیر، تعریف هشدار خاصی را مشاهده کنید: https://apimonitoring.enterprise.apigee.com/alerts/alert_uuid که در آن alert_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"
  }

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

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

مشاهده سابقه همه هشدارهای راه‌اندازی‌شده برای سازمان

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

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

برای مثال:

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

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

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

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

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

مشاهده سابقه هشدار خاص

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

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

می‌توانید 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"    

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

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

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

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