आपको Apigee Edge दस्तावेज़ दिख रहा है.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है
इस पेज पर जाएं
Apigee X दस्तावेज़. जानकारी
सूचना भेजने के लिए, TLS की समयसीमा खत्म होने की सूचना का इस्तेमाल करें किसी एनवायरमेंट में TLS सर्टिफ़िकेट की समयसीमा खत्म होने वाली होने पर सूचना.
TLS सर्टिफ़िकेट के बारे में जानकारी
TLS (ट्रांसपोर्ट लेयर सिक्योरिटी) एक स्टैंडर्ड सुरक्षा टेक्नोलॉजी है एक वेब सर्वर और एक वेब क्लाइंट के बीच एक एन्क्रिप्ट किया गया लिंक बनाने के लिए है. एन्क्रिप्ट (सुरक्षित) किया गया लिंक यह पक्का करता है कि सर्वर और क्लाइंट के बीच आने-जाने वाला सारा डेटा बना रहे निजी.
TLS सर्टिफ़िकेट एक डिजिटल फ़ाइल है, जो TLS ट्रांज़ैक्शन में किसी इकाई की पहचान करती है. Edge, TLS का इस्तेमाल करता है सर्टिफ़िकेट देने के लिए TLS को कॉन्फ़िगर करना होगा:
- एपीआई क्लाइंट से अपने एपीआई प्रॉक्सी को ऐक्सेस करना. वर्चुअल होस्ट का इस्तेमाल करें TLS को कॉन्फ़िगर करने के लिए.
- Edge से अपनी बैकएंड सेवाओं को ऐक्सेस करें. टारगेट एंडपॉइंट और टारगेट सर्वर का इस्तेमाल करना पर क्लिक करें.
TLS प्रमाणपत्र में एक समाप्ति तारीख होता है. अगर TLS सर्टिफ़िकेट की समयसीमा खत्म हो जाती है, तो TLS कनेक्शन काम नहीं करता जब तक कि आप सर्टिफ़िकेट को अपडेट न कर लें. इसका मतलब है कि जब तक सर्टिफ़िकेट को अपडेट नहीं किया जाता, तब तक आपके एपीआई को किए गए सभी अनुरोध स्वीकार नहीं किए जाएंगे.
समयसीमा खत्म होने से जुड़ी चेतावनियों के बारे में जानकारी
सर्टिफ़िकेट की समयसीमा खत्म होने का इंतज़ार करने और अपने एपीआई को किए गए अनुरोधों के पूरा न हो पाने के लिए, बढ़ाने के लिए, समयसीमा खत्म होने की सूचना किसी एनवायरमेंट में मौजूद TLS सर्टिफ़िकेट की समयसीमा खत्म होने वाली होने पर सूचना. सूचना ट्रिगर होने के बाद, सर्टिफ़िकेट को अपडेट किया जा सकता है, ताकि आपके ग्राहक सेवा में कोई रुकावट नहीं दिखेगी.
सूचना को कॉन्फ़िगर करते समय, अलग से कोई सर्टिफ़िकेट न दें, बल्कि एक खास एनवायरमेंट को चुनें. यह सूचना तब ट्रिगर होती है, जब किसी सर्टिफ़िकेट को डिप्लॉय किया जाता है तय समयसीमा में खत्म हो जाता है.
समयसीमा खत्म होने की चेतावनी को इस तरह सेट किया जा सकता है:
- किसी भी सर्टिफ़िकेट की समयसीमा खत्म होने से एक दिन पहले
- किसी भी सर्टिफ़िकेट की समयसीमा खत्म होने से 14 दिन पहले
- किसी भी सर्टिफ़िकेट की समयसीमा खत्म होने से 30 दिन पहले
समयसीमा खत्म होने से जुड़ी सूचनाएं और सूचनाएं जोड़ें
समयसीमा खत्म होने से जुड़ी सूचनाएं और सूचनाएं जोड़ने के लिए:- विश्लेषण करें > पर क्लिक करें Edge के यूज़र इंटरफ़ेस (यूआई) में सूचना के नियम.
- +सूचना पर क्लिक करें.
- अलर्ट के बारे में, यहां दी गई सामान्य जानकारी डालें:
फ़ील्ड ब्यौरा सूचना का नाम सूचना का नाम. ऐसे नाम का इस्तेमाल करें जिससे ट्रिगर के बारे में जानकारी मिले और जो आपके लिए काम का हो. नाम में 128 से ज़्यादा वर्ण नहीं हो सकते. ब्यौरा सूचना के बारे में जानकारी. अलर्ट प्रकार टीएलएस की समयसीमा चुनें. यहां जाएं: ज़्यादा जानने के लिए, अलग-अलग तरह की सूचनाओं के बारे में जानकारी. परिवेश ड्रॉप-डाउन सूची से एनवायरमेंट चुनें. स्थिति सूचना पाने की सुविधा को चालू या बंद करने के लिए टॉगल करें. - उस शर्त के लिए थ्रेशोल्ड और डाइमेंशन तय करें जो सूचना को ट्रिगर करेगी.
शर्त वाला फ़ील्ड ब्यौरा गड़बड़ियों की ज़्यादा से ज़्यादा संख्या जिन सर्टिफ़िकेट की समयसीमा खत्म होने वाली है उनके लिए समयसीमा कॉन्फ़िगर करें. आपके पास तब सूचना देने का विकल्प होता है, जब कोई सर्टिफ़िकेट खत्म होने वाला होता है:
- 1 दिन
- 14 दिन
- 30 दिन
डाइमेंशन डाइमेंशन को इससे जुड़े किसी भी TLS सर्टिफ़िकेट की वैल्यू पर तय किया जाता है वातावरण में किसी भी TLS प्रमाणपत्र को शामिल करना ज़रूरी है. - चेतावनी की सूचना जोड़ने के लिए, + सूचना पर क्लिक करें.
सूचना की जानकारी ब्यौरा चैनल सूचना वाले उस चैनल को चुनें जिसका आपको इस्तेमाल करना है और डेस्टिनेशन बताएं: Email, Slack, PagerDuty या Webहुक. मंज़िल चुने गए चैनल टाइप के आधार पर डेस्टिनेशन तय करें: - ईमेल - ईमेल पता, जैसे कि
joe@company.com
- Slack - Slack चैनल का यूआरएल, जैसे कि
https://hooks.slack.com/services/T00000000/B00000000/XXXXX
- PagerDuty - PagerDuty कोड, जैसे कि
abcd1234efgh56789
- वेबहुक - वेबहुक यूआरएल, जैसे कि
https://apigee.com/test-webhook
ध्यान दें: हर सूचना के लिए सिर्फ़ एक डेस्टिनेशन तय किया जा सकता है. एक से ज़्यादा डेस्टिनेशन तय करने के लिए का इस्तेमाल करने के लिए, अतिरिक्त सूचनाएं जोड़ें.
- ईमेल - ईमेल पता, जैसे कि
- अतिरिक्त सूचनाएं जोड़ने के लिए, पिछला चरण दोहराएं.
- अगर आपने कोई सूचना जोड़ी है, तो इन फ़ील्ड को सेट करें:
फ़ील्ड ब्यौरा प्लेबुक (ज़रूरी नहीं) समस्या को हल करने के लिए सुझाई गई कार्रवाइयों के बारे में, कम शब्दों में जानकारी देने के लिए फ़्री फ़ॉर्म टेक्स्ट फ़ील्ड उनके फ़ायर होने पर चेतावनी दी जाएगी. आप अपने आंतरिक विकी या समुदाय पेज पर भी एक लिंक जिनमें सबसे सही तरीके बताए गए हों. इस फ़ील्ड की जानकारी सूचना में शामिल की जाएगी. इस फ़ील्ड में 1500 से ज़्यादा वर्ण नहीं हो सकते. थ्रॉटल करें सूचनाएं भेजने की फ़्रीक्वेंसी. ड्रॉप-डाउन सूची से कोई वैल्यू चुनें. - सेव करें पर क्लिक करें.
इवेंट डैशबोर्ड में सूचनाएं देखें
जब Edge किसी अलर्ट स्थिति का पता लगाता है, तो यह उस शर्त को अपने-आप Edge यूज़र इंटरफ़ेस (यूआई) में इवेंट डैशबोर्ड. इवेंट डैशबोर्ड में दिखने वाले इवेंट की सूची इसमें फ़िक्स्ड और सर्टिफ़िकेट, दोनों तरह की सभी सूचनाएं शामिल होती हैं.
सूचना देखने के लिए:
विश्लेषण करें > पर क्लिक करें Edge यूज़र इंटरफ़ेस (यूआई) में इवेंट. नया इवेंट डैशबोर्ड दिखेगा:
इवेंट डैशबोर्ड को इसके अनुसार फ़िल्टर करें:
- परिवेश
- क्षेत्र
- समयावधि
- कीस्टोर को दिखाने के लिए, इवेंट डैशबोर्ड में एक पंक्ति चुनें. इसमें वह सर्टिफ़िकेट मौजूद है जिसकी समयसीमा खत्म होने वाली है चेतावनी की आगे जांच करें. कीस्टोर पेज से, नया सर्टिफ़िकेट अपलोड किया जा सकता है और सर्टिफ़िकेट की समयसीमा खत्म होने वाली है.
समयसीमा खत्म होने की चेतावनियां देने वाले एपीआई इस्तेमाल करें
समयसीमा खत्म होने की सूचनाएं बनाने और उन्हें मैनेज करने के लिए इस्तेमाल किए जाने वाले ज़्यादातर एपीआई, आपके इस्तेमाल किए जा रहे एपीआई से मेल खाते हैं तय अलर्ट के साथ. नीचे दी गई सूचना एपीआई, ठीक की गई और समयसीमा खत्म होने की सूचना, दोनों के लिए एक ही तरह से काम करती हैं:
- चेतावनी पाएं - गड़बड़ी या ठीक की गई गड़बड़ी की चेतावनी पाएं.
- सूचनाओं का इतिहास पाएं - चेतावनियों के इतिहास की मेट्रिक पाएं.
- किसी सूचना को मिटाना - किसी गड़बड़ी या ठीक की गई चेतावनी की परिभाषा को मिटाएं.
- चेतावनी वाले इंस्टेंस पाएं - ट्रिगर हुई सूचना के बारे में जानकारी पाएं.
- सूचनाओं की संख्या पाएं - सूचनाओं की कुल संख्या पाएं.
हालांकि, कुछ एपीआई में गड़बड़ी की चेतावनियों के बारे में जानकारी देने के लिए, इस्तेमाल की जाने वाली अतिरिक्त प्रॉपर्टी होती हैं. इनमें ये शामिल हैं:
- चेतावनियां पाएं - गड़बड़ी वाली और ठीक की गई सूचनाओं के साथ-साथ सभी चेतावनियों की सूची बनाएं.
- सूचना बनाएं - ठीक की गई या अनियमितता की सूचना बनाएं.
- सूचना अपडेट करें - ठीक की गई या गड़बड़ी की सूचना की परिभाषा अपडेट करें.
समयसीमा खत्म होने की सूचना जनरेट करना या उसे अपडेट करना
बनाने के लिए उन्हीं एपीआई का इस्तेमाल करें या अपडेट करें समयसीमा खत्म होने की सूचना, जैसा कि आप किसी तय सूचना के लिए करते हैं. बनाने या अपडेट करने के लिए एपीआई कॉल का मुख्य हिस्सा समयसीमा खत्म होने की सूचना, किसी ठीक की गई सूचना के लिए इस्तेमाल की जाने वाली सूचना के जैसी ही होती है. इसमें ये बदलाव होते हैं:
यह बताने के लिए कि सूचना, समयसीमा खत्म होने की सूचना है, आपको नीचे दी गई नई प्रॉपर्टी जोड़नी होंगी:
"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 का इस्तेमाल करना लेख पढ़ें.