Cato API - AuditFeed

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

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

تساعدك استعلامات auditFeed في تحليل الإجراءات التي اتخذها المسؤولون في تطبيق Cato Management. تشبه البيانات التي يعيدها هذا الاستعلام النافذة System> Audit Trail في تطبيق إدارة Cato.

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

فهم البيانات المسترجعة

تم تصميم مكالمة auditFeed API لدعم سحب أكثر من 2 مليون عنصر من بيانات التدقيق في الساعة. للمساعدة في تقسيط البيانات المسترجعة، عندما يكون هناك أكثر من 1000 عنصر تدقيق خلال مدة الإطار الزمني، فإن الاستعلام يكرر الجلب حتى يعيد كل بيانات التدقيق.

هذه الحقول متعلقة بتقسيط بيانات التدقيق: marker ،fetchedCount ،وhasMore. انظر أدناه لشرح هذه الحقول.

تفاصيل الحقول الخاصة بـ auditFeed

هذه هي التفاصيل التي يمكن للحقول auditFeed أن تعرضها للاستعلام:

• from - وقت البدء

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

• المؤشر - حقل المؤشر هو معرف فريد لآخر عنصر من بيانات التدقيق الذي أعاده استعلام API 

• fetchedCount - عدد العناصر المسترجعة (بحد أقصى 1000 عنصر لكل جلب)

• hasMore - عندما يكون صوابًا، يشير إلى أن هناك المزيد من العناصر للاستعلام لجلبها

• accounts (auditFeedAccountRecords) - بالنسبة للموزعين الذين يديرون حسابات متعددة، يحدد هذا الحقل الحساب الذي تم تغييره ويتضمن جميع السجلات وبيانات التدقيق (مصفوفة مع استعلامات وحقول متداخلة)

auditFeed From

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

auditFeed To

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

auditFeed Marker

عندما يكون هناك أكثر من 1000 عنصر من بيانات التدقيق خلال مدة الاستعلام، يعرض حقل Marker معرفًا يشير إلى بدء تكرار جديد لجلب العناصر. على سبيل المثال، إذا أعاد الاستعلام 2500 عنصر، فإن هذه هي النتائج عبر تكرارات الجلب:

• التكرار الأول - fetchedCount = 1000 (عناصر)، marker = 1234abc، hasMore = true

• التكرار الثاني - fetchedCount = 1000 (عناصر)، marker = 4567def، hasMore = true

• التكرار الثالث - fetchedCount = 500 (عناصر)، marker = 8901xyz، hasMore = false

  يمكنك تجاهل قيمة المؤشر في التكرار النهائي

auditFeed fetchedCount

يظهر حقل fetchedCount العدد الإجمالي للعناصر في عملية الجلب الحالية. القيمة القصوى لهذا الحقل هي 1000.

auditFeed hasMore

عندما تكون قيمة حقل hasMore صوابًا، فهذا يعني أن هناك تكرارًا آخر لجلب العناصر بعد هذا.

auditFeed Accounts

تظهر حقول Accounts (auditFeedAccountRecords) معرفات المسؤول وبيانات التدقيق لهذا الاستعلام. استخدم الوسيطة auditFeedAccountsRecords > AuditRecord > AuditFieldName لتصفية بيانات الحدث المعروضة للاستعلام. لمزيد من المعلومات حول حقول AuditRecords، انظر أدناه auditFeed > fieldName > AuditFieldName.

الحجج الخاصة بـ auditFeed

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

• accountIDs - معرفات الحساب (لعدة حسابات، أدخل المعرفات كمصفوفة)

• ids - معرف الحساب (وسيط قديم)

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

• filters (AuditFieldFilterInput) - تصفية بيانات سجل التدقيق التي تم استعلامها (مصفوفة مع استعلامات متداخلة)

• marker - إظهار العناصر فقط لتكرار جلب معين وفقًا لقيمة المؤشر

auditFeed accountIDs Argument

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

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

auditFeed timeFrame Argument

أدخل الإطار الزمني للبيانات التي يعيدها الاستعلام. الحجة موجودة بتنسيق <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 تعرض السنة السابقة

• <timezone>.<short-time-frame-spec> - الإطار الزمني يجمع بين تاريخ البدء والانتهاء بتنسيق YY-MM-DD/hh:mm:ss وفقًا للمنطقة الزمنية المحددة. على سبيل المثال، timeFrame = utc.2020-02-{11/04:50:00--21/04:50:00} تعرض بيانات التحليل من 11 فبراير 2020 الساعة 4:50:00 صباحًا حتى 21 فبراير 2020 الساعة 4:50:00 صباحًا.

auditFeed filters Argument

يتيح لك حجة filters (AuditFieldFilterInput) تحديد العنصر المحدد الذي يتم تضمينه في استعلام أثر التدقيق. هذه هي الحجج التي يمكنك تحديدها:

• fieldName > AuditFieldName - حدد العناصر من مسار التدقيق

• operator - تحديد كيفية تنشيط القيم لتصفية بيانات التدقيق

• القيم - حدد قيمة المرشح التي تستخدم مع المشغل

auditFeed > fieldName > AuditFieldName

هذه هي أسماء الحقول لأنواع إعدادات تطبيق إدارة Cato المختلفة التي تتم مراقبتها في System > Audit Trail.

• admin - المسؤول الذي أنشأ الإجراء سجل

• model_name - اسم الكائن الذي تأثر، على سبيل المثال My Site

• admin_id - المعرّف للمسؤول الذي أنشأ الإجراء سجل

• module - وحدة النظام التي تم تغييرها، على سبيل المثال إعدادات MFA أو فحص TLS

• insertion_date - الوقت الذي تم فيه إجراء التغيير أو الحفظ

• change_type - يصف التغيير الذي قام به المسؤول، القيم هي: CREATED, DELETED, MODIFIED, ENABLED, DISABLED, SKIPPED

• creation_date - الوقت الذي بدأ فيه التغيير

• change - وصف مفصل للتغيير بتنسيق JSON

• model_type - نوع الكائن الذي تم تغييره، على سبيل المثال Site, Socket, SocketInterface

auditFeed marker Argument

تتيح لك حجة المؤشر حصر الاستعلام على الأحداث لتكرار جلب معين. لعرض قيم المؤشر، شغّل الاستعلام مع حجة المؤشر بقيمة فارغة. يعيد الاستعلام قيم المؤشر للعلوم الوقتية المحددة في حجة timeFrame.

على سبيل المثال، إذا أعاد الاستعلام 2500 حدث، فإن هذه هي النتائج عبر أول ثلاث تكرارات للجلب:

• التكرار الأول - fetchedCount = 1000 (الأحداث)، marker = 1234abc، hasMore = true

• التكرار الثاني - fetchedCount = 1000 (الأحداث)، marker = 4567def، hasMore = true

• التكرار الثالث - fetchedCount = 1000 (الأحداث)، marker = 8901xyz، hasMore = true

لعرض الأحداث فقط في التكرار الثاني، قم بتعيين حجة المؤشر إلى 4567def.