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

आपको Apigee Edge दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं.
जानकारी

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

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

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

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

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

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

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

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

सूचना ट्रिगर होने पर, तय किए गए 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 कोड की संख्या 5 मिनट के लिए 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
    }'

$ACCESS_TOKEN को अपने OAuth 2.0 ऐक्सेस टोकन पर सेट करें, जैसा कि OAuth 2.0 ऐक्सेस टोकन पाना में बताया गया है.

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

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

यहां एक उदाहरण दिया गया है. इसमें बताया गया है कि जब किसी इलाके के लिए, टारगेट की जाने वाली सेवाओं के लिए 500 कोड की दर 1 घंटे के लिए 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 का इस्तेमाल करना लेख पढ़ें.

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

यहां एक उदाहरण दिया गया है, जिसमें सूचना सेट अप करने का तरीका बताया गया है. यह सूचना तब ट्रिगर होती है, जब सर्विसकॉलआउट नीति में दी गई सेवा के लिए, 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 का इस्तेमाल करना लेख पढ़ें.

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

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

किसी संगठन के लिए सूचनाओं की सभी परिभाषाएं देखना

नीचे दिए गए एपीआई के लिए 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 का इस्तेमाल करना लेख पढ़ें.

खास सूचना की परिभाषा देखें

सूचना की खास परिभाषा देखें. इसके लिए, यहां दिए गए संसाधन के लिए जीईटी अनुरोध जारी करें: https://apimonitoring.enterprise.apigee.com/alerts/alert_uuid जहां alert_uuid, सूचना की परिभाषा के यूयूआईडी के बारे में बताता है. सूचना बनाते समय यूयूआईडी पाएं या सभी सूचनाओं और उनसे जुड़े यूयूआईडी को सूची में शामिल करने के लिए, पिछले सेक्शन में दिखाए गए एपीआई कॉल का इस्तेमाल करें.

उदाहरण के लिए:

curl 'https://apimonitoring.enterprise.apigee.com/alerts/4fa49a87-3463023ea7c4'
    -X GET
    -H 'Accept: application/json, text/plain, */*'
    -H "Authorization: Bearer $ACCESS_TOKEN"    

यहां जवाब का एक उदाहरण दिया गया है:

  {
    "uuid": "4fa49a87-3463023ea7c4",
    "name": "PublicAPI latency alert",
    "enabled": true,
    "description": "Public API Latency alerts, 90th %ile > 6secs for 5 minute window trigger this alert",
    "conditions": [
      {
        "uuid": "4fa49a87-3463023ea7c4",
        "description": "",
        "dimensions": {
          "env": "prod",
          "org": "myorg",
          "percentile": "90",
          "proxy": "PublicAPI",
          "region": "ANY"
        },
        "metric": "totalLatency",
        "threshold": 6000,
        "durationSeconds": 300,
        "comparator": ">",
        "updatedBy": "me@foo.com"
      }
    ],
    "playbook": "PublicAPI Latency alert, setup to go off when 90th %ile is > 4 secs for 5 minute window",
    "throttleIntervalSeconds": 3600,
    "self": "/alerts/4fa49a87-3463023ea7c4",
    "feed": "/o/myorg/events/4fa49a87-3463023ea7c4",
    "organization": "myorg",
    "environment": "prod",
    "notifications": [
      {
        "channel": "email",
        "destination": "me@foo.com"
      }
    ],
    "updatedAt": "2018-07-19T18:19:31.654738Z",
    "updatedBy": "me@foo.com"
  }

$ACCESS_TOKEN को अपने OAuth 2.0 ऐक्सेस टोकन पर सेट करें, जैसा कि OAuth 2.0 ऐक्सेस टोकन पाना में बताया गया है.

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

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

इस संसाधन के लिए जीईटी अनुरोध जारी करके, किसी संगठन के लिए ट्रिगर की गई सभी सूचनाओं का इतिहास देखें: 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 का इस्तेमाल करना लेख पढ़ें.

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

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