از API Monitoring Management API استفاده کنید

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات

برای انجام وظایف زیر از API مدیریت مانیتورینگ API استفاده کنید.

وظیفه اطلاعات بیشتر
مدیریت هشدارها برای نظارت بر API
مدیریت مجموعه‌ها برای نظارت بر API
مشاهده گزارش‌های مانیتورینگ API در سطوح مختلف
مشاهده معیارهای نظارت بر API

سهمیه تماس API

همه APIهای مانیتورینگ API سهمیه‌ای را اعمال می‌کنند که تعداد دفعاتی را که می‌توانید API را در هر دقیقه فراخوانی کنید، محدود می‌کند. به عنوان مثال، API مربوط به ایجاد مجموعه‌ها ، شما را به شش فراخوانی در هر دقیقه محدود می‌کند.

همه APIها محدودیت‌های سهمیه یکسانی ندارند. برای تعیین محدودیت هر API، به مستندات مرجع API مراجعه کنید.

از حلقه استفاده کنید

مثال‌های API در این سند از curl برای نشان دادن نحوه‌ی استفاده از API Monitoring با استفاده از API استفاده می‌کنند. curl یک ابزار متن‌باز و خط فرمان برای انتقال داده‌ها با سینتکس URL است که از پروتکل‌های رایج مانند HTTP و HTTPS پشتیبانی می‌کند. برای اطلاعات بیشتر در مورد دانلود و استفاده از curl، به https://curl.haxx.se/ مراجعه کنید.

جدول زیر گزینه‌های خط فرمان curl که در مثال‌ها استفاده شده‌اند را خلاصه می‌کند.

گزینه توضیحات
-d '{ }'

--data @filename

 بدنه درخواست را تعریف می‌کند، که مستقیماً یا با مشخص کردن نام فایل ارسال می‌شود.
-H

--header

 یک هدر درخواست تعریف می‌کند. شما باید اطلاعات زیر را در هدر درخواست ارسال کنید:
  • توکن OAuth 2.0 برای احراز هویت کاربر با استفاده از هدر Authorization ، همانطور که در بخش «دریافت توکن دسترسی OAuth 2.0» توضیح داده شده است.
  • انواع محتوایی که توسط کلاینت با استفاده از سربرگ Accept پشتیبانی می‌شوند.
  • نوع محتوای بدنه درخواستی که هنگام ایجاد یا به‌روزرسانی یک منبع ( POST ، PATCH ، PUT ) با استفاده از هدر Content-Type ارسال می‌شود.
-i اطلاعات بیشتری مانند هدرها را در پاسخ نمایش می‌دهد.
-X نوع درخواست ( GET ، POST و غیره) را مشخص می‌کند.

دریافت توکن دسترسی OAuth 2.0

Apigee Edge از OAuth 2.0 برای احراز هویت کاربر پشتیبانی می‌کند. با OAuth 2.0، شما اعتبارنامه‌های Apigee Edge خود را با یک توکن دسترسی و یک توکن به‌روزرسانی (refresh token) مبادله می‌کنید که می‌توانید از آنها برای برقراری تماس‌های امن با API Apigee Edge استفاده کنید. پس از دریافت توکن، تا زمان انقضای توکن، نیازی به مبادله مجدد اعتبارنامه‌های خود ندارید. توکن به‌روزرسانی به شما امکان می‌دهد بدون ارائه اعتبارنامه‌های خود، "جلسه" خود را با سرور برای مدت طولانی‌تری فعال نگه دارید. برای اطلاعات بیشتر در مورد توکن‌های دسترسی، به استفاده از OAuth2 برای دسترسی به API مدیریت مراجعه کنید.

با استفاده از اعتبارنامه‌های Apigee Edge خود، می‌توانید دسترسی OAuth 2.0 را دریافت کنید و توکن‌ها را برای دسترسی به منابع Apigee Edge با استفاده از ابزار get_token Apigee به‌روزرسانی کنید.

برای دریافت توکن دسترسی 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، توکن دسترسی OAuth 2.0 را در هدر HTTP با استفاده از هدر Authorization ارسال کنید. برای مثال:


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