این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

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

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

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

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

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

دانلود لاگ‌ها برای یک سازمان و محیط خاص
فهرست پروکسی‌های مرتبط با یک سازمان و محیط

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

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

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

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

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

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

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

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"

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

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

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

نام مستعار میزبان = apis.acme.com
پورت = ۴۴۳
TLS فعال است

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

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

کجا:

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

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

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

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

شما باید نام سازمان و محیط را با استفاده از پارامترهای کوئری org و env و همچنین 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"

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