কাটো এপিআই - EntityLookup

আমরা দৃঢ়ভাবে সুপারিশ করছি যে কাটো এপিআই ব্যবহার শুরু করার আগে, দয়া করে কাটো এপিআই-এর সহায়তা নীতি পর্যালোচনা করুন।

entityLookup এর ওভারভিউ

entityLookup কুয়েরি কাটো ম্যানেজমেন্ট অ্যাপ্লিকেশনের সত্তাদের সাথে কাজ করে যেমন সাইট ও VPN ব্যবহারকারীদের। এই কুয়েরি আপনাকে অন্বেষণ সত্তার নাম পরিচয় করতে, নির্দিষ্ট আইডি দেখাতে সাহায্য করতে পারে এবং অ্যাকাউন্টে সত্তাদের একটি তালিকা স্বয়ংক্রিয়ভাবে বের করতে পারে। প্রতিটি সত্তাকে অতিরিক্ত প্রাসঙ্গিক তথ্য সহ ফেরত দেওয়া হয়, যেমন সৃষ্টির তারিখ এবং বিবরণ।

রিসেলার অ্যাকাউন্টগুলির জন্য, আপনি যেসকল গ্রাহক অ্যাকাউন্টের সাথে কাটো এপিআই সংযোগ করছেন, সেখানে পৃথক এপিআই কি তৈরি করতে পারেন। রেট লিমিটিং এবং entityLookup এপিআই কুয়েরি সম্পর্কে আরও জানতে দেখুন কাটো এপিআই রেট লিমিটিং বোঝা ।

entityLookup ফিল্ডের বিবরণ

এগুলি অডিটফিড ফিল্ডগুলির বিবরণ যা কুয়েরির জন্য দেখাতে পারে:

• আইটেমস - আইটেমস ফিল্ড প্রতিটি সত্তার জন্য ডেটা ধারণ করে

• মোট - এই কুয়েরির জন্য ফেরত দেওয়া সত্তাগুলির মোট সংখ্যা

entityLookup আইটেমস

EntityInfo ফিল্ডগুলি প্রতিটি সত্তার জন্য ডেটা দেখায়, অন্তর্ভুক্ত:

• entity - কাটো ম্যানেজমেন্ট অ্যাপ্লিকেশন থেকে আইডি, নাম এবং সত্তার প্রকার সাধারণত সাইট বা vpnUser দেখায়

• বিবরণ - কাটো ম্যানেজমেন্ট অ্যাপ্লিকেশন থেকে সত্তার বিবরণ

• হেলপারফিল্ডস - সত্তার সম্পর্কিত অতিরিক্ত তথ্য এবং ডেটা

entityLookup মোট

মোট ফিল্ড কাটো ম্যানেজমেন্ট অ্যাপ্লিকেশনের জন্য আপনার অ্যাকাউন্টের জন্য মোট সত্তার সংখ্যা দেখায়। এপিআই রিটার্ন পেজিনেশন চলাকালীন এই ফিল্ডের মান পরিবর্তিত হয় না এবং এটি আপনাকে ফিরিয়ে আনা রেকর্ডের মোট সংখ্যা সহ সহজেই তুলনা করতে সহায়তা করতে পারে।

entityLookup এর জন্য আর্গুমেন্টস

এগুলি হল আপনি পাস করতে পারেন এবং যে সত্তাগুলি কুয়েরি দ্বারা ফেরত দেওয়া হয় তা সংজ্ঞায়িত করতে পারেন এমন আর্গুমেন্টগুলি:

• অ্যাকাউন্টআইডিস - অ্যাকাউন্টের আইডি, একাধিক অ্যাকাউন্টের জন্য, আইডি গুলিকে একটি অ্যারের রূপে লিখুন (বাধ্যতামূলক আর্গুমেন্ট)

• টাইপ - প্রকার মেলে এমন সত্তাগুলি ফেরত দিন, উদাহরণস্বরূপ সাইট বা vpnUser (বাধ্যতামূলক আর্গুমেন্ট)

• লিমিট - এই কুয়েরির জন্য ফেরত দেওয়া সর্বাধিক সত্তার সংখ্যা (ডিফল্ট মান হল ৫০)

• থেকে - এন্ট্রির সূচক অনুসারে, এই নির্দিষ্ট সত্তা থেকে কুয়েরি শুরু করুন

• অনুসন্ধান - এই মান অনুযায়ী ফেরতগুলো ফিল্টার করুন

• সত্তা আইডিস - সত্তার আইডি গুলি, একাধিক সত্তার জন্য, আইডি গুলিকে একটি অ্যারে আকারে লিখুন

• সাজান - কুয়েরী দ্বারা ফেরত দেওয়া সত্তাগুলির সাজানো সংজ্ঞায়িত করুন

entityLookup অ্যাকাউন্টআইডিস আর্গুমেন্ট

আপনার কুয়েরি যে ডেটা ফেরত দেয় তার অ্যাকাউন্ট আইডি গুলি প্রবেশ করান।

এই অ্যাকাউন্ট আইডি প্রশাসন > সাধারণ তথ্য পৃষ্ঠায় দেখানো হয়।

অ্যাকাউন্টআইডিস আর্গুমেন্ট কুয়েরির জন্য বাধ্যতামূলক।

entityLookup টাইপ আর্গুমেন্ট

টাইপ আর্গুমেন্ট কুয়েরি যে সত্তার ডেটা ফেরত দেয় তা সংজ্ঞায়িত করে। টাইপ আর্গুমেন্টের জন্য সমর্থিত মানগুলি হল: সাইট, vpnUser, এবং অ্যাডমিনস।

কুয়েরির জন্য টাইপ আর্গুমেন্ট বাধ্যতামূলক। প্রতিটি মানের জন্য enum আইটেমগুলি জন্য স্কিমা দেখুন।

entityLookup লিমিট আর্গুমেন্ট

লিমিট আর্গুমেন্ট কুয়েরি কতগুলি সর্বাধিক সত্তা ফেরত দেয় তা সংজ্ঞায়িত করে। আপনি যদি লিমিট আর্গুমেন্ট নির্দিষ্ট না করেন, তাহলে কুয়েরি ৫০ সত্তায় সীমাবদ্ধ থাকে।

প্রতি কুয়েরি সর্বাধিক ১০০০ সত্তা ফেরত দিতে পারে।

entityLookup থেকে আর্গুমেন্ট

যে সত্তা থেকে শুরু করে কুয়েরি শুরু করবেন তার সংজ্ঞায়িত আর্গুমেন্টটি। উদাহরণস্বরূপ, যদি কোনো অ্যাকাউন্টে ১০০টি VPN ব্যবহারকারী থাকে, তবে শুধুমাত্র শেষ ৪০টি VPN ব্যবহারকারী এন্টিটি দেখানোর জন্য ৬০ এ সেট করুন।

কুয়েরির প্রথম আইটেমটি ০। সুতরাং, যদি আপনি কেবল ২০তম আইটেম থেকে শুরু করতে চান, তাহলে এটি ১৯ এ সেট করুন।

entityLookup অনুসন্ধান আর্গুমেন্ট

অনুসন্ধান আর্গুমেন্টটি কেবল মিলিত সত্তার নামগুলির সাথে কুয়েরি ফিল্টার করে। অনুসন্ধান আর্গুমেন্টটি একটি স্ট্রিং মান।

entityLookup সত্তা আইডিস আর্গুমেন্ট

সত্তা আইডিস আর্গুমেন্ট কেবলমাত্র যে সত্তাগুলি আইডি গুলি মেলে তা ফেরত দেয়।

entityLookup সাজান আর্গুমেন্ট

সাজান আর্গুমেন্ট আপনাকে সত্তাগুলির জন্য আইডি বা নাম অনুযায়ী উর্ধ্বক্রমণ বা অনুদ্র ক্রমে ডেটা সাজাতে দেয়।

• ফিল্ড - নাম বা আইডি কে ফিল্ড মান হিসাবে ব্যবহার করুন

• অর্ডার - ফলাফলগুলি উর্ধ্বক্রমণ (আস্ক) বা অনুদ্র ক্রমে (ডিসি) সাজান

উদাহরণস্বরূপ, নাম অনুযায়ী (a-z) উর্ধ্বক্রমণ ক্রমে ফলাফলগুলি সাজাতে, এই আর্গুমেন্টটি ব্যবহার করুন: sort:{field"name", order:asc}

entityLookup প্যারেন্ট আর্গুমেন্ট

প্যারেন্ট আর্গুমেন্ট হল একটি হায়ারার্কির সাথে সত্তা অন্বেষণ করার জন্য ব্যবহৃত হয়, যেখানে আপনাকে সত্তা এবং এর প্যারেন্ট সরবরাহ করতে হয়। উদাহরণস্বরূপ, networkInterface টাইপের জন্য, আপনাকে এই মান সহ প্যারেন্ট প্রবেশ করতে হবে: আইডি <সাইটের আইডি>, টাইপ সাইট।

নমুনা entityLookup কুয়েরি

এই বিভাগে entityLookup কুয়েরির নমুনা উদাহরণ রয়েছে।

অ্যাকাউন্টের সক্রিয় সব সাইট

নমুনা Postman Script

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

গ্রাফকিউএল ভেরিয়েবলস

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

সাইটের নাম দিয়ে সাইট অন্বেষণ

নমুনা Postman Script

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"
}

প্যারেন্ট আর্গুমেন্ট অন্তর্ভুক্ত করে networkInterface অন্বেষণ

নমুনা Postman Script

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"
    }
}