समयसीमा खत्म होने से जुड़ी चेतावनियां सेट अप करें

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

एनवायरमेंट में TLS सर्टिफ़िकेट की समयसीमा खत्म होने से पहले सूचना देने के लिए, TLS खत्म होने से जुड़ी सूचना का इस्तेमाल करें.

TLS सर्टिफ़िकेट के बारे में जानकारी

TLS (ट्रांसपोर्ट लेयर सिक्योरिटी), एक स्टैंडर्ड सुरक्षा टेक्नोलॉजी है. यह किसी वेब सर्वर और वेब क्लाइंट (जैसे, ब्राउज़र या ऐप्लिकेशन) के बीच एन्क्रिप्ट (सुरक्षित) किया गया लिंक बनाने के लिए इस्तेमाल की जाती है. एन्क्रिप्ट (सुरक्षित) किया गया लिंक यह पक्का करता है कि सर्वर और क्लाइंट के बीच से गुज़रने वाला सारा डेटा निजी बना रहे.

TLS सर्टिफ़िकेट एक डिजिटल फ़ाइल है, जो TLS लेन-देन में किसी इकाई की पहचान करती है. Edge, इन चीज़ों के लिए TLS को कॉन्फ़िगर करने के लिए TLS सर्टिफ़िकेट का इस्तेमाल करता है:

• एपीआई क्लाइंट से अपने एपीआई प्रॉक्सी का ऐक्सेस. TLS को कॉन्फ़िगर करने के लिए, वर्चुअल होस्ट का इस्तेमाल करें.
• Edge के हिसाब से बैकएंड सेवाओं का ऐक्सेस. TLS को कॉन्फ़िगर करने के लिए, Edge Message प्रोसेसर पर टारगेट एंडपॉइंट और टारगेट सर्वर का इस्तेमाल करें.

TLS सर्टिफ़िकेट में, खत्म होने की तारीख होती है. अगर किसी TLS सर्टिफ़िकेट की समयसीमा खत्म हो जाती है, तो सर्टिफ़िकेट को अपडेट करने तक, TLS कनेक्शन काम नहीं करता. इसका मतलब है कि जब तक सर्टिफ़िकेट अपडेट नहीं किया जाता, तब तक आपके एपीआई के लिए किए गए सभी अनुरोध स्वीकार नहीं किए जाएंगे.

समयसीमा खत्म होने से जुड़ी चेतावनियों के बारे में जानकारी

सर्टिफ़िकेट की समयसीमा खत्म होने का इंतज़ार करने और अपने एपीआई के अनुरोधों के फ़ेल होने के बजाय, किसी एनवायरमेंट में मौजूद किसी भी TLS सर्टिफ़िकेट की समयसीमा खत्म होने से पहले सूचना देने के लिए, समयसीमा खत्म होने से जुड़ा चेतावनी इस्तेमाल करें. सूचना ट्रिगर होने के बाद, सर्टिफ़िकेट को अपडेट किया जा सकता है, ताकि ग्राहकों को सेवा में कोई रुकावट न दिखे.

सूचना को कॉन्फ़िगर करते समय, किसी व्यक्तिगत सर्टिफ़िकेट के बारे में न बताएं, बल्कि खास एनवायरमेंट के बारे में बताएं. यह सूचना तब ट्रिगर होती है, जब डिप्लॉय किया गया कोई सर्टिफ़िकेट, तय समयसीमा में खत्म होने के लिए शेड्यूल हो.

समयसीमा खत्म होने की सूचना को सेट किया जा सकता है:

• किसी सर्टिफ़िकेट की समयसीमा खत्म होने से एक दिन पहले
• किसी सर्टिफ़िकेट की समयसीमा खत्म होने से 14 दिन पहले
• किसी सर्टिफ़िकेट की समयसीमा खत्म होने से 30 दिन पहले

सूचनाओं के बारे में ज़्यादा जानने के लिए, सूचनाएं और सूचनाएं सेट अप करना देखें.

समयसीमा खत्म होने की सूचनाएं और सूचनाएं जोड़ें

ऐक्सेस खत्म होने की सूचनाएं और सूचनाएं जोड़ने के लिए:

1. Edge यूज़र इंटरफ़ेस (यूआई) में विश्लेषण > चेतावनी के नियम पर क्लिक करें.
2. +सूचना पर क्लिक करें.
3. सूचना के बारे में नीचे दी गई सामान्य जानकारी डालें:

   फ़ील्ड	ब्यौरा
   सूचना का नाम	सूचना का नाम. एक ऐसे नाम का इस्तेमाल करें जो ट्रिगर की जानकारी देता हो और जो आपके लिए काम का हो. नाम में 128 से ज़्यादा वर्ण नहीं हो सकते.
   ब्यौरा	सूचना के बारे में जानकारी.
   सतर्क प्रकार	TLS की समयसीमा खत्म होना चुनें. ज़्यादा जानकारी के लिए, अलग-अलग तरह की चेतावनियों के बारे में जानकारी देखें.
   एनवायरमेंट	ड्रॉप-डाउन सूची से एनवायरमेंट चुनें.
   स्थिति	सूचना पाने की सुविधा को चालू या बंद करने के लिए टॉगल करें.

4. उस शर्त के लिए थ्रेशोल्ड और डाइमेंशन तय करें जिससे सूचना ट्रिगर होगी.

   शर्त वाला फ़ील्ड	ब्यौरा
   गड़बड़ियों की ज़्यादा से ज़्यादा संख्या	खत्म होने वाले सर्टिफ़िकेट के लिए समयसीमा कॉन्फ़िगर करें. सर्टिफ़िकेट की समयसीमा खत्म होने के बाद, सूचना पाने की सुविधा चालू की जा सकती है: समीक्षा में एक दिन का समय लगता है 14 दिन 30 दिन
   डाइमेंशन	डाइमेंशन को, एनवायरमेंट में किसी भी TLS सर्टिफ़िकेट से जुड़े किसी भी TLS सर्टिफ़िकेट की वैल्यू पर तय किया जाता है.

5. कोई सूचना जोड़ने के लिए, + सूचना पर क्लिक करें.

   सूचना के बारे में जानकारी	ब्यौरा
   चैनल	आपको जिस सूचना चैनल का इस्तेमाल करना है उसे चुनें और उसका डेस्टिनेशन बताएं: ईमेल, Slack, PagerDuty या वेबहुक.
   डेस्टिनेशन	चुने गए चैनल टाइप के आधार पर डेस्टिनेशन की जानकारी दें: ईमेल - ईमेल पता, जैसे कि joe@company.com Slack - Slack चैनल का यूआरएल, जैसे कि https://hooks.slack.com/services/T00000000/B00000000/XXXXX PagerDuty - PagerDuty कोड, जैसे कि abcd1234efgh56789 वेबहुक - वेबहुक यूआरएल, जैसे कि https://apigee.com/test-webhook ध्यान दें: हर सूचना के लिए सिर्फ़ एक डेस्टिनेशन तय किया जा सकता है. एक ही चैनल टाइप के लिए, एक से ज़्यादा डेस्टिनेशन तय करने के लिए, अन्य सूचनाएं जोड़ें.

6. अतिरिक्त सूचनाएं जोड़ने के लिए, पिछले चरण को दोहराएं.
7. अगर आपने कोई सूचना जोड़ी है, तो इन फ़ील्ड को सेट करें:

   फ़ील्ड	ब्यौरा
   प्लेबुक	(ज़रूरी नहीं) सूचनाओं के सक्रिय होने पर उन्हें ठीक करने के लिए, सुझाई गई कार्रवाइयों के बारे में कम शब्दों में जानकारी देने के लिए फ़्री फ़ॉर्म टेक्स्ट फ़ील्ड. आप चाहें, तो अपने संगठन के विकी पेज या कम्यूनिटी पेज का लिंक भी दिया जा सकता है. इस पेज पर सबसे सही तरीकों के बारे में बताया जाता है. इस फ़ील्ड की जानकारी को सूचना में शामिल किया जाएगा. इस फ़ील्ड में 1,500 से ज़्यादा वर्ण नहीं होने चाहिए.
   थ्रॉटल करें	सूचनाओं को भेजने की फ़्रीक्वेंसी. ड्रॉप-डाउन सूची से कोई वैल्यू चुनें.

8. सेव करें पर क्लिक करें.

इवेंट डैशबोर्ड में सूचनाएं देखें

जब Edge को किसी चेतावनी की स्थिति का पता चलता है, तो वह उस स्थिति को Edge यूज़र इंटरफ़ेस (यूआई) में इवेंट डैशबोर्ड में अपने-आप लॉग कर देता है. इवेंट डैशबोर्ड में दिखाए गए इवेंट की सूची में, तय की गई और सर्टिफ़िकेट वाली सभी सूचनाएं शामिल होती हैं.

सूचना देखने के लिए:

1. Edge यूज़र इंटरफ़ेस (यूआई) में विश्लेषण > इवेंट पर क्लिक करें. नया इवेंट डैशबोर्ड दिखाई देता है:

2. इवेंट डैशबोर्ड को इसके मुताबिक फ़िल्टर करें:

   • एनवायरमेंट
   • इलाका
   • अवधि
3. सूचना की आगे की जांच करने के लिए, इवेंट डैशबोर्ड में उस कीस्टोर को दिखाने के लिए किसी पंक्ति को चुनें जिसकी समयसीमा खत्म होने वाली है. कीस्टोर पेज से, नया सर्टिफ़िकेट अपलोड किया जा सकता है और उस सर्टिफ़िकेट को मिटाया जा सकता है जिसकी समयसीमा खत्म होने वाली है.

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

समयसीमा खत्म होने की सूचना देने और मैनेज करने के लिए इस्तेमाल किए जाने वाले ज़्यादातर एपीआई, ठीक वैसे ही होते हैं जैसे तय किए गए अलर्ट के लिए इस्तेमाल किए जाते हैं. तय की गई और समयसीमा खत्म होने से जुड़ी चेतावनियों के लिए, नीचे दिए गए सूचना एपीआई एक ही तरह से काम करते हैं:

• सूचना पाएं - गड़बड़ी की ठीक की गई या गड़बड़ी की चेतावनी की परिभाषा पाएं.
• सूचना का इतिहास पाएं - चेतावनी के इतिहास की मेट्रिक पाएं.
• सूचना मिटाना - गड़बड़ी के लिए तय की गई या ठीक की गई किसी चेतावनी को मिटाएं.
• सूचना इंस्टेंस पाएं - ट्रिगर की गई सूचना के बारे में जानकारी पाएं.
• सूचनाओं की संख्या पाएं - चेतावनियों की कुल संख्या पाएं.

हालांकि, कुछ एपीआई में ऐसी अतिरिक्त प्रॉपर्टी होती हैं जिनका इस्तेमाल गड़बड़ी की चेतावनियों के लिए किया जाता है, जैसे:

• सूचनाएं पाएं - सभी चेतावनियों की सूची बनाएं, जिनमें ठीक की गई और अनियमितता से जुड़ी चेतावनियां शामिल हैं.
• सूचना बनाएं - गड़बड़ी की समस्या वाली या गड़बड़ी की समस्या वाली चेतावनी बनाएं.
• सूचना अपडेट करें - गड़बड़ी की ठीक की गई या गड़बड़ी की सूचना की परिभाषा को अपडेट करें.

समयसीमा खत्म होने की सूचना बनाएं या अपडेट करें

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

• यह बताने के लिए कि सूचना खत्म होने की तारीख है, आपको नीचे दी गई नई प्रॉपर्टी जोड़नी होंगी:

  "alertType": "cert"
  "alertSubType": "certfixed"

  इन प्रॉपर्टी की डिफ़ॉल्ट वैल्यू ये हैं:

  "alertType": "runtime"
  "alertSubType": "fixed"

• conditions कलेक्शन में:

  • metrics प्रॉपर्टी सिर्फ़ expiration की वैल्यू लेती है.
  • सर्टिफ़िकेट के खत्म होने की समयसीमा सेकंड में बताने के लिए, gracePeriodSeconds प्रॉपर्टी का इस्तेमाल करें. यह समयसीमा ज़्यादा से ज़्यादा 30 दिन की हो सकती है.
  • threshold, durationSeconds, और comparator प्रॉपर्टी का इस्तेमाल नहीं किया जा सकता.
• conditions कलेक्शन के dimensions एलिमेंट में:
  • आपको certificate प्रॉपर्टी की वैल्यू ANY पर सेट करनी होगी.
  • आपको proxy प्रॉपर्टी की वैल्यू ALL पर सेट करनी होगी.
  • statusCode, developerApp, collection, faultCodeCategory, faultCodeSubCategory, faultCodeName प्रॉपर्टी का इस्तेमाल नहीं किया जा सकता.
• समयसीमा खत्म होने की सूचना देने के लिए, reportEnabled प्रॉपर्टी का इस्तेमाल नहीं किया जा सकता.

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

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 Cert Expiry Alert",
  "description":"My Cert Expiry Alert",
  "environment":"prod",
  "enabled":true,
  "alertType": "cert",
  "alertSubType": "certfixed",
  "conditions":[
  {
    "description":"My Cert Expiry Alert",
    "dimensions":{
      "org":"myorg",
      "env":"prod",
      "proxy":"ALL",
      "certificate": "ANY"
    },
    "metric":"expiration",
    "gracePeriodSeconds": 2592000
  }],
  "notifications":[{
    "channel":"email",
    "destination":"ops@acme.com"
  }],
  "playbook":"http://acme.com/pb.html",
  "throttleIntervalSeconds":3600,
  "reportEnabled":false
}'

$ACCESS_TOKEN को अपने OAuth 2.0 ऐक्सेस टोकन पर सेट करें, जैसा कि OAuth 2.0 ऐक्सेस टोकन पाना में बताया गया है. इस उदाहरण में इस्तेमाल किए गए cURL विकल्पों के बारे में जानकारी के लिए, cURL का इस्तेमाल करें देखें.

समयसीमा खत्म होने की सूचनाएं पाएं

डिफ़ॉल्ट रूप से, सूचनाएं पाएं एपीआई तय की गई सभी सूचनाओं के बारे में जानकारी दिखाता है. इसमें तय की गई चेतावनियां और उनकी समयसीमा खत्म हो जाती है. यह एपीआई अब क्वेरी पैरामीटर लेता है, ताकि आप नतीजों को फ़िल्टर कर सकें:

• enabled - अगर true सिर्फ़ चालू की गई चेतावनियां दिखाता है. डिफ़ॉल्ट वैल्यू false है.
• alertType - बताता है कि किस तरह की चेतावनी दिखाई जानी है. runtime, डिफ़ॉल्ट, और cert वैल्यू का इस्तेमाल किया जा सकता है.
• alertSubType - यह जवाब के लिए सूचना के सब-टाइप को तय करता है. डिफ़ॉल्ट वैल्यू सेट नहीं है. इसका मतलब है कि सूचना के सभी सब-टाइप दिखेंगे. समयसीमा खत्म होने की सूचनाएं वापस करने के लिए, certfixed तय करें.

उदाहरण के लिए, नीचे दिए गए एपीआई कॉल का इस्तेमाल करके, सिर्फ़ myorg नाम वाले संगठन के लिए सूचनाएं चालू करें:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

नीचे दिए गए कॉल की समय-सीमा खत्म होने की सूचनाएं दिखाई जाती हैं. इनमें से कोई भी सुविधा चालू है और बंद है:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=cert&alertSubType=certfixed'

$ACCESS_TOKEN को अपने OAuth 2.0 ऐक्सेस टोकन पर सेट करें, जैसा कि OAuth 2.0 ऐक्सेस टोकन पाना में बताया गया है. इस उदाहरण में इस्तेमाल किए गए cURL विकल्पों के बारे में जानकारी के लिए, cURL का इस्तेमाल करें देखें.