हम दृढ़ता से अनुशंसा करते हैं कि Cato API का उपयोग शुरू करने से पहले, कृपया Cato API के लिए सहायता नीति की समीक्षा करें।

एंटिटीLookup का अवलोकन

एंटिटीLookup क्वेरी Cato प्रबंधन अनुप्रयोग की इकाइयों के साथ काम करती है, जैसे साइट्स और वीपीएन उपयोगकर्ता। क्वेरी आपको विशिष्ट आईडी प्राप्त करने के लिए एक एंटिटी नाम खोजने में मदद कर सकती है, और खाते में इकाइयों की सूची को स्वचालित रूप से निकाल सकती है। प्रत्येक एंटिटी को अतिरिक्त प्रासंगिक जानकारी के साथ लौटाया जाता है, जैसे कि निर्माण तिथि और विवरण।

पुनर्विक्रेता खातों के लिए, आप Cato API से कनेक्ट करते समय प्रत्येक ग्राहक खाता के अंदर अलग-अलग API कुंजी बना सकते हैं। रेट लिमिटिंग और एंटिटीLookup API क्वेरी के बारे में अधिक जानकारी के लिए देखें Cato API रेट लिमिटिंग की समझ।

एंटिटीLookup फ़ील्ड्स के विवरण

ये वह विवरण हैं जो ऑडिटFeed के फ़ील्ड्स को क्वेरी के लिए दिखा सकते हैं:

• आइटम्स - आइटम्स फ़ील्ड प्रत्येक एंटिटी के डेटा को सम्मिलित करता है
• कुल - इस क्वेरी के लिए लौटाई गई कुल एंटिटी की संख्या

एंटिटीLookup आइटम्स

एंटिटीInfo फ़ील्ड्स प्रत्येक एंटिटी के लिए डेटा दिखाते हैं, इसमें शामिल हैं:

• एंटिटी - Cato प्रबंधन अनुप्रयोग से आईडी, नाम और एंटिटी का प्रकार दिखाता है, आमतौर पर साइट या वीपीएन उपयोगकर्ता
• विवरण - Cato प्रबंधन अनुप्रयोग से एंटिटी का विवरण
• हेलपरफ़ील्ड्स - एंटिटी के बारे में अतिरिक्त प्रासंगिक जानकारी और डेटा

एंटिटीLookup कुल

कुल फ़ील्ड आपके खाते की Cato प्रबंधन अनुप्रयोग में एंटिटी की कुल संख्या को दिखाता है। API रिटर्न के पृष्ठांकन के दौरान इस फ़ील्ड का मान बदलता नहीं है, और इसे प्राप्त रिकॉर्ड्स की कुल संख्या से आसानी से तुलना करने में मदद कर सकता है।

एंटिटीLookup के लिए तर्क

ये वे तर्क हैं जिन्हें आप पास कर सकते हैं और क्वेरी द्वारा लौटाई गई एंटिटीज़ को परिभाषित कर सकते हैं:

• खाताIDs - खाता IDs, कई खातों के लिए, IDs को एक एरे के रूप में दर्ज करें (अनिवार्य तर्क)
• प्रकार - एंटिटीज़ लौटाएं जो प्रकार से मेल खाते हैं, उदाहरण के लिए साइट या वीपीएन उपयोगकर्ता (अनिवार्य तर्क)
• सीमा - इस क्वेरी के लिए लौटाई गई एंटिटी की अधिकतम संख्या (डिफॉल्ट मूल्य 50 है)
• से - प्रविष्टियों के सूचकांक के अनुसार, इस विशेष एंटिटी से क्वेरी शुरू करें
• खोज - इस मूल्य के अनुसार रिटर्न को फ़िल्टर करें
• एंटिटीIDs - एंटिटी IDs, कई एंटिटीज़ के लिए, IDs को एक एरे के रूप में दर्ज करें
• सॉर्ट - परिभाषित करता है कि क्वेरी द्वारा लौटाई गई एंटिटीज़ को कैसे क्रमबद्ध किया जाता है

एंटिटीLookup खाताIDs तर्क

उस डेटा के लिए एक या अधिक खाता आईडी दर्ज करें जो रिटर्न करता है।

यह खाता आईडी प्रशासन > सामान्य जानकारी पृष्ठ में प्रदर्शित है।

खाताIDs तर्क क्वेरी के लिए अनिवार्य है।

एंटिटीLookup प्रकार तर्क

प्रकार तर्क उस एंटिटी डेटा को परिभाषित करता है जो क्वेरी रिटर्न करता है। प्रकार तर्क के लिए समर्थित मूल्य हैं: साइट, वीपीएन उपयोगकर्ता, और एडमिन्स।

प्रकार तर्क क्वेरी के लिए अनिवार्य है। प्रत्येक मूल्य के लिए स्कीमा के एनम आइटम्स के लिए संदर्भित करें।

एंटिटीLookup सीमा तर्क

सीमा तर्क अधिकतम एंटिटीज़ की संख्या को परिभाषित करता है जो क्वेरी रिटर्न करता है। यदि आप सीमा तर्क निर्दिष्ट नहीं करते हैं, तो क्वेरी 50 एंटिटीज़ तक सीमित होती है।

प्रत्येक क्वेरी अधिकतम 1000 एंटिटीज़ को रिटर्न कर सकती है।

एंटिटीLookup से तर्क

से तर्क यह परिभाषित करता है कि क्वेरी किस एंटिटी से शुरू की जाए। उदाहरण के लिए, यदि एक खाते में 100 वीपीएन उपयोगकर्ता हैं, तो इसे 60 सेट करें ताकि केवल अंतिम 40 वीपीएन उपयोगकर्ता एंटिटीज़ दिखें।

क्वेरी में पहला आइटम 0 है। तो, यदि आप केवल आइटम 20 से शुरू करना चाहते हैं, तो इसे 19 सेट करें।

एंटिटीLookup खोज तर्क

खोज तर्क क्वेरी को केवल मैचिंग एंटिटी नामों को रिटर्न करने के लिए फ़िल्टर करता है। खोज तर्क एक स्ट्रिंग मान है।

एंटिटीLookup एंटिटीIDs तर्क

एंटिटीIDs तर्क केवल उन एंटिटीज़ को रिटर्न करता है जो IDs से मेल खाते हैं।

एंटिटीLookup सॉर्ट तर्क

सॉर्ट तर्क आपको एंटिटी के लिए आईडी या नाम के अनुसार डेटा को क्रम करने की अनुमति देता है, अग्रगामी या पिछवर्ती क्रम में।

• फ़ील्ड - फ़ील्ड मान के रूप में नाम या आईडी का उपयोग करें
• क्रम - परिणामों को अग्रगामी (आस्) या पिछवर्ती (डीएससी) क्रम में क्रमबद्ध करें

उदाहरण के लिए, नाम के अनुसार अग्रगामी क्रम (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"
    }
}