API निगरानी मैनेजमेंट एपीआई का इस्तेमाल करना

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

ये टास्क पूरे करने के लिए, एपीआई मॉनिटरिंग के मैनेजमेंट एपीआई का इस्तेमाल करें.

टास्क ज़्यादा जानकारी
एपीआई मॉनिटरिंग के लिए सूचनाएं मैनेज करना
एपीआई मॉनिटरिंग के लिए कलेक्शन मैनेज करना
एपीआई मॉनिटरिंग के लॉग अलग-अलग लेवल पर देखना
एपीआई मॉनिटरिंग के मेट्रिक देखना

एपीआई कॉल के लिए कोटा

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

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

curl का इस्तेमाल करना

इस दस्तावेज़ में दिए गए एपीआई के उदाहरणों में, एपीआई का इस्तेमाल करके एपीआई मॉनिटरिंग करने का तरीका बताने के लिए curl का इस्तेमाल किया गया है. curl, ओपन सोर्स कमांड-लाइन टूल है. इसका इस्तेमाल, यूआरएल सिंटैक्स की मदद से डेटा ट्रांसफ़र करने के लिए किया जाता है. यह एचटीटीपी और एचटीटीपीएस जैसे सामान्य प्रोटोकॉल के साथ काम करता है. curl डाउनलोड करने और इसका इस्तेमाल करने के बारे में जानकारी पाने के लिए, https://curl.haxx.se/ पर जाएं.

यहां दी गई टेबल में, उदाहरणों में इस्तेमाल किए गए curl कमांड-लाइन विकल्पों की खास जानकारी दी गई है.

विकल्प ब्यौरा
-d '{}'

--data @filename

अनुरोध के मुख्य हिस्से के बारे में बताता है. इसे सीधे तौर पर या फ़ाइल का नाम तय करके पास किया जाता है.
-H

--header

अनुरोध के हेडर के बारे में बताता है. अनुरोध के हेडर में, आपको यह जानकारी देनी होगी:
  • OAuth 2.0 टोकन का इस्तेमाल करके, उपयोगकर्ता की पुष्टि के लिए Authorization हेडर. इसके बारे में, OAuth 2.0 का ऐक्सेस टोकन हासिल करना लेख में बताया गया है.
  • Accept हेडर का इस्तेमाल करके, क्लाइंट के साथ काम करने वाले कॉन्टेंट टाइप.
  • Content-Type हेडर का इस्तेमाल करके, संसाधन (POST, PATCH, PUT) बनाते या अपडेट करते समय भेजे जा रहे अनुरोध के मुख्य हिस्से का कॉन्टेंट टाइप.
-i जवाब में ज़्यादा जानकारी दिखाता है. जैसे, हेडर.
-X अनुरोध का टाइप तय करता है. जैसे, GET, POST वगैरह.

OAuth 2.0 का ऐक्सेस टोकन हासिल करना

Apigee Edge, उपयोगकर्ता की पुष्टि के लिए OAuth 2.0 के साथ काम करता है. OAuth 2.0 की मदद से, Apigee Edge के क्रेडेंशियल को ऐक्सेस टोकन और रीफ़्रेश टोकन के लिए एक्सचेंज किया जा सकता है. इसके बाद, Apigee Edge के एपीआई को सुरक्षित तरीके से कॉल करने के लिए, इन टोकन का इस्तेमाल किया जा सकता है. टोकन हासिल करने के बाद, आपको क्रेडेंशियल को तब तक एक्सचेंज करने की ज़रूरत नहीं होती, जब तक टोकन की समयसीमा खत्म नहीं हो जाती. रीफ़्रेश टोकन की मदद से, क्रेडेंशियल दिए बिना सर्वर के साथ "सेशन" को ज़्यादा समय तक चालू रखा जा सकता है. ऐक्सेस टोकन के बारे में ज़्यादा जानकारी के लिए, OAuth2 का इस्तेमाल करके, मैनेजमेंट एपीआई को ऐक्सेस करना लेख पढ़ें.

Apigee Edge के क्रेडेंशियल का इस्तेमाल करके, Apigee के get_token यूटिलिटी का इस्तेमाल करके, Apigee Edge के संसाधनों को ऐक्सेस करने के लिए, OAuth 2.0 के ऐक्सेस और रीफ़्रेश टोकन हासिल किए जा सकते हैं.

OAuth 2.0 का ऐक्सेस टोकन हासिल करने के लिए:

  1. get_token यूटिलिटी इंस्टॉल करें. get_token यूटिलिटी इंस्टॉल करने के तरीके के बारे में जानकारी पाने के लिए, get_token का इस्तेमाल करना लेख पढ़ें.

  2. OAuth 2.0 का ऐक्सेस टोकन हासिल करने के लिए, get_token को एक्ज़ीक्यूट करें.

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

  3. OAuth 2.0 टोकन कॉपी करें और इसे किसी वैरिएबल में सेव करें. जैसे, ACCESS_TOKEN: 

    export ACCESS_TOKEN=eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI2NmQ4MTRiMC01YzZkLTQyZWUtYjlmYi05ZGVhODk5MGRiODIiLCJzdWIiOiJlZjc3YmRhMS05ZWIxLTQyZDgtODg5MC0zODQ3ODg0MzM1OWIiLCJzY29wZSI6WyJzY2ltLmVtYWlscy5yZWFkIiwicGFzc3dvcmQud3JpdGUiLCJhcHByb3ZhbHMubWUiLCJzY2ltLm1lIiwic2NpbS5pZHMucmVhZCIsIm9wZW5pZCIsIm9hdXRoLmFwcHJvdmFscyJdLCJjbGllbnRfaWQiOiJlZGdlY2xpIiwiY2lkIjoiZWRnZWNsaSIsImF6cCI6ImVkZ2VjbGkiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX2lkIjoiZWY3N2JkYTEtOWViMS00MmQ4LTg4OTAtMzg0Nzg4NDMzNTliIiwib3JpZ2luIjoidXNlcmdyaWQiLCJ1c2VyX25hbWUiOiJsbHluY2hAYXBpZ2VlLmNvbSIsImVtYWlsIjoibGx5bmNoQGFwaWdlZS5jb20iLCJyZXZfc2lnIjoiZTViZDc3NjIiLCJpYXQiOjE0NzA3NTMyMDksImV4cCI6MTQ3MDc5NjQwOSwiaXNzIjoiaHR0cHM6Ly9sb2dpbi5lMmUuYXBpZ2VlLm5ldC9vYXV0aC90b2tlbiIsInppZCI6InVhYSIsImF1ZCI6WyJzY2ltIiwicGFzc3dvcmQiLCJvcGVuaWQiLCJlZGdlY2xpIiwiYXBwcm92YWxzIiwic2NpbS5lbWFpbHMiLCJzY2ltLmlkcyIsIm9hdXRoIl19.FF3f1i9eHbBqYjnvBmt9nTtTcyNQBQRDDq2tQ3aRUAzUesLAet7qfBB9QVCvE-zVBn4BiPgRU-iturxPxRMAQ2a34-8oLvgff3x-aALBWkSwbc8PJdWTiPP9VYykoFSJtu9UIN5x0FQEQN_hyurO8D2SrS3uQKNwIyjoJPy4Bps7nb3WqJyKRfXAzf8UptdN7XE0TVqTyBcZGT3OQ2Was0VPfe_dr-wIrywvjNf6FczjdktB1lpKJ2oRXx1n8PuK5FhOQ4wE9VeSsNsMHVcGvJ5W6Tvi61fo2h1w1d4AKvGdERzuVf_XWN00mtcgwsUAuXV0r5H_i3vxcMuUym1XOg

एपीआई मॉनिटरिंग के एपीआई को कॉल करते समय, Authorization हेडर का इस्तेमाल करके, OAuth 2.0 का ऐक्सेस टोकन, एचटीटीपी हेडर में पास करें. उदाहरण के लिए:


curl -X GET "https://apimonitoring.enterprise.apigee.com/alerts?org=myorg"
   -H "Authorization: Bearer $ACCESS_TOKEN" 
   ...