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

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

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

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

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

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

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

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

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

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

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

एक्सपायर होने की सूचना पाने के लिए, इसे इस तरह सेट किया जा सकता है:

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

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

1. Edge UI में, विश्लेषण करें > सूचना के नियम पर क्लिक करें.
2. +सूचना पर क्लिक करें.
3. सूचना के बारे में यह सामान्य जानकारी डालें:

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

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

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

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

   सूचना की जानकारी	ब्यौरा
   चैनल	सूचना का चैनल चुनें जिसका आप इस्तेमाल करना चाहते हैं और डेस्टिनेशन बताएं: ईमेल, Slack, PagerDuty या Webhook.
   मंज़िल	चुने गए चैनल टाइप के हिसाब से डेस्टिनेशन तय करें: ईमेल - ईमेल पता, जैसे कि 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 के यूज़र इंटरफ़ेस (यूआई) में मौजूद Events डैशबोर्ड में अपने-आप लॉग कर देता है. इवेंट डैशबोर्ड में दिखने वाले इवेंट की सूची में, सभी सूचनाएं शामिल होती हैं. इनमें तय की गई और सर्टिफ़िकेट वाली, दोनों तरह की सूचनाएं शामिल होती हैं.

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

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

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

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

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

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

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

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

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

एक्सपायरी की सूचना बनाना या अपडेट करना

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

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

  "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 का इस्तेमाल करना लेख पढ़ें.

समयसीमा खत्म होने से जुड़ी सूचनाएं पाना

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

• 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 का इस्तेमाल करना लेख पढ़ें.