استكشاف أخطاء استدعاءات Cato API وإصلاحها

يوفر هذا المقال اقتراحات استكشاف الأخطاء وإصلاحها للأخطاء الشائعة التي يمكن أن تحدث عند استخدام Cato لتشغيل استعلام API باستخدام أدوات وبرامج API. على سبيل المثال، Altair و Postman.

المشاكل المتعلقة بأكواد و سكربتات API ليست مدعومة.

الأرجومنتات المطلوبة في API

هذه هي الأرجومنتات التي يجب عليك تضمينها في استعلام API. عند إزالة أرجومنت اختياري من استعلام API، يتم استخدام القيمة الافتراضية.

• استعلام accountMetrics

  • id - معرّف الحساب

  • timeframe - إطار زمني للبيانات التي يعيدها الاستعلام

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

• استعلام accountSnapshot

  • id - معرّف الحساب

الأخطاء الشائعة GRAPHQL_PARSE_FAILED

توضح هذه القسم بعض الأمثلة الشائعة لرسائل الأخطاء المتعلقة بمخطط Cato GraphQL.

رسالة: ) غير متوقعة

هناك قوس زائد في الاستعلام. غالبًا ما يحدث هذا الخطأ عندما لا تقدم قيمة منطقية لأحد الأرجومنتات. على سبيل المثال، groupInterfaces: , بدلاً من groupInterfaces: true,

رسالة: الاسم المتوقع، الرموز غير متوقعة <character>

ملف JSON غير منسق بشكل صحيح. تظهر الرسالة رمزًا يرتبط بالحرف الناقص أو الزائد. على سبيل المثال، الاسم المتوقع، وجد ( للأرجومنت accountSnapshot((id: 42). التنسيق الصحيح لهذا الأرجومنت هو accountSnapshot(id: 1941)

رسالة: الاسم المتوقّع، العثور على <غير صالح>

تشير رسالة الخطأ إلى وجود قيمة غير صالحة.

على سبيل المثال، الأرجومنت timeFrame (في accountMetrics) في Cato API يستخدم علامات الاقتباس للمعيار ISO 8601 لتنسيق التاريخ والوقت، timeFrame: "last.P1D" هو صحيح و timeFrame: last.P1D ينتج هذا الخطأ.

الأخطاء الشائعة GRAPH_QL_VALIDATION_FAILED

توضح هذه القسم بعض الأمثلة الشائعة لرسائل الأخطاء المتعلقة بالتنسيق غير الصحيح للأرجومنتات في الاستعلام.

رسالة: النوع المتوقع String!، الموجود <رقم>

تشير رسالة الخطأ إلى أن الأرجومنت يمتلك قيمة غير صالحة، عادة ما تكون مرتبطة بتنسيق الأرجومنت.

على سبيل المثال، الأرجومنت معرّفات المواقع (في accountMetrics > المواقع) هو STRING، لذلك يجب استخدام علامات الاقتباس للقيمة، معرّفات: ["4242"] صحيح ومعرّفات:[4242] ينتج هذا الخطأ.

رسالة: النوع المتوقع Int!، المعثور "<رقم>"

تشير رسالة الخطأ إلى أن الأرجومنت يمتلك قيمة غير صالحة، عادة ما تكون مرتبطة بتنسيق الأرجومنت.

على سبيل المثال، الأرجومنت معرّفات المواقع (في accountSnapshot > المواقع) هو INT، لذلك يجب عدم استخدام علامات الاقتباس للقيمة، معرّفات: [2626] هو صحيح و معرّفات:["2626"] ينتج هذا الخطأ.

رسائل أخطاء API

توضح هذه القسم رسائل الأخطاء الشائعة التي لا ترتبط تحديدًا بمخطط أو تنسيق Cato GraphQL.

رسالة: خطأ في المصادقة أو 403

هناك مشكلة في مفتاح API لحسابك. الحلول المقترحة:

• في تطبيق إدارة Cato (النظام > إدارة الوصول إلى API)، تأكد من أن:

  • مفتاح API الذي تستخدمه لا يزال صالحًا (موجود ولم ينتهِ صلاحيته)

  • إذا تم تعيين خيار السماح بالوصول من عناوين IP، يتم إجراء المكالمة من IP محدد أو نطاق مسموح به

• تأكد من أن المفتاح مُهيّأ بشكل صحيح في إعدادات عنوان HTTP لبرامج استعلام API: x-api-key: <قيمة المفتاح>، على سبيل المثال،x-api-key: abcdef12345

• إذا استمرت المشكلة، قم بإنشاء مفتاح API جديد وأضفه إلى برنامج استعلام API

هذا مثال على عنوان HTTP صالح للعميل API:

POST /api/v1/graphql2 HTTP/2
Host: api.catonetworks.com
User-Agent: curl/8.7.1
Accept: */*
Content-Type:application/json
x-api-key: abcdef123456789

رسالة: لا يمكن فصل الأجهزة (groupDevices = false) عند تحديد مواقع متعددة

يجب أن تكون قيمة الأرجومنت groupDevices (accountMetrics) true عندما يتضمن الاستعلام مواقع متعددة.

تحويل بيانات تحليلات API

يرجع API Cato بيانات المرور بالبايتات. لتحويل البيانات إلى وحدات أكبر (مثل MB أو GB)، يجب القسمة على القيم الأسية لـ 1024: 1024² بالنسبة لـ MB و 1024³ بالنسبة لـ GB.

على سبيل المثال، لتحويل 536,870,912,000 بايت إلى GB، قسم على 1024³ لإظهار 500GB من البيانات.