استفاده از API Monitoring Management API

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

برای انجام دادن تکالیف زیر، از میانای برنامه‌سازی کاربردی مدیریت «پایش میانای برنامه‌سازی کاربردی» استفاده کنید.

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

سهمیه‌های فراخوانی میانای برنامه‌سازی کاربردی

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

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

استفاده از curl

مثال‌های API در این سند از curl برای نشان دادن نحوه استفاده از «پایش API» بااستفاده از API استفاده می‌کنند. curl یک ابزار خط فرمان منبع باز برای انتقال داده‌ها با دستورگان نشانی وب است که از پروتکل‌های رایج مانند 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 خود را با یک کد دسترسی و یک کد بازآوری مبادله می‌کنید که می‌توانید از آن‌ها برای برقراری تماس‌های ایمن با Apigee Edge API استفاده کنید. پس‌از دریافت یک کد، تا زمانی که کد منقضی نشده است، نیازی به مبادله مجدد اطلاعات اعتباری خود ندارید. رمز بازآوری به شما امکان می‌دهد «جلسه» خود با سرور را برای مدت طولانی‌تری بدون ارائه اعتبارنامه‌هایتان فعال نگه دارید. برای اطلاعات بیشتر درباره کدهای دسترسی، استفاده از OAuth2 برای دسترسی به «میانای برنامه‌سازی کاربردی مدیریت» را ببینید.

بااستفاده از اطلاعات اعتباری Apigee Edge، می‌توانید برای دسترسی به منابع Apigee Edge بااستفاده از ابزار get_token متعلق به Apigee، به 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

وقتی «میانای برنامه‌سازی کاربردی پایش API» را فراخوانی می‌کنید، کد دسترسی OAuth 2.0 را در سرایند HTTP بااستفاده از سرایند Authorization ارسال کنید. برای مثال:


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