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

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

يعمل استعلام entityLookup مع كيانات تطبيق إدارة Cato مثل المواقع ومستخدمي VPN. يمكن أن يساعد الاستعلام في البحث عن اسم الكيان لإرجاع معرف محدد واستخراج قائمة بالكيانات في الحساب تلقائيًا. يتم إرجاع كل كيان مع معلومات إضافية ذات صلة، مثل تاريخ الإنشاء والوصف.

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

تفاصيل حقول entityLookup

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

• العناصر - يحتوي حقل العناصر على البيانات لكل كيان
• الإجمالي - إجمالي عدد الكيانات التي تم إرجاعها لهذا الاستعلام

عناصر entityLookup

تظهر حقول EntityInfo البيانات لكل كيان، بما في ذلك:

• الكيان - يُظهر المعرف، الاسم من تطبيق إدارة Cato، ونوع الكيان عادةً موقع أو مستخدم vpn
• الوصف - وصف الكيان من تطبيق إدارة Cato
• helperFields - معلومات وبيانات إضافية ذات صلة بالكيان

الإجمالي الخاص بـ entityLookup

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

وسائط entityLookup

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

• accountIDs - معرفات الحساب، للأكثر من حساب، أدخل المعرفات كمصفوفة (وسيط إلزامي)
• النوع - إعادة الكيانات التي تطابق النوع، على سبيل المثال الموقع أو vpnUser (وسيط إلزامي)
• الحد - الحد الأقصى لعدد الكيانات التي تم إرجاعها لهذا الاستعلام (القيمة الافتراضية هي 50)
• من - وفقًا لمؤشر الإدخالات، ابدأ الاستعلام من هذا الكيان المحدد
• البحث - تصفية الاسترجاع وفقًا لهذه القيمة
• entityIDs - معرفات الكيانات، للأكثر من كيان، أدخل المعرفات كمصفوفة
• الفرز - يحدد كيفية ترتيب الكيانات التي يعيدها الاستعلام

entityLookup accountIDs اﻟﻣﻌْطَى

أدخل واحدًا أو أكثر من معرفات الحسابات للبيانات التي يعيدها الاستعلام.

يُعرض معرف الحساب هذا في صفحة الإدارة > معلومات عامة.

وسيط accountIDs إلزامي للاستعلام.

كيانات entityLookup النوع

يعرّف وسيط النوع بيانات الكيانات التي يعيدها الاستعلام. هذه هي القيم المدعومة لوسيط النوع: الموقع، vpnUser، وadmins.

وسيط النوع إلزامي للاستعلام. ارجع إلى المخطط للحصول على عناصر enum لكل قيمة.

كيانات entityLookup الحد

يعرّف وسيط الحد العدد الأقصى للكيانات التي يعيدها الاستعلام. إذا لم تحدد وسيط الحد، يصبح الاستعلام محدودًا بـ 50 كيان.

يمكن لكل استعلام إعادة حد أقصى من 1000 كيان.

كيانات entityLookup من

يعرّف وسيط من أي كيان يبدأ الاستعلام. على سبيل المثال، إذا كان الحساب يحتوي على 100 مستخدم VPN، قم بتعيينها على 60 لعرض آخر 40 كيان مستخدم VPN.

العنصر الأول في الاستعلام هو 0. لذلك، إذا كنت ترغب في عرض بدءًا من العنصر 20 فقط، تعيّنها على 19.

كيانات entityLookup البحث

يقوم وسيط البحث بتصفية الاستعلام لإرجاع أسماء الكيانات المطابقة فقط. وسيط البحث هو قيمة نصية.

كيانات entityLookup entityIDs

يقوم وسيط entityIDs بإرجاع الكيانات التي تطابق المعرفات فقط.

كيانات entityLookup الفرز

يسمح لك وسيط الفرز بترتيب البيانات حسب المعرف أو الاسم للكيانات، بترتيب تصاعدي أو تنازلي.

• الحقل - استخدم الاسم أو المعرف كقيمة للحقل
• الترتيب - رتب النتائج بترتيب تصاعدي (asc) أو تنازلي (dsc)

على سبيل المثال، لفرز النتائج بترتيب تصاعدي (a-z) وفقًا للاسم، استخدم هذا الوسيط: sort:{field"name", order:asc}

query entityLookup ($accountID: ID!, $type: EntityType!, $search: String) {
    entityLookup (accountID: $accountID, type: $type, search: $search) {
        items {
            entity {
                id
                name
            }
        }
    }
}

{
    "accountID": "26",
    "type": "site"
}

query entityLookup ($accountID: ID!, $type: EntityType!, $search: String) {
    entityLookup (accountID: $accountID, type: $type, search: $search) {
        items {
            entity {
                id
                name
            }
        }
    }
}

{
    "accountID": "26",
    "type": "site",
    "search": "MySite"
}

query entityLookup ($accountID: ID!, $type: EntityType!, $parent: EntityInput!) {
    entityLookup (accountID: $accountID, type: $type, parent: $parent) {
        items {
            entity {
                id
                name
                type
            }
            description
            helperFields
            }
        }
    }
}

{
    "accountID": "26",
    "type": "networkInterface",
    "parent": {
        "id": 52180,
        "type": "site"
    }
}