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

Overview of entityLookup

The entityLookup query works with Cato Management Application entities such as sites and VPN users. यह क्वेरी आपको एक इकाई नाम खोजने में मदद कर सकती है ताकि विशिष्ट ID लौटाई जा सके, और खाते में इकाइयों की एक सूची को स्वचालित रूप से निकाल सकती है। प्रत्येक इकाई को अतिरिक्त प्रासंगिक जानकारी सहित लौटाया जाता है, जैसे निर्माण तिथि और विवरण।

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

Details for the entityLookup Fields

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

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

entityLookup वस्तुएं

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

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

entityLookup कुल

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

Arguments for the entityLookup

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

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

entityLookup accountIDs Argument

प्रश्न द्वारा लौटाए गए डेटा के लिए एक या अधिक खाता आईडी दर्ज करें।

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

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

entityLookup प्रकार तर्क

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

प्रकार तर्क क्वेरी के लिए अनिवार्य है। प्रत्येक मान के लिए मूल्यगणना वस्तुओं के लिए स्कीमा का संदर्भ लें।

entityLookup सीमा तर्क

सीमा तर्क परिभाषित करता है कि क्वेरी द्वारा लौटाई गई इकाइयों की अधिकतम संख्या है। यदि आप सीमा तर्क निर्दिष्ट नहीं करते हैं, तो क्वेरी 50 संस्थाओं तक सीमित है।

प्रत्येक क्वेरी अधिकतम 1000 संस्थाएँ लौटा सकती है।

argument से entityLookup

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

क्वेरी में पहला आइटम 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: आईडी!, $type: EntityType!, $parent: EntityInput!) {
 entityLookup (accountID: $accountID, type: $type, parent: $parent) {
 items {
 entity {
 id
 name
 type
 }
 description
 helperFields
 }
 }
 }
}

{
    "accountID": "26",
    "प्रकार": "networkInterface",
    "parent": {
        "id": 52180,
        "प्रकार": "साइट"
    }
}