تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

استرداد المقاييس وفلترتها لأحد السمات من خدمات Apigee Analytics

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. المعلومات

المسار الأساسي للنظام الأساسي لواجهة برمجة التطبيقات: https://api.enterprise.apigee.com/v1/o/{org_name}

مسار موارد واجهة برمجة التطبيقات: /environments/{env_name}/stats/{dimension_name}

الوصف: استخدام طريقة GET لاسترداد المقاييس لإحدى السمات

فعل:	GET
المصادقة:	المصادقة الأساسية
أنواع الوسائط:	application/json

نظرة عامة: يتم إنشاء تقرير باستخدام طلب GET على مورد واجهة برمجة التطبيقات /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'. لا تستخدِم علامات الاقتباس المزدوجة.

الوصف	فلترة بنية طلب البحث
إحصاءات الخوادم الوكيلة لواجهة برمجة التطبيقات التي تحمل اسم 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" لتحديد التحديد المستخدَم لترتيب النتائج: message_count وerror_count وtotal_response_time max_response_time, min_response_time, data_ exchange_size, end_point_response_time	لا ينطبق	لا
ترتيب	نطاقات الترتيب المتوافقة هي DESC أو ASC	لا ينطبق	لا
أعلى	استخِدم نتائج "topk" من النتائج، على سبيل المثال، لعرض أهم 5 نتائج "topk=5".	لا ينطبق	لا
filter	لتفعيل التوغّل في قيم سمات معيّنة	لا ينطبق	لا
الحدّ الأقصى المسموح به	ضبط الحدّ الأقصى لعدد الإدخالات التي تعرضها واجهة برمجة التطبيقات	لا ينطبق	لا
إزاحة	استخدِم الإزاحة مع الحد لتفعيل تقسيم النتائج على صفحات. على سبيل المثال، لعرض النتائج من 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" : {
    }
}

عناصر حمولة الاستجابة:

الاسم	الوصف
البيانات الوصفية	البيانات الوصفية المرتبطة بالتقرير
البيئات	البيئات في المؤسسة التي يتم فيها جمع الإحصاءات (تتيح استخدام حرف البدل * لجمع الإحصاءات في جميع البيئات)
metrics	القيم المعروضة للسمة المحدّدة
الأبعاد	السمة المحدّدة للقياس: في هذا المثال api_name.
metrics	مقاييس التقرير