شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات
مسیر پایه پلتفرم API: https://api.enterprise.apigee.com/v1/o/{org_name}
مسیر منبع API: /environments/{env_name}/stats/{dimension_name}
توضیحات: از روش GET برای بازیابی معیارهای یک بعد استفاده کنید
| فعل: | دریافت کنید |
| احراز هویت: | اعتبار پایه |
| انواع رسانه: | application/json |
نمای کلی: یک گزارش با استفاده از یک درخواست GET در منبع
/stats API ایجاد می‌شود، همراه با:- یک پارامتر URI اختیاری که بعد را برای گزارش تعریف می کند. Apigee مجموعه‌ای از ابعاد را تعریف می‌کند و مجموعه‌ای از معیارها را در برابر آن ابعاد پیش‌جمع می‌کند. اگر بعد تعریف نشده باشد (یعنی اگر پارامتر URI خالی باشد)، گزارشی برای همه APIهای موجود در محیط مشخص شده تولید می شود.
- مجموعه ای از پارامترهای پرس و جو که معیارها، محدوده زمانی، فاصله زمانی و جنبه های فیلتر/تحلیل گزارش را تعریف می کند.
dimension_name : یک پارامتر URI که نهادی را که معیارهای پلتفرم API باید برای آن بازیابی شوند، تعریف می‌کند. Apigee مجموعه ای از ابعاد را تعریف می کند که می تواند در گزارش ها استفاده شود. ابعاد پشتیبانی شده عبارتند از:
-
/stats/apis: پراکسی های API در یک سازمان در پلتفرم API -
/stats/apiproducts: محصولات API تعریف شده در یک سازمان -
/stats/apps: نام برنامه توسعه دهنده ای که درخواست را به API شما ارسال می کند -
/stats/client_ip: آدرس‌های IP برنامه‌هایی که از APIها در پلتفرم API درخواست می‌کنند. -
/stats/developer_email: آدرس ایمیل یک توسعه دهنده که در یک سازمان در پلتفرم API ثبت شده است. -
/stats/developer_app: نام برنامه توسعه‌دهنده‌ای که درخواست را به API شما ارسال می‌کند -
/stats/devs: شناسه توسعه‌دهنده منحصر به فرد ایجاد شده توسط Edge که در یک سازمان در پلتفرم API ثبت شده است. -
/stats/access_token: نشانه دسترسی کاربر نهایی برنامه OAuth
فیلترها را می توان برای منابع سفارشی اعمال کرد. منابع سفارشی عبارتند از:
| نماد | عملیات |
|---|---|
in | برای درج لیست |
notin | برای حذف لیست |
eq | = |
ne | != یا |
gt | > |
lt | |
ge | >= |
le |
| توضیحات | ساختار پرس و جو را فیلتر کنید |
|---|---|
| آمار پروکسی های API با نام api1 یا api2 | filter=(apiproxy in 'api1','api2') |
| آمار برای همه پراکسی های API به جز api1 و api2 | filter=(apiproxy notin 'ap1','api2') |
| آماری که در آن هیچ خطایی وجود ندارد | filter=(iserror eq 0) |
| آماری که در آن هیچ پیام خطایی وجود ندارد یا نام پروکسی API api1 یا api2 است | filter=(iserror eq 1) or (apiproxy in 'api1','api2') |
| آماری که در آن (کد پاسخ 201 یا 301 است) و (خطاهایی وجود دارد) یا (نام پروکسی API api1 یا api2 است) | filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or (apiproxy in 'api1','api2') |
نمونه درخواست:
$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/stats/{dimension_name}?"select={metric_name}&timeRange=1/1/2013%2000:00~1/2/2013%2000:00&timeUnit=hour&sortby={metric_name}&sort=DESC&filter=(apiproxy%20in%20'weather','news')" \
-u myname:mypass
| نام | توضیحات | پیش فرض | مورد نیاز؟ |
|---|---|---|---|
| انتخاب کنید | معیاری را که باید برای گزارش جمع آوری شود مشخص می کند. معیارهای پشتیبانی شده عبارتند از message_count، error_count، total_response_time، max_response_time، min_response_time، data_exchange_size، end_point_response_time. | N/A | بله |
| محدوده زمانی | زمان شروع و پایان برای بازه مورد نظر. قالب تاریخ MM/DD/YYYY HH:MM است. به عنوان مثال، 1/1/2013%2000:00~1/2/2013%2000:00. حداکثر بازه زمانی 6 ماه است | N/A | بله |
| واحد زمان | دوم، دقیقه، ساعت، روز، هفته، ماه، ربع، سال، دهه، قرن، هزاره | N/A | بله |
| مرتب کردن | هنگامی که دو یا چند مقدار انتخابی مشخص می‌شوند، «مرتب‌سازی» می‌تواند برای تعیین انتخاب مورد استفاده برای مرتب‌سازی نتایج استفاده شود: message_count، error_count، total_response_time، max_response_time، min_response_time، data_exchange_size، end_point_response_time. | N/A | خیر |
| مرتب کردن | دامنه های مرتب سازی پشتیبانی شده DESC یا ASC هستند | N/A | خیر |
| topk | برای مثال، برای برگرداندن 5 نتیجه برتر، "topk=5" نتایج "topk" را از نتایج بگیرید. | N/A | خیر |
| فیلتر | بررسی مقادیر ابعاد خاص را فعال می کند | N/A | خیر |
| محدود کردن | محدودیتی را برای تعداد ورودی های برگردانده شده توسط API تنظیم کنید | N/A | خیر |
| جبران | از افست با محدودیت برای فعال کردن صفحه بندی نتایج استفاده کنید. به عنوان مثال، برای نمایش نتایج 11-20، حد را روی '10' و offset را روی '10' تنظیم کنید. | N/A | خیر |
{
"environments" : [ {
"dimensions" : [ {
"metrics" : [
{
"name" : "message_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "1.0"
} ]
} ,
{
"name" : "error_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "0.0"
} ]
}
],
"name" : "api1"
},
{
"metrics" : [
{
"name" : "message_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "1.0"
} ]
},
{
"name" : "error_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "0.0"
} ]
}
],
"name" : "api2"
}
],
"name" : "test"
}
],
"metaData" : {
}
}
عناصر بار پاسخگویی: | نام | توضیحات |
|---|---|
| فراداده | فراداده مرتبط با گزارش |
| محیط ها | محیط‌های موجود در سازمانی که آمار در آن جمع‌آوری می‌شود (پشتیبانی از wildcard * برای جمع‌آوری آمار متقابل محیطی) |
| معیارها | مقادیر برای بعد مشخص شده برگردانده شده است |
| ابعاد | بعد تعریف شده برای اندازه گیری: در این مثال api_name. |
| معیارها | معیارهای گزارش |