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

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

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

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

تفاصيل حول حقول entityLookup

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

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

عناصر entityLookup

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

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

إجمالي entityLookup

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

المدخلات لـ entityLookup

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

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

أداة accountIDs لـ entityLookup

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

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

المدخل accountIDs إلزامي للاستعلام.

أداة نوع entityLookup

تعرف الدخل النوع البيانات الكيانية التي تُرجعها الاستعلام. هذه هي القيم المدعومة لدخل النوع: موقع، vpnUser، ومدراء.

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

أداة حد entityLookup

تعرف الدخل الحد الحد الأقصى لعدد الكيانات التي تُرجعها الاستعلام. إذا لم تحدد مدخل الحد، يتم تحديد الاستعلام إلى 50 كيان.

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

أداة من entityLookup

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

العنصر الأول في الاستعلام هو 0. لذا، إذا كنت تريد أن تظهر ابتداءً من العنصر 20، فحددها إلى 19.

أداة بحث entityLookup

يُرشح مدخل البحث الاستعلام لإرجاع أسماء الكيانات المطابقة فقط. مدخل البحث قيمة نصية.

أداة معرفات الكيانات entityLookup

يرجع المدخل معرفات الكيانات فقط الكيانات التي تطابق المعرفات.

أداة فرز 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"
    }
}