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

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

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

لمزيد من المعلومات عن واجهة برمجة التطبيقات للتنبيهات، يُرجى الاطّلاع على 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). للحصول على رقم التعريف الفريد العالمي لمجموعة، يُرجى الاطّلاع على مقالة عرض جميع المجموعات باستخدام واجهة برمجة التطبيقات.

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). للحصول على رقم التعريف الفريد العالمي لمجموعة، يُرجى الاطّلاع على مقالة عرض جميع المجموعات باستخدام واجهة برمجة التطبيقات.

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.

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

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

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

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

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

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

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

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.