مشاهده گزارش ها با استفاده از API

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

گزارش‌های API Monitoring را دانلود کنید تا داده‌های خام مورد استفاده برای محاسبه معیارهای نمایش داده شده در داشبوردهای API Monitoring را مشاهده کنید. می‌توانید گزارش‌ها را برای بازه‌های زمانی سفارشی، پراکسی‌های خاص، کدهای وضعیت خاص و بسیاری از متغیرهای دیگر دانلود کنید.

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

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

برای اطلاعات بیشتر در مورد logs API به Logs API مراجعه کنید.

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

لاگ های یک سازمان و محیط را دانلود کنید

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

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

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

به طور پیش فرض، API آخرین 10 ورودی گزارش را برای یک ساعت قبل برمی گرداند. به عنوان مثال:

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

همانطور که در دریافت نشانه دسترسی OAuth 2.0 توضیح داده شده است، $ACCESS_TOKEN را روی نشانه دسترسی 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-dd T hh:mm:ss Z
  • yyyy-mm-dd T hh: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"

برای برگرداندن بیش از 10 ورودی گزارش، پارامتر limit query را تنظیم کنید. می توانید آن را روی حداکثر مقدار 1000 تنظیم کنید:

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"

برای گزینه‌های بیشتر، Logs API را ببینید.

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

یک میزبان مجازی در یک روتر Edge به شما امکان می دهد نام دامنه، پروتکلی مانند HTTP/HTTPS و شماره پورت را مشخص کنید. به عنوان مثال، شما یک هاست مجازی را روی یک روتر Edge با تنظیمات زیر تعریف می کنید:

  • نام مستعار میزبان = apis.acme.com
  • پورت = 443
  • TLS فعال شد

بر اساس این تنظیمات، یک درخواست به یک پراکسی 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 query و همچنین URI مرتبط با میزبان مجازی و مسیر پایه ارسال کنید.

برای مثال، فراخوانی 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"

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

برای گزینه‌های بیشتر، Logs API را ببینید.

،

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

گزارش‌های API Monitoring را دانلود کنید تا داده‌های خام مورد استفاده برای محاسبه معیارهای نمایش داده شده در داشبوردهای API Monitoring را مشاهده کنید. می‌توانید گزارش‌ها را برای بازه‌های زمانی سفارشی، پراکسی‌های خاص، کدهای وضعیت خاص و بسیاری از متغیرهای دیگر دانلود کنید.

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

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

برای اطلاعات بیشتر در مورد logs API به Logs API مراجعه کنید.

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

لاگ های یک سازمان و محیط را دانلود کنید

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

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

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

به طور پیش فرض، API آخرین 10 ورودی گزارش را برای یک ساعت قبل برمی گرداند. به عنوان مثال:

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

همانطور که در دریافت نشانه دسترسی OAuth 2.0 توضیح داده شده است، $ACCESS_TOKEN روی نشانه دسترسی 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-dd T hh:mm:ss Z
  • yyyy-mm-dd T hh: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"

برای برگرداندن بیش از 10 ورودی گزارش، پارامتر limit query را تنظیم کنید. می توانید آن را روی حداکثر مقدار 1000 تنظیم کنید:

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"

برای گزینه‌های بیشتر، Logs API را ببینید.

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

یک میزبان مجازی در یک روتر Edge به شما امکان می دهد نام دامنه، پروتکلی مانند HTTP/HTTPS و شماره پورت را مشخص کنید. به عنوان مثال، شما یک هاست مجازی را روی یک روتر Edge با تنظیمات زیر تعریف می کنید:

  • نام مستعار میزبان = apis.acme.com
  • پورت = 443
  • TLS فعال شد

بر اساس این تنظیمات، یک درخواست به یک پراکسی 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 query و همچنین URI مرتبط با میزبان مجازی و مسیر پایه ارسال کنید.

برای مثال، فراخوانی 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"

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

برای گزینه‌های بیشتر، Logs API را ببینید.