إدارة التنبيهات والإشعارات باستخدام واجهة برمجة التطبيقات

أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
info

توضّح الأقسام التالية كيفية إدارة التنبيهات باستخدام واجهة برمجة التطبيقات.

اطّلِع على Alerts API للحصول على مزيد من المعلومات حول واجهة برمجة التطبيقات Alerts API.

إعداد التنبيهات والإشعارات باستخدام واجهة برمجة التطبيقات

يمكنك إعداد التنبيهات والإشعارات من خلال إرسال طلب POST إلى المورد التالي: https://apimonitoring.enterprise.apigee.com/alerts.

تقدّم الأقسام التالية أمثلة على إعداد التنبيهات والإشعارات باستخدام واجهة برمجة التطبيقات:

إعداد تنبيه رمز الحالة 5xx لخادم وكيل لواجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات

يوضّح المثال التالي كيفية إعداد تنبيه يتم تشغيله عند حدوث رموز حالة 5xx بمعدّل أكبر من 100 معاملة في الثانية (TPS) لمدة 10 دقائق لوكيل واجهة برمجة التطبيقات للفنادق في بيئة الإنتاج لأي منطقة. يتم إرسال إشعار إلى عنوان البريد الإلكتروني المحدّد عند بدء التنبيه.

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.

إعداد تنبيه وقت الاستجابة في الشريحة المئوية التسعون لوكيل واجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات

يوضّح المثال التالي كيفية إعداد تنبيه يتم تشغيله إذا كان إجمالي وقت استجابة الردّ في الشريحة المئوية التسعون أكبر من 100 ملي ثانية لمدة 5 دقائق لوكيل واجهة برمجة التطبيقات للفنادق في بيئة الإنتاج لأي منطقة.

يتم إرسال إشعار إلى 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.

إعداد تنبيه رمز الحالة 404 (لم يتم العثور على التطبيق) لجميع الخوادم الوكيلة لواجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات

يوضّح المثال التالي كيفية إعداد تنبيه يتم تشغيله عند ظهور رموز حالة HTTP 404 بمعدّل أكبر من% 10 لمدة 5 دقائق لجميع أدوات الربط بواجهة برمجة التطبيقات في بيئة الإنتاج لأي منطقة.

يتم إرسال إشعار إلى قناة 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.

إعداد تنبيه عدد الخادم الوكيل لواجهة برمجة التطبيقات باستخدام واجهة برمجة التطبيقات

في ما يلي مثال على كيفية إعداد تنبيه يتم تشغيله عندما يتجاوز عدد الرموز 5xx لواجهات برمجة التطبيقات 200 لمدة 5 دقائق في أي منطقة.

في هذا المثال، يتم تسجيل واجهات برمجة التطبيقات في مجموعة "خوادم الوكيل الخاصة بواجهات برمجة التطبيقات المهمة" (التي تحمل رقم التعريف الفريد aeff4394-86b7-11e8-83d7-42010a840040). للحصول على معرّف UUID لمجموعة، يُرجى الاطّلاع على عرض جميع المجموعات باستخدام واجهة برمجة التطبيقات.

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.

إعداد تنبيه معدّل الخطأ للخدمات المستهدفة باستخدام واجهة برمجة التطبيقات

في ما يلي مثال على كيفية إعداد تنبيه يتم تشغيله عندما يتجاوز معدّل ظهور الرمز 500 للخدمات المستهدَفة% 10 لمدة ساعة واحدة في أي منطقة.

في هذا المثال، يتم تسجيل الخدمات المستهدفة في مجموعة الأهداف المهمة (باستخدام المعرّف الفريد العالمي aeff4394-86b7-11e8-83d7-42010a840040). للحصول على معرّف UUID لمجموعة، يُرجى الاطّلاع على عرض جميع المجموعات باستخدام واجهة برمجة التطبيقات.

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.

إعداد تنبيه لنسبة الأخطاء في سياسة "البيانات المعروضة في خدمة Google" باستخدام واجهة برمجة التطبيقات

في ما يلي مثال على كيفية إعداد تنبيه يتم تشغيله عندما يتجاوز معدّل ظهور الخطأ 500 للخدمة الذي تحدّده سياسة ServiceCallout% 10 لمدة ساعة واحدة في أي منطقة.

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 عدد رموز الأخطاء أكبر من 10 لمدة 5 دقائق لواجهات برمجة التطبيقات في بيئة الإنتاج لأي منطقة.
  • يزيد عدد جميع رموز أخطاء بروتوكول واجهة برمجة التطبيقات عن 3% لمدة 5 دقائق لواجهات برمجة التطبيقات في بيئة الإنتاج لأي منطقة.

في هذا المثال، يتم تسجيل واجهات برمجة التطبيقات في مجموعة "خوادم الوكيل لـ Critical API" (التي تحمل رقم التعريف الفريد aeff4394-86b7-11e8-83d7-42010a840040). للحصول على معرّف UUID لمجموعة، يُرجى الاطّلاع على عرض جميع المجموعات باستخدام واجهة برمجة التطبيقات.

يتم إرسال إشعار إلى رمز 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.

عرض التنبيهات والإشعارات

تقدِّم الأقسام التالية أمثلة على عرض تعريفات التنبيهات ومعلومات عن التنبيهات التي تم تشغيلها باستخدام واجهة برمجة التطبيقات:

عرض جميع تعريفات التنبيهات لمؤسسة

يمكنك الاطّلاع على جميع تعريفات التنبيهات والإشعارات من خلال إرسال طلب 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 هذا لإجراء مكالمات لتحديد معلومات محدّدة لتعريف تنبيه. يقدم ما يلي مثالاً على الرد:

[ 
 {
    "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 معرّف UUID لتعريف التنبيه. يمكنك الحصول على معرّف UUID عند إنشاء التنبيه أو استخدام طلب البيانات من واجهة برمجة التطبيقات المعروض في القسم السابق لإدراج جميع التنبيهات ومعرّفات 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 معرّف 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"
  },
 ...
]

اضبط $ACCESS_TOKEN على رمز الوصول عبر OAuth 2.0، كما هو موضّح في مقالة الحصول على رمز وصول عبر OAuth 2.0.

للحصول على معلومات عن خيارات cURL المستخدَمة في هذا المثال، اطّلِع على مقالة استخدام cURL.

عرض سجلّ تنبيه معيّن

يمكنك الاطّلاع على سجلّ التنبيهات التي تم تشغيلها لتعريف تنبيه معيّن من خلال إرسال طلب GET إلى المرجع التالي: https://apimonitoring.enterprise.apigee.com/metrics/alerthistory.

يجب إدخال اسم مؤسستك باستخدام مَعلمة طلب البحث org ومعرّف UUID لتعريف التنبيه. يمكنك اختياريًا تحديد فترة زمنية يتم استخدامها للبحث عن التنبيهات. الإعداد التلقائي هو عرض جميع التنبيهات التي تم تشغيلها خلال الساعة الماضية.

يمكنك الحصول على معرّف UUID لتعريف التنبيه من سجلّ التنبيهات كما هو موضّح في القسم السابق، عند إنشاء تعريف التنبيه، أو باستخدام طلب البيانات من واجهة برمجة التطبيقات المعروض في عرض جميع تعريفات التنبيهات.

على سبيل المثال:

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 المعرّف الفريد العالمي للتنبيه الذي تم تشغيله، ويحدّد الحقل 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.