एपीआई का इस्तेमाल करके सूचनाएं और सूचनाएं मैनेज करना

यहां Apigee Edge के दस्तावेज़ देखे जा रहे हैं.
पर जाएं Apigee X दस्तावेज़.
info

नीचे दिए गए सेक्शन में, एपीआई का इस्तेमाल करके चेतावनियां मैनेज करने का तरीका बताया गया है.

चेतावनी वाले एपीआई के बारे में ज़्यादा जानने के लिए, चेतावनियों का एपीआई देखें.

एपीआई का इस्तेमाल करके चेतावनियां और सूचनाएं सेट अप करना

चेतावनियां और सूचनाएं सेट अप करने के लिए, इस संसाधन को POST अनुरोध भेजें: https://apimonitoring.enterprise.apigee.com/alerts.

यहां दिए गए सेक्शन में, एपीआई का इस्तेमाल करके चेतावनियां और सूचनाएं सेट अप करने के उदाहरण दिए गए हैं:

एपीआई का इस्तेमाल करके, एपीआई प्रॉक्सी के लिए 5xx स्टेटस कोड की चेतावनी सेट अप करना

यहां दिए गए उदाहरण में, ऐसी चेतावनी सेट अप करने का तरीका बताया गया है जो तब ट्रिगर होती है, जब किसी भी इलाके के लिए, प्रॉड एनवायरमेंट में होटल के एपीआई प्रॉक्सी के लिए, 5xx स्टेटस कोड हर सेकंड 100 से ज़्यादा लेन-देन (टीपीएस) की दर से 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
    }'

OAuth 2.0 के ऐक्सेस टोकन के लिए, $ACCESS_TOKEN को सेट करें. इसके बारे में, OAuth 2.0 का ऐक्सेस टोकन हासिल करना लेख में बताया गया है.

इस उदाहरण में इस्तेमाल किए गए cURL विकल्पों के बारे में जानने के लिए, cURL का इस्तेमाल करना लेख पढ़ें.

एपीआई का इस्तेमाल करके, एपीआई प्रॉक्सी के लिए 95वें पर्सेंटाइल लेटेंसी की चेतावनी सेट अप करना

यहां दिए गए उदाहरण में, ऐसी चेतावनी सेट अप करने का तरीका बताया गया है जो तब ट्रिगर होती है, जब किसी भी इलाके के लिए, प्रॉड एनवायरमेंट में होटल के एपीआई प्रॉक्सी के लिए, 95वें पर्सेंटाइल के लिए कुल रिस्पॉन्स लेटेंसी, पांच मिनट तक 100 मिसेकंड से ज़्यादा होती है.

चेतावनी ट्रिगर होने पर, बताए गए वेबहुक पर एक सूचना भेजी जाती है.

curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
  -X POST \
  -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
     "organization":"myorg",
     "name":"My Alert",
     "description":"My first alert",
     "environment":"prod",
     "enabled":true,
     "conditions":[
     {
        "description":"",
        "dimensions":{
            "org":"myorg", 
            "env":"prod",
            "proxy" : "hotels",
            "region":"ANY",
            "percentile":"95"
        },
        "metric":"totalLatency",
        "threshold":100,
        "durationSeconds":300,
        "comparator":">"
     }
     ],
     "notifications":[{ "channel":"webhook", "destination":"https://apigee.com/test-webhook"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

OAuth 2.0 के ऐक्सेस टोकन के लिए, $ACCESS_TOKEN को सेट करें. इसके बारे में, OAuth 2.0 का ऐक्सेस टोकन हासिल करना लेख में बताया गया है.

इस उदाहरण में इस्तेमाल किए गए cURL विकल्पों के बारे में जानने के लिए, cURL का इस्तेमाल करना लेख पढ़ें.

एपीआई का इस्तेमाल करके, सभी एपीआई प्रॉक्सी के लिए 404 (ऐप्लिकेशन नहीं मिला) स्टेटस कोड की चेतावनी सेट अप करना

यहां दिए गए उदाहरण में, ऐसी चेतावनी सेट अप करने का तरीका बताया गया है जो तब ट्रिगर होती है, जब किसी भी इलाके के लिए, प्रॉड एनवायरमेंट में सभी एपीआई प्रॉक्सी के लिए, एचटीटीपी 404 स्टेटस कोड पांच मिनट तक 10% से ज़्यादा की दर से दिखते हैं.

चेतावनी ट्रिगर होने पर, बताए गए Slack चैनल पर एक सूचना भेजी जाती है.

curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
  -X POST \
  -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
     "organization":"myorg",
     "name":"404 Application Not Found Alert",
     "description":"My 404 alert",
     "environment":"prod",
     "enabled":true,
     "conditions":[
     {
        "description":"",
        "dimensions":{"org":"myorg", 
            "env":"prod", 
            "proxy":"ALL",
            "region":"ANY",
            "statusCode":"404"},
        "metric":"rate",
        "threshold":0.05,
        "durationSeconds":300,
        "comparator":">"
     }],
     "notifications":[{ "channel":"slack", "destination":"https://hooks.slack.com/services/T00000000/B00000000/XXXXX"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

OAuth 2.0 के ऐक्सेस टोकन के लिए, $ACCESS_TOKEN को सेट करें. इसके बारे में, OAuth 2.0 का ऐक्सेस टोकन हासिल करना लेख में बताया गया है.

इस उदाहरण में इस्तेमाल किए गए cURL विकल्पों के बारे में जानने के लिए, cURL का इस्तेमाल करना लेख पढ़ें.

एपीआई का इस्तेमाल करके, एपीआई के लिए एपीआई प्रॉक्सी की संख्या की चेतावनी सेट अप करना

यहां दिए गए उदाहरण में, ऐसी चेतावनी सेट अप करने का तरीका बताया गया है जो तब ट्रिगर होती है, जब किसी भी इलाके के लिए, एपीआई के लिए 5xx कोड की संख्या पांच मिनट तक 200 से ज़्यादा हो जाती है.

इस उदाहरण में, एपीआई को 'अहम एपीआई प्रॉक्सी' कलेक्शन (जिसका यूयूआईडी 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
    }'

OAuth 2.0 के ऐक्सेस टोकन के लिए, $ACCESS_TOKEN को सेट करें. इसके बारे में, 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
    }'

OAuth 2.0 के ऐक्सेस टोकन के लिए, $ACCESS_TOKEN को सेट करें. इसके बारे में, OAuth 2.0 का ऐक्सेस टोकन हासिल करना लेख में बताया गया है.

इस उदाहरण में इस्तेमाल किए गए cURL विकल्पों के बारे में जानने के लिए, cURL का इस्तेमाल करना लेख पढ़ें.

एपीआई का इस्तेमाल करके, Service Callout नीति के लिए गड़बड़ी की दर की चेतावनी सेट अप करना

यहां दिए गए उदाहरण में, ऐसी चेतावनी सेट अप करने का तरीका बताया गया है जो तब ट्रिगर होती है, जब किसी भी इलाके के लिए, ServiceCallout नीति में बताई गई सेवा के लिए 500 कोड की दर एक घंटे तक 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
    }'

OAuth 2.0 के ऐक्सेस टोकन के लिए, $ACCESS_TOKEN को सेट करें. इसके बारे में, OAuth 2.0 का ऐक्सेस टोकन हासिल करना लेख में बताया गया है.

इस उदाहरण में इस्तेमाल किए गए cURL विकल्पों के बारे में जानने के लिए, cURL का इस्तेमाल करना लेख पढ़ें.

एपीआई का इस्तेमाल करके, नीति के फ़ॉल्ट कोड की चेतावनी सेट अप करना

यहां दिए गए उदाहरण में, ऐसी चेतावनी सेट अप करने का तरीका बताया गया है जो तब ट्रिगर होती है, जब इनमें से कोई एक शर्त पूरी होती है:

  • किसी भी इलाके के लिए, प्रॉड एनवायरमेंट में एपीआई के लिए, SpikeArrestViolation फ़ॉल्ट कोड की संख्या पांच मिनट तक 10 से ज़्यादा होती है.
  • किसी भी इलाके के लिए, प्रॉड एनवायरमेंट में एपीआई के लिए, सभी एपीआई प्रोटोकॉल फ़ॉल्ट कोड की संख्या पांच मिनट तक 3% से ज़्यादा होती है.

इस उदाहरण में, एपीआई को 'अहम एपीआई प्रॉक्सी' कलेक्शन (जिसका यूयूआईडी 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
}'

OAuth 2.0 के ऐक्सेस टोकन के लिए, $ACCESS_TOKEN को सेट करें. इसके बारे में, OAuth 2.0 का ऐक्सेस टोकन हासिल करना लेख में बताया गया है.

इस उदाहरण में इस्तेमाल किए गए cURL विकल्पों के बारे में जानने के लिए, cURL का इस्तेमाल करना लेख पढ़ें.

चेतावनियां और सूचनाएं देखना

यहां दिए गए सेक्शन में, एपीआई का इस्तेमाल करके, चेतावनी की परिभाषाएं और ट्रिगर हुई चेतावनियों के बारे में जानकारी देखने के उदाहरण दिए गए हैं:

किसी संगठन के लिए, चेतावनी की सभी परिभाषाएं देखना

चेतावनी और सूचना की सभी परिभाषाएं देखने के लिए, इस एपीआई को जीईटी अनुरोध भेजें: 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"
  },
 ...
]

OAuth 2.0 के ऐक्सेस टोकन के लिए, $ACCESS_TOKEN को सेट करें. इसके बारे में, OAuth 2.0 का ऐक्सेस टोकन हासिल करना लेख में बताया गया है.

इस उदाहरण में इस्तेमाल किए गए cURL विकल्पों के बारे में जानने के लिए, cURL का इस्तेमाल करना लेख पढ़ें.

चेतावनी की कोई खास परिभाषा देखना

चेतावनी की कोई खास परिभाषा देखने के लिए, इस संसाधन को जीईटी अनुरोध भेजें: 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"
  }

OAuth 2.0 के ऐक्सेस टोकन के लिए, $ACCESS_TOKEN को सेट करें. इसके बारे में, OAuth 2.0 का ऐक्सेस टोकन हासिल करना लेख में बताया गया है.

इस उदाहरण में इस्तेमाल किए गए cURL विकल्पों के बारे में जानने के लिए, cURL का इस्तेमाल करना लेख पढ़ें.

किसी संगठन के लिए, ट्रिगर हुई सभी चेतावनियों का इतिहास देखना

किसी संगठन के लिए, ट्रिगर हुई सभी चेतावनियों का इतिहास देखने के लिए, इस संसाधन को जीईटी अनुरोध भेजें: 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"
  },
 ...
]

OAuth 2.0 के ऐक्सेस टोकन के लिए, $ACCESS_TOKEN को सेट करें. इसके बारे में, OAuth 2.0 का ऐक्सेस टोकन हासिल करना लेख में बताया गया है.

इस उदाहरण में इस्तेमाल किए गए cURL विकल्पों के बारे में जानने के लिए, cURL का इस्तेमाल करना लेख पढ़ें.

चेतावनी का इतिहास देखना

चेतावनी की किसी खास परिभाषा के लिए, ट्रिगर हुई चेतावनियों का इतिहास देखने के लिए, इस संसाधन को जीईटी अनुरोध भेजें: 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"    

रिस्पॉन्स में, अनुरोध की गई समयावधि के दौरान, चेतावनी की परिभाषा के बताए गए यूयूआईडी के लिए ट्रिगर हुई सभी चेतावनियों की एक कलेक्शन होती है. रिस्पॉन्स के मुख्य भाग में, the id फ़ील्ड में ट्रिगर हुई चेतावनी का यूयूआईडी दिखता है. वहीं, the 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"
  },
 ...
]

OAuth 2.0 के ऐक्सेस टोकन के लिए, $ACCESS_TOKEN को सेट करें. इसके बारे में, OAuth 2.0 का ऐक्सेस टोकन हासिल करना लेख में बताया गया है.

इस उदाहरण में इस्तेमाल किए गए cURL विकल्पों के बारे में जानने के लिए, cURL का इस्तेमाल करना लेख पढ़ें.