Cato API - AccountMetrics

نوصي بشدة بمراجعة سياسة الدعم لواجهة برمجة التطبيقات من Cato قبل البدء في استخدامها.

نظرة عامة على accountMetrics

يساعدك استعلام accountMetrics على تحليل حالة وجودة اتصالات المواقع ومستخدمي SDP على سحابة . هذه البيانات لحركة المرور داخل نفق DTLS بين الموقع وسحابة .

يعرض accountMetrics القياسات التاريخية والإحصائيات والتحليلات للحساب. يعيد البيانات التي تشبه نافذة اتصال الموقع في تطبيق إدارة .

لحسابات الموزعين، يمكنك إنشاء مفاتيح API منفصلة داخل كل حساب عميل تقوم بالاتصال به بـ API. لمزيد من المعلومات حول الحد من معدل الاستعلام عن API الخاص بـ accountMetrics، راجع فهم الحد من معدل API.

العمل مع دقة الدلو وحدود استعلام الواجهة البرمجية الرسمية (API)

يوجد حد أقصى يبلغ 100,000 عنصر يتم إرجاعها لكل استعلام API خاص بـ accountMetrics. إذا وصل استعلام إلى هذا الحد، فلن يُرجع الاستعلام أي بيانات إضافية وسيظهر رسالة خطأ.

يقوم بحساب هذا الحد بناءً على ضرب العناصر التالية:

• العدد الإجمالي للمواقع زائد مستخدمي VPN

• عدد القياسات (تسميات API / القياسات عن بعد)

• عدد الدلاء

بعبارة أخرى، يجب أن يكون مجموع (المواقع + مستخدمي VPN) * (القياسات) * (الدلاء) أقل من 100,000. على سبيل المثال، الاستعلام التالي سينتج خطأ:

• 10 مواقع

• 140 مستخدم VPN

• 5 قياسات

• 150 دلاء

(10 + 140) * 5 * 150 = 112,500 عنصر في الاستعلام. في هذا المثال، يمكنك تقليل عدد الدلاء لتتمكن من تشغيل الاستعلام بنجاح.

لمزيد من المعلومات حول أنواع تسميات API، راجع Cato API - AccountMetrics > Timeseries.

حساب الحد الأدنى للدقة لاستعلام

يشرح هذا القسم كيفية حساب الحد الأدنى للدقة (حجم الدلو) بناءً على الإطار الزمني للاستعلام.

1. الإطار الزمني - تحويل الإطار الزمني إلى ثوانٍ

2. حد الدلو - حساب حد الدلو بناءً على 100,000 / ((المواقع + مستخدمي VPN) * (القياسات))

3. الحد الأدنى للدقة = (الإطار الزمني) / (حد الدلو)

على سبيل المثال، يُظهر الصف الأول في الجدول أدناه حد الاستعلام للمدة 7 أيام، و100 موقع ومستخدم VPN، مع 5 قياسات:

• 7 أيام = 604,800 ثانية

• 200 دلاء = 10000 / (100) * (5)

• 3024 ثانية حد أدنى للدقة = 604800 / 200

يعرض الجدول التالي إعدادات نموذجية لاستخدام استعلام accountMetrics مع الحد الأدنى لحجم الدلو:

تفاصيل حقول accountMetrics

هذه هي التفاصيل التي يمكن أن تعيدها حقول accountMetrics للاستعلام:

• ID - معرف الحساب

• from - وقت البدء

• to - وقت الانتهاء

• الدقة - حجم الدلو

• المواقع - البيانات التي تم إرجاعها لكل موقع (مجموعة تحتوي على استعلامات وحقول متداخلة)

• السلسلة الزمنية - الإطار الزمني للبيانات، ويحدد العلاقة بين الدلاء والبيانات (مصفوفة مع استعلامات وحقول متداخلة)

معرف accountMetrics

يعرض حقل المعرف المعرف الداخلي الفريد للحساب.

هذا معرف الحساب غير معروض في تطبيق إدارة Cato، بدلاً من ذلك هو الرقم الموجود في عنوان URL لتطبيق إدارة Cato. على سبيل المثال، معرف الحساب هو 26 للرابط التالي: https://cc2.catonetworks.com/#!/26/topology.

من accountMetrics

يعرض حقل من وقت البدء لبيانات الاستعلام ويتم تعريفه في الإطار الزمني الحجة.

إلى accountMetrics

يعرض حقل إلى وقت الانتهاء لبيانات الاستعلام ويتم تعريفه في الإطار الزمني الحجة.

الدقة accountMetrics

يعرض حقل الدقة المدة الزمنية بالثواني لدلو القياسات الواحد. يُحدد عدد الدلاء في الحجة التسلسل الزمني > الدلو.

يتم حساب الدقة وفقًا للمعادلة التالية: الإطار الزمني / الدلاء. على سبيل المثال، إذا كان الاستعلام يُعيد خمس دقائق من البيانات (الإطار الزمني) مع 60 دلوًا، فإن الدقة (حجم الدلو) هي 5 ثوانٍ (300 ثانية / 60).

الحد الأدنى للدقة لدلو هو 5 ثوانٍ. عندما تكون دقة الدلو أقل من 5 ثوانٍ، فمن الممكن ألا يتم إرجاع أي بيانات لذلك الدلو.

لمزيد من المعلومات حول حقل الدقة، راجع العمل مع accountMetrics > الدقة.

مواقع accountMetrics

يحتوي حقل المواقع على بيانات تتعلق بموقع واحد أو أكثر في الحساب. يمكنك أيضًا تحديد بيانات لمستخدمي VPN باستخدام معرفات المستخدم الخاصة بهم.

لمزيد من المعلومات حول حقل المواقع لـ accountMetrics، راجع API - AccountMetrics > مواقع.

التسلسل الزمني لـ accountMetrics

يعرض القياسات للحساب وفقًا للإطار الزمني المحدد (الدلاء) في الاستعلام، ويشمل الإحصائيات التاريخية والقياسات. هذه البيانات مشابهة لحقل نافذة اتصال الموقع في تطبيق إدارة لكل موقع.

لمزيد من المعلومات حول حقل التسلسل الزمني لـ accountMetrics، راجع API - AccountMetrics > التسلسل الزمني.

حجج accountMetrics

هذه هي الحجج التي يمكنك تمريرها وتحديد البيانات التي يُرجعها الاستعلام:

• accountID - معرف الحساب

• ID - معرف الحساب (حجة قديمة)

• timeFrame - وقت البدء والانتهاء للاستعلام

• groupInterfaces - دمج التحليلات للروابط في رابط واحد (لقيمة منطقية true)

• groupDevices - لمواقع متعددة، ولموقع واحد مع مقابس متعددة، دمج التحليلات في مقبس واحد (لقيمة منطقية true)

حجة accountID لـ accountMetrics

أدخل معرف الحساب للبيانات التي يُرجعها الاستعلام. هذه الحجة إلزامية.

هذا معرف الحساب غير معروض في تطبيق إدارة Cato، بدلاً من ذلك هو الرقم الموجود في عنوان URL لتطبيق إدارة Cato. على سبيل المثال، معرف الحساب هو 26 للرابط التالي: https://cc2.catonetworks.com/#!/26/topology.

حجة الإطار الزمني لـ accountMetrics

أدخل الإطار الزمني للبيانات التي يُرجعها الاستعلام. الحجة في الشكل <type>.<time value>. هذه الحجة إلزامية.

هذه هي الخيارات المدعومة لتحديد الإطار الزمني:

• last.<time duration> - قيمة <time duration> للنوع last حسب ISO-8601 وتعيد بيانات للأوقات السابقة المحددة. على سبيل المثال:

  • timeFrame = last.PT5M تعرض الخمس الدقائق السابقة

  • timeFrame = last.PT2H تعرض الساعتين السابقتين

  • timeFrame = last.P1D تعرض اليوم السابق

  • timeFrame = last.P3M تعرض الأشهر الثلاثة السابقة

  • timeFrame = last.P1Y تعرض السنة السابقة

• utc.<short-time-frame-spec> - يجمع الإطار الزمني بين تاريخ البدء والانتهاء في الشكل YY-MM-DD/hh:mm:ss وفقًا للمنطقة الزمنية المحددة. يجب أن تدخل جميع القيم الزمنية والتاريخ للحجة. على سبيل المثال:

  • الإطار الزمني = utc.2020-02-{11/04:50:00--21/04:50:00} يعرض 10 أيام من بيانات التحليل من 11 فبراير 2020 4:50:00 صباحًا إلى 21 فبراير 2020 4:50:00 صباحًا

  • الإطار الزمني = utc.2020-02-11/{04:50:15--16:50:15} يعرض 12 ساعة من بيانات التحليل في 11 فبراير 2020، من 4:50:15 صباحًا إلى 16:50:15 مساءً

  • الإطار الزمني = utc.2020-{02-11/04:50:00--04-11/04:50:00} يعرض شهرين من بيانات التحليل من 11 فبراير 2020 4:50:00 صباحًا إلى 11 أبريل 4:50:00 صباحًا

  • الإطار الزمني = utc.{2019-10-01/04:50:00--2020-02-01/04:50:00} يعرض 4 أشهر من بيانات التحليل من 1 أكتوبر 2019 4:50:00 صباحًا إلى 11 فبراير 2020 4:50:00 صباحًا

    هذا الشكل يتيح لك تكوين إطار زمني يشمل أكثر من سنة تقويمية واحدة

لمزيد من المعلومات حول حجة الإطار الزمني وحقل الدقة، راجع العمل مع accountMetrics > الدقة.

حجة groupInterfaces لـ accountMetrics

عندما تكون الحجة المنطقية groupInterfaces مضبوطة على true، يتم تجميع البيانات لجميع الواجهات في واجهة واحدة.

حجة groupDevices لـ accountMetrics

عندما تكون الحجة المنطقية groupDevices مضبوطة على true، يتم تجميع التحليلات لجميع المقابس (عادةً اثنين في حالة التوافر العالي) كنتيجة واحدة. للحصول على أفضل النتائج للمقابس المجمعة، نوصي بأن تكون هناك أسماء ووظائف متسقة (مثل الوجهة) للروابط على كلا المقبسين.

ملاحظة:هذه الحجة إلزامية للاستعلامات للمواقع المتعددة والقيمة الوحيدة الصالحة لقيمة groupDevices هي true.