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

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. المعلومات

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

يمكنك الاطّلاع على 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.

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

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

يتم إرسال إشعار إلى الردّ التلقائي على الويب المحدّد في حال تشغيل التنبيه.

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 دقائق لأي منطقة.

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

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% لمدة ساعة واحدة لأي منطقة.

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

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.

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

في ما يلي مثال على كيفية إعداد تنبيه يتم تشغيله عند تجاوز معدّل الرمز 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 دقائق بالنسبة إلى واجهات برمجة التطبيقات في بيئة الإنتاج لأي منطقة.

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

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

مثال:

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 المعرّف الفريد العالمي (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) لتعريف التنبيه. يمكنك اختياريًا تحديد فترة زمنية تُستخدم للبحث عن التنبيهات. الإعداد التلقائي هو عرض جميع التنبيهات التي تم تشغيلها خلال الساعة الماضية.

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

مثال:

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 المعرّف الفريد العالمي (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"
  },
 ...
]

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

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