مشاهده گزارش‌ها بااستفاده از میانای برنامه‌سازی کاربردی

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

گزارش‌های «پایش میانای برنامه‌سازی کاربردی» را بارگیری کنید تا داده‌های خام استفاده‌شده برای محاسبه سنجه‌های نمایش‌داده‌شده در داشبوردهای «پایش میانای برنامه‌سازی کاربردی» را ببینید. می‌توانید گزارش‌های مربوط به محدوده‌های زمانی سفارشی، پراکسی‌های خاص، کدهای وضعیت خاص، و بسیاری متغیرهای دیگر را بارگیری کنید.

توجه: به‌طور پیش‌فرض، تماس‌ها با Logs API فقط نتایج دارای کدهای وضعیت 4xx و 5xx را برمی‌گرداند، نه کد 2xx. این کار برای محدود کردن تعداد نتایج انجام می‌شود، زیرا اکثر نتایج دارای کد وضعیت 2xx هستند. برای دریافت نتایج با کد وضعیت 2xx، status=2xx را به درخواست اضافه کنید. برای مثال: https://apimonitoring.enterprise.apigee.com/logs?status=2xx.

بخش‌های زیر نحوه مدیریت گزارش‌های ورود به سیستم بااستفاده از API را شرح می‌دهد:

برای اطلاعات بیشتر درباره میانای برنامه‌سازی کاربردی گزارش‌ها، میانای برنامه‌سازی کاربردی گزارش‌ها را ببینید.

برای کسب اطلاعات درباره گزینه‌های cURL استفاده‌شده در این مثال‌ها، استفاده از cURL را ببینید.

بارگیری گزارش‌های سازمان و محیط

بااستفاده از Logs API، گزارش‌های مربوط به سازمان و محیط خاصی را بارگیری کنید:

https://apimonitoring.enterprise.apigee.com/logs

باید نام سازمان و محیط را بااستفاده از پارامترهای پُرسمان org و env ارسال کنید.

به‌طور پیش‌فرض، «میانای برنامه‌سازی کاربردی» ۱۰ ورودی گزارش آخر را برای یک ساعت گذشته برمی‌گرداند. برای مثال:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

$ACCESS_TOKEN را روی کد دسترسی OAuth 2.0 تنظیم کنید، همان‌طور که در دریافت کد دسترسی OAuth 2.0 توضیح داده شده است.

پاسخ آرایه‌ای از ورودی‌های گزارش به‌شکل زیر است:

[   
  {
"request":"GET /v1/o/myorg/z HTTP/1.1",
    "request_length":1349,
    "request_message_id":"rrt-0623eb157b650315c-c-ne-7785-16029140-1",
    "virtual_host":"api.enterprise.apigee.com",
    "response_size":144,
    "response_time":0.551,
    "response_status":"404",
    "timestamp":"2018-08-14T17:31:07Z",
    "fault_code":"messaging.adaptors.http.flow.ErrorResponseCode",
    "fault_flow":"-",
    "fault_policy":"null/null",
    "fault_proxy":
        "/organizations/myorg/environments/prod/apiproxies/myAPI/revisions/50",
    "fault_source":"target"
  },
  …
]

از پارامترهای پُرسمان from و to برای مشخص کردن محدوده زمانی با قالب ISO استفاده کنید. قالب تاریخ می‌تواند یکی از این موارد باشد:

  • yyyy-mm-ddThh:mm:ssZ
  • yyyy-mm-ddThh:mm:ss+00:00

برای مثال:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&from=2018-08-13T14%3A04%3A00Z&to=2018-08-13T14%3A10%3A00Z" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

این API پارامترهای پُرسمان اختیاری زیادی دارد. برای مثال، برای دیدن گزارش‌های یک پراکسی به‌نام myAPI که پاسخ‌های HTTP 404 تولید می‌کند:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

برای برگرداندن بیش‌از ۱۰ ورودی گزارش، پارامتر پُرسمان limit را تنظیم کنید. می‌توانید آن را روی حداکثر مقدار ۱۰۰۰ تنظیم کنید:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404&limit=200" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

برای گزینه‌های بیشتر، میانای برنامه‌سازی کاربردی گزارش‌ها را ببینید.

فهرست کردن پراکسی‌های مرتبط با میزبان مجازی و مسیر پایه

میزبان مجازی در «روتر لبه» به شما امکان می‌دهد نام دامنه، پروتکل (مثل HTTP/HTTPS)، و شماره درگاه را مشخص کنید. برای مثال، میزبان مجازی را در «روتر لبه» با تنظیمات زیر تعریف می‌کنید:

  • نام مستعار میزبان = apis.acme.com
  • port = 443
  • «امنیت لایه انتقال» فعال است

براساس این تنظیمات، درخواست به پراکسی API مرتبط با این میزبان مجازی از این فرم استفاده می‌کند:

https://apis.acme.com/proxy-base-path/resource-path

مکان:

  • proxy-base-path هنگام ایجاد یک پراکسی API تعریف می‌شود و برای هر پراکسی API یکتا است.
  • resource-path مسیر منبعی است که ازطریق پراکسی API قابل‌دسترسی است.

برای اطلاعات بیشتر درباره میزبان‌های مجازی، به درباره میزبان‌های مجازی مراجعه کنید.

با صدور درخواست GET به منبع زیر از Logs API، فهرست کارگزاران نیابتی API منسوب به میزبان مجازی و مسیر پایه خاصی را بارگیری کنید:

https://apimonitoring.enterprise.apigee.com/logs/apiproxies

باید نام سازمان و محیط را بااستفاده از پارامترهای پُرسمان org و env و همچنین نشانی وب مرتبط با میزبان مجازی و مسیر پایه ارسال کنید.

برای مثال، فراخوانی API زیر پراکسی‌های مرتبط با میزبان مجازی http://apis.acme.com و با مسیر پایه /v1/perf را برمی‌گرداند:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs/apiproxies?org=myorg&env=prod&select=http://apis.acme.com/v1/perf" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

$ACCESS_TOKEN را روی کد دسترسی OAuth 2.0 تنظیم کنید، همان‌طور که در دریافت کد دسترسی OAuth 2.0 توضیح داده شده است.

برای گزینه‌های بیشتر، میانای برنامه‌سازی کاربردی گزارش‌ها را ببینید.