أنت تعرض مستندات Apigee Edge.
انتقل إلى
مستندات Apigee X. معلومات
المسار الأساسي لمنصة واجهة برمجة التطبيقات:
https://api.enterprise.apigee.com/v1/o/{org_name}
مسار مورد واجهة برمجة التطبيقات: /environments/{env_name}/stats/{dimension_name}
الوصف: استخدام طريقة GET لاسترداد المقاييس لأحد المكوّنات
| الفعل: | تنزيل |
| المصادقة: | المصادقة الأساسية |
| أنواع الوسائط: |
application/json
|
نظرة عامة: يتم إنشاء تقرير باستخدام طلب استرداد بيانات باستخدام GET على
/stats API.
مصحوبة بـ:
- مَعلمة معرف موارد منتظم (URI) اختيارية تحدّد سمة التقرير. تحدِّد Apigee مجموعة للأبعاد تعمل بشكل مسبق على تجميع مجموعة من المقاييس مقابل تلك الأبعاد. في حال عدم توفّر سمة محدد (أي إذا كانت معلمة URI فارغة)، فسيتم إنشاء تقرير لجميع واجهات برمجة التطبيقات موجودة في البيئة المحددة.
- يشير ذلك المصطلح إلى مجموعة من مَعلمات طلب البحث تحدّد المقاييس والنطاق الزمني والفاصل الزمني تصفية/التوغّل في جوانب التقرير.
dimension_name: معلمة معرف موارد منتظم (URI) تحدد الكيان الذي له واجهة برمجة التطبيقات
يجب استرداد مقاييس النظام الأساسي. تحدد Apigee مجموعة من الأبعاد التي يمكن استخدامها في
التقارير. تشمل السمات المتوافقة ما يلي:
/stats/apis: الخوادم الوكيلة لواجهة برمجة التطبيقات في مؤسسة على النظام الأساسي لواجهة برمجة التطبيقات/stats/apiproducts: منتجات واجهة برمجة التطبيقات التي تم تحديدها في مؤسسة/stats/apps: اسم تطبيق المطوِّر الذي يقدّم طلبًا إلى واجهة برمجة التطبيقات/stats/client_ip: عناوين IP للتطبيقات التي تطلب الوصول إلى واجهات برمجة التطبيقات على واجهة برمجة التطبيقات المنصّة/stats/developer_email: عنوان البريد الإلكتروني لمطوّر برامج مسجَّل في المؤسسة على النظام الأساسي لواجهة برمجة التطبيقات/stats/developer_app: اسم تطبيق المطوِّر الذي يقدّم طلب واجهة برمجة التطبيقات الخاصة بك/stats/devs:رقم التعريف الفريد للمطوِّر الذي أنشأه Edge والمسجّل في المؤسسة على النظام الأساسي لواجهة برمجة التطبيقات/stats/access_token: رمز دخول OAuth الخاص بالمستخدم النهائي للتطبيق
يمكن تطبيق الفلاتر على الموارد المخصصة. تتميّز الموارد المخصّصة بما يلي:
| الرمز | العملية |
|---|---|
in |
لإدراجها في القائمة |
notin |
لاستبعاد القائمة |
eq |
= |
ne |
!= أو |
gt |
> |
lt |
|
ge |
>= |
le |
| الوصف | فلترة بنية طلبات البحث |
|---|---|
| إحصاءات الخوادم الوكيلة لواجهة برمجة التطبيقات التي تحمل اسم api1 أو api2 | filter=(apiproxy in 'api1','api2') |
| إحصاءات لجميع الخوادم الوكيلة لواجهة برمجة التطبيقات باستثناء api1 وapi2 | filter=(apiproxy notin 'ap1','api2') |
| الإحصاءات التي لا تتضمّن أخطاءً | filter=(iserror eq 0) |
| الإحصاءات التي لا تظهر فيها رسائل خطأ أو حين يكون اسم الخادم الوكيل لواجهة برمجة التطبيقات api1 أو api2 | filter=(iserror eq 1) or (apiproxy in 'api1','api2') |
| إحصاءات حيث (رمز الاستجابة إما 201 أو 301) و (هناك أخطاء) أو (خادم وكيل واجهة برمجة التطبيقات) الاسم إما 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 | لا ينطبق | نعم |
| timeRange | وقت البدء والانتهاء للفاصل الزمني المطلوب. يكون تنسيق التاريخ هو MM/DD/YYYY HH:MM. على سبيل المثال، 1/1/2013%2000:00~1/2/2013%2000:00. الحدّ الأقصى للنطاق الزمني هو 6 أشهر. | لا ينطبق | نعم |
| timeUnit | ثاني، دقيقة، ساعة، يوم، أسبوع، شهر، ربع، سنة، عقد، قرن، ألفية | لا ينطبق | نعم |
| ترتيب | عند تحديد قيمتين أو أكثر من قيم التحديد، يتم إجراء "ترتيب" استخدامها لتحديد حدد "المستخدم" لفرز النتائج: message_count، وerror_count، وtotal_response_time، max_response_time وmin_response_time وdata_Exchange_size وend_point_response_time | لا ينطبق | لا |
| ترتيب | نطاقات الترتيب المدعومة هي DESC أو ASC | لا ينطبق | لا |
| توك | الحصول على "أعلى ك" من النتائج، على سبيل المثال، لعرض أهم 5 نتائج "topk=5". | لا ينطبق | لا |
| تصفية | تفعيل التوغّل في قيم سمات معيّنة | لا ينطبق | لا |
| الحدّ الأقصى المسموح به | ضبط الحدّ الأقصى لعدد الإدخالات التي تعرضها واجهة برمجة التطبيقات | لا ينطبق | لا |
| اقتطاع | يمكنك استخدام قيمة الإزاحة ذات الحدّ لتفعيل تقسيم النتائج على صفحات. على سبيل المثال، لعرض النتائج 11-20، ضبط الحد على "10" والمعادلة إلى "10". | لا ينطبق | لا |
{
"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" : {
}
}| الاسم | الوصف |
|---|---|
| البيانات الوصفية | البيانات الوصفية المرتبطة بالتقرير |
| البيئات | البيئات في المؤسسة التي يتم جمع الإحصاءات فيها (تتوافق مع حرف البدل * لجمع الإحصاءات عبر البيئات المختلفة) |
| المقاييس | القيم التي يتم عرضها للبُعد المحدّد |
| الأبعاد | السمة المحدّدة للقياس: في هذا المثال api_name. |
| المقاييس | مقاييس التقرير |