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

Обзор entityLookup

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

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

Детали полей entityLookup

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

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

Элементы entityLookup

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

• entity - показывает id, имя из Приложения Управления Cato и тип сущности, обычно площадка или vpnUser
• description - описание сущности из Приложения Управления Cato
• helperFields - дополнительная соответствующая информация и данные о сущности

Общий entityLookup

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Аргумент search фильтрует запрос для возврата только соответствующих имен сущностей. Аргумент search имеет строковое значение.

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

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

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

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

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

Например, чтобы сортировать результаты по возрастанию (а-я) согласно имени, используйте этот аргумент: 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"
 }
}