شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات
مسیر پایه پلتفرم API: https://api.enterprise.apigee.com/v1/o/{org_name}
مسیر منبع API: /environments/{env_name}/stats/{dimension_name}
توضیحات: از متد GET برای بازیابی معیارهای یک بُعد استفاده کنید.
| فعل: | دریافت کنید |
| نویسنده: | مجوز پایه |
| انواع رسانه: | برنامه/json |
مرور کلی: یک گزارش با استفاده از یک درخواست GET در منبع API
/stats ایجاد میشود، که موارد زیر را نیز به همراه دارد:- یک پارامتر 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
| نام | توضیحات | پیشفرض | الزامی است؟ |
|---|---|---|---|
| انتخاب کنید | معیاری را که باید برای گزارش تجمیع شود، تعیین میکند. معیارهای پشتیبانیشده عبارتند از تعداد پیام، تعداد خطا، زمان کل پاسخ، حداکثر زمان پاسخ، حداقل زمان پاسخ، اندازه تبادل داده، زمان پاسخ نقطه پایانی. | ناموجود | بله |
| محدوده زمانی | زمان شروع و پایان برای بازه زمانی مورد نظر. قالب تاریخ به صورت MM/DD/YYYY HH:MM است. برای مثال، 1/1/2013%2000:00~1/2/2013%2000:00. حداکثر بازه زمانی 6 ماه است. | ناموجود | بله |
| واحد زمان | ثانیه، دقیقه، ساعت، روز، هفته، ماه، ربع، سال، دهه، قرن، هزاره | ناموجود | بله |
| مرتبسازی بر اساس | وقتی دو یا چند مقدار برای انتخاب مشخص شده باشد، میتوان از 'sortby' برای تعیین انتخاب مورد استفاده برای مرتبسازی نتایج استفاده کرد: message_count، error_count، total_response_time، max_response_time، min_response_time، data_exchange_size، end_point_response_time | ناموجود | خیر |
| مرتب سازی | دامنههای مرتبسازی پشتیبانیشده عبارتند از DESC یا ASC | ناموجود | خیر |
| تاپک | برای مثال، از بین نتایج، «k نتیجه برتر» را انتخاب کنید تا ۵ نتیجه برتر «topk=5» را برگردانید. | ناموجود | خیر |
| فیلتر | امکان بررسی دقیق مقادیر ابعاد خاص را فراهم میکند. | ناموجود | خیر |
| حد | محدودیت تعداد ورودیهای برگردانده شده توسط API را تنظیم کنید | ناموجود | خیر |
| جبران | برای فعال کردن صفحهبندی نتایج، از offset به همراه limit استفاده کنید. برای مثال، برای نمایش نتایج ۱۱-۲۰، limit را روی '۱۰' و offset را روی '۱۰' تنظیم کنید. | ناموجود | خیر |
{
"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. |
| معیارها | معیارهای گزارش |