أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلىمستندات Apigee X. info
المسار الأساسي لمنصة واجهة برمجة التطبيقات:
https://api.enterprise.apigee.com/v1/o/{org_name}
مسار مورد واجهة برمجة التطبيقات: /environments/{env_name}/stats/{dimension_name}
الوصف: استخدِم طريقة GET لاسترداد مقاييس لسمة
| الفعل: | GET |
| المصادقة: | المصادقة الأساسية |
| أنواع الوسائط: |
application/json
|
/stats ، مصحوبًا بما يلي:
- مَعلمة 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 | ثانية، دقيقة، ساعة، يوم، أسبوع، شهر، ربع سنة، سنة، عقد، قرن، ألفية | لا ينطبق | نعم |
| sortby | عند تحديد قيمتَين أو أكثر في "اختيار"، يمكن استخدام "sortby" لتحديد الـ قيمة المستخدَمة لترتيب النتائج: message_count وerror_count وtotal_response_time و max_response_time وmin_response_time وdata_exchange_size وend_point_response_time | لا ينطبق | لا |
| ترتيب | نطاقات الترتيب المتوافقة هي DESC أو ASC | لا ينطبق | لا |
| topk | يمكنك أخذ "أفضل k" من النتائج، مثلاً لعرض أفضل 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 |
| المقاييس | مقاييس التقرير |