Recomendamos fortemente que, antes de começar a usar a Cato API, revise a Política de Suporte para a Cato API.

Visão Geral de entityLookup

A consulta entityLookup funciona com entidades do Aplicativo de Gerenciamento Cato, como locais e usuários VPN. A consulta pode ajudar você a procurar um nome de entidade para retornar o ID específico e extrair automaticamente uma lista de entidades na conta. Cada entidade é retornada com informações adicionais relevantes, como a data de criação e a descrição.

Para contas de revendedores, você pode criar chaves de API separadas dentro de cada conta de cliente que está se conectando à Cato API. Para mais informações sobre limitação de taxa e a consulta de API entityLookup, consulte Compreendendo a Limitação de Taxa da Cato API.

Detalhes para os Campos de entityLookup

Estes são os detalhes que os campos auditFeed podem mostrar para a consulta:

• itens - o campo itens contém os dados para cada entidade
• total - número total de entidades retornadas para esta consulta

Itens de entityLookup

Os campos EntityInfo mostram os dados para cada entidade, incluindo:

• entidade - mostra o id, nome do Aplicativo de Gerenciamento Cato e o tipo de entidade, geralmente site ou vpnUser
• descrição - descrição da entidade do Aplicativo de Gerenciamento Cato
• camposAuxiliares - informações adicionais relevantes e dados sobre a entidade

Total de entityLookup

O campo Total mostra o número total de entidades para sua conta no Aplicativo de Gerenciamento Cato. O valor deste campo não muda durante a paginação do retorno da API, e pode ajudar você a compará-lo facilmente com o número total de registros recuperados.

Argumentos para o entityLookup

Estes são os argumentos que você pode passar e definir as entidades que são retornadas pela consulta:

• ID da Conta - IDs de conta, para várias contas, insira os IDs como um array (argumento obrigatório)
• Tipo - retornam entidades que correspondem ao tipo, por exemplo, o site ou Usuário VPN (argumento obrigatório)
• limite - número máximo de entidades retornadas para esta consulta (o valor padrão é 50)
• de - de acordo com o índice de entradas, comece a consulta a partir desta entidade específica
• pesquisar - filtra o retorno de acordo com este valor
• IDs das Entidades - IDs de entidade, para várias entidades, insira os IDs como um array
• ordenar - define como as entidades que a consulta retorna são ordenadas

Argumento de ID da Conta de entityLookup

Digite um ou mais IDs de conta para os dados que a consulta retorna.

Este ID da Conta é exibido na página Administração > Informações Gerais.

O argumento accountIDs é obrigatório para a consulta.

Argumento de Tipo para entityLookup

O argumento de tipo define os dados da entidade que a consulta retorna. Estes são os valores suportados para o argumento tipo: site, usuárioVPN e administradores.

O argumento de tipo é obrigatório para a consulta. Consulte o esquema para os itens enum para cada valor.

Argumento de Limite de entityLookup

O argumento de limite define o número máximo de entidades que a consulta retorna. Se você não especificar o argumento de limite, a consulta fica limitada a 50 entidades.

Cada consulta pode retornar no máximo 1000 entidades.

Argumento de de para entityLookup

O argumento de de define qual entidade iniciar a consulta. Por exemplo, se uma conta tem 100 Usuários VPN, defina para 60 para mostrar apenas as últimas 40 entidades de Usuários VPN.

O primeiro item na consulta é 0. Portanto, se você deseja exibir apenas a partir do item 20, defina-o para 19.

Argumento de Pesquisar para entityLookup

O argumento de pesquisa filtra a consulta para retornar apenas nomes de entidades correspondentes. O argumento de pesquisa é um valor de string.

Argumento de IDs de Entidade para entityLookup

O argumento entityIDs retorna apenas entidades que correspondem aos IDs.

Argumento de Ordenar para entityLookup

O argumento de ordenação permite que você organize os dados de acordo com o id ou nome das entidades, em ordem ascendente ou descendente.

• campo - use nome ou id como valor do campo
• ordem - organiza os resultados em ordem ascendente (asc) ou descendente (dsc)

Por exemplo, para ordenar os resultados em ordem ascendente (a-z) de acordo com o nome, use este argumento: sort:{field"name", order:asc}

query entityLookup ($accountID: ID!, $type: EntityType!, $search: String) {
    entityLookup (accountID: $accountID, type: $type, search: $search) {
        itens {
            tipo de entidade {
                id
                nome
            }
        }
    }
}

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

query entityLookup ($accountID: ID!, $type: EntityType!, $search: String) {
    entityLookup (accountID: $accountID, type: $type, search: $search) {
        itens {
            tipo de entidade {
                id
                nome
            }
        }
    }
}

{
    "accountID": "26",
    "tipo": "site",
    "pesquisar": "MySite"
}

query entityLookup ($accountID: ID!, $type: EntityType!, $parent: EntityInput!) {
    entityLookup (accountID: $accountID, type: $type, parent: $parent) {
        itens {
            tipo de entidade {
                id
                nome
                tipo
            }
            descrição
            helperFields
            }
        }
    }
}

{
    "accountID": "26",
    "tipo": "networkInterface",
    "parent": {
        "id": 52180,
        "tipo": "site"
    }
}