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

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

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

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

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

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

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

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

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

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

विकल्प जानकारी
-d '{}'

--data @filename

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

--header

अनुरोध हेडर तय करता है. आपको अनुरोध हेडर में यह जानकारी देनी होगी:
  • Authorization हेडर का इस्तेमाल करके, उपयोगकर्ता की पुष्टि करने के लिए OAuth 2.0 टोकन, जैसा कि 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 API को सुरक्षित कॉल करने के लिए किया जा सकता है. टोकन मिलने के बाद, टोकन की समयसीमा खत्म होने तक आपको अपने क्रेडेंशियल फिर से शेयर करने की ज़रूरत नहीं है. रीफ़्रेश टोकन की मदद से, अपने क्रेडेंशियल दिए बिना सर्वर के साथ अपने "सेशन" को लंबे समय तक चालू रखा जा सकता है. ऐक्सेस टोकन के बारे में ज़्यादा जानने के लिए, मैनेजमेंट एपीआई को ऐक्सेस करने के लिए OAuth2 का इस्तेमाल करना लेख पढ़ें.

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

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

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


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