Мы настоятельно рекомендуем перед началом использования Cato API просмотреть Политику поддержки для Cato API.

Обзор entityLookup

Запрос entityLookup работает с сущностями Приложение Управления Cato, такими как сайты и пользователи VPN. Запрос может помочь вам найти имя объекта и вернуть конкретный ID, а также автоматически извлечь список объектов в учетной записи. Каждая сущность возвращается с дополнительной релевантной информацией, такой как дата создания и описание.

Для учетных записей реселлеров можно создать отдельные ключи API в каждом клиентском аккаунте, который подключается к Cato API. Для получения дополнительной информации об ограничении скорости и запросе API entityLookup, см. Понимание ограничения скорости Cato API.

Подробности для полей entityLookup

Вот подробности, которые поля auditFeed могут показывать для запроса:

• объекты - поле объектов содержит данные для каждой сущности
• всего - общее количество сущностей, возвращаемых для этого запроса

Элементы entityLookup

Поля EntityInfo показывают данные для каждой сущности, включая:

• Сущность - показывает ID, Имя из Приложения Управления Cato и Тип сущности, обычно сайт или vpnUser
• описание - описание сущности из Приложение Управления Cato
• helperFields - дополнительная релевантная информация и данные о сущности

Всего entityLookup

Поле Всего показывает общее количество сущностей для вашей учетной записи в Приложение Управления Cato. Значение этого поля не изменяется во время постраничного вывода при возврате API и может помочь вам легко сравнить его с общим числом извлеченных записей.

Аргументы для entityLookup

Вот аргументы, которые вы можете передать и задать сущности, возвращаемые запросом:

• accountIDs - ID аккаунтов, для нескольких учетных записей введите ID в виде массива (обязательный аргумент)
• тип - вернуть сущности, которые соответствуют типу, например сайт или vpnUser (обязательный аргумент)
• ограничение - максимальное количество сущностей, возвращаемых для этого запроса (значение по умолчанию — 50)
• из - согласно индексу записей, начать запрос с этой конкретной сущности
• поиск - фильтровать возврат по этому значению
• entityIDs - ID сущностей, для нескольких сущностей введите ID в виде массива
• сортировка - определяет, как отсортированы возвращаемые запросом сущности

Аргумент accountIDs для entityLookup

Введите один или несколько ID аккаунтов для данных, которые возвращает запрос.

Этот ID аккаунта отображается на странице Администрирование > Общая информация.

Аргумент accountIDs обязателен для запроса.

Аргумент type для entityLookup

Аргумент тип определяет данные сущности, возвращаемые запросом. Это поддерживаемые значения для аргумента тип: сайт, vpnUser и администраторы.

Аргумент тип обязателен для запроса. Обратитесь к схеме для элементов enum для каждого значения.

Аргумент limit для entityLookup

Аргумент ограничения определяет максимальное количество сущностей, которые возвращает запрос. Если вы не указали аргумент ограничения, то запрос ограничивается 50 сущностями.

Каждый запрос может вернуть максимум 1000 сущностей.

Аргумент from для entityLookup

Аргумент из определяет, с какой сущности начать запрос. Например, если в аккаунте 100 Пользователи VPN, установите для 60, чтобы показывать только последние 40 Объекты Пользователи VPN.

Первый элемент в запросе — 0. Так что, если вы хотите показывать только начиная с элемента 20, установите его на 19.

Аргумент поиска для entityLookup

Аргумент поиска фильтрует запрос, возвращая только совпадающие имена объектов. Аргумент поиска является строковым значением.

Аргумент entityIDs для entityLookup

Аргумент entityIDs возвращает только те сущности, которые соответствуют ID.

Аргумент сортировки для entityLookup

Аргумент сортировки позволяет вам сортировать данные по ID или Имя для сущностей, в порядке возрастания или убывания.

• поле - используйте имя или id в качестве значения поле
• порядок - сортируйте результаты по возрастанию (asc) или убыванию (dsc)

Например, чтобы отсортировать результаты по возрастанию (a-z) по имени, используйте этот аргумент: sort:{field"имя", order:asc}

query entityLookup ($accountID: ID!, $type: EntityType!, $search: Поиск) {
    entityLookup (accountID: $accountID, type: $type, search: $search) {
        элементы {
            Сущность {
                ID
                Имя
            }
        }
    }
}

{
    "accountID": "26",
    "type": "сайт"
}

query entityLookup ($accountID: ID!, $type: EntityType!, $search: Поиск) {
    entityLookup (accountID: $accountID, type: $type, search: $search) {
        элементы {
            Сущность {
                ID
                Имя
            }
        }
    }
}

{
    "accountID": "26",
    "type": "сайт",
    "search": "MySite"
}

query entityLookup ($accountID: ID!, $type: EntityType!, $parent: EntityInput!) {
    entityLookup (accountID: $accountID, type: $type, parent: $parent) {
        элементы {
            Сущность {
                ID
                Имя
                Тип
            }
            Описание
            helperFields
            }
        }
    }
}

{
    "accountID": "26",
    "type": "networkInterface",
    "parent": {
        "id": 52180,
        "type": "сайт"
    }
}