استكشاف الأخطاء وإصلاحها في مكالمات API الخاصة بـ Cato

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

لا يتم دعم المشكلات المتعلقة بنصوص API والبرمجة.

المعطيات المطلوبة لـ API

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

• استعلام accountMetrics
  • id - رقم الحساب
  • timeframe - مقياس زمني للبيانات التي يعيدها الاستعلام
  • groupDevices - بالنسبة لمواقع متعددة، والمواقع التي تحتوي على مقابس متعددة، يتم دمج التحليلات في مقبس واحد (بالنسبة للقيمة البوليانية true)
• استعلام accountSnapshot
  • id - رقم الحساب

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

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

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

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

الرسالة: اسم متوقع، تم العثور على <حرف&gt؛

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

الرسالة: اسم متوقع، تم العثور على <غير صالح&gt؛

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

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

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

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

الرسالة: نوع String متوقع!، تم العثور على <رقم&gt؛

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

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

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

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

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

رسائل خطأ API

تشرح هذه القسم رسائل الخطأ الشائعة التي ليست مرتبطة بشكل خاص بـ Cato GraphQL schema أو التنسيق.

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

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

• في تطبيق إدارة Cato ( النظام > إدارة الوصول إلى API )، تأكد من أن مفتاح API الذي تستخدمه لا يزال صالحًا. يتم حذف المفتاح عند إلغاء تنشيطه.
• تأكد من أن المفتاح مُهيَّأ بشكل صحيح في إعدادات HTTP header لبرنامج الاستعلام API: x-api-key <قيمة المفتاح>
• إذا استمر المشكلة، قم بإنشاء مفتاح API جديد وأضفه إلى برنامج الاستعلام API

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

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

خطأ عام لـ API عند تشغيل النصوص خلال نافذة الصيانة

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

لمعلومات حديثة حول النوافذ الصيانة المجدولة وحالة Cato Cloud، انظر https://status.catonetworks.com/.

خطأ عام لـ API بسبب وقت انتهاء مع خادم API

إذا كان هناك تأخير لأكثر من 40 ثانية لاستعلام API، فهناك انتهاء الوقت مع خادم API وتحتاج إلى تشغيل الاستعلام مرة أخرى. نوصي بأن تتضمن آلية إعادة المحاولة مع نص API لحسابك في Cato. يجب أن تتضمن هذه الآلية ما لا يقل عن محاولتين إعادة المحاولة والانتظار 30 ثانية على الأقل بين كل محاولة إعادة.