Recomendamos encarecidamente que, antes de comenzar a usar la API de Cato, revise la Política de Soporte para la API de Cato.

Descripción general de entityLookup

La consulta entityLookup funciona con entidades de la Aplicación de Gestión de Cato, como sitios y usuarios VPN. La consulta puede ayudarlo a buscar el nombre de una entidad para devolver el ID específico y extraer automáticamente una lista de entidades en la cuenta. Cada entidad se devuelve con información adicional relevante, como la fecha de creación y la descripción.

Para cuentas de revendedores, puede crear claves API independientes dentro de cada cuenta de cliente que está conectando a la API de Cato. Para más información sobre limitación de tasa y la consulta de la API entityLookup, consulte Comprender la Limitación de Tasa de la API de Cato.

Detalles de los Campos de entityLookup

Estos son los detalles que los campos auditFeed pueden mostrar para la consulta:

• items - el campo items contiene los datos de cada entidad
• total - número total de entidades devueltas por esta consulta

elementos de entityLookup

Los campos EntityInfo muestran los datos de cada entidad, incluyendo:

• entidad - muestra el id, nombre de la Aplicación de Gestión de Cato y el tipo de entidad, generalmente sitio o vpnUser
• descripción - descripción de la entidad de la Aplicación de Gestión de Cato
• campos de ayuda - información adicional relevante y datos sobre la entidad

Total de entityLookup

El campo Total muestra el número total de entidades para su cuenta en la Aplicación de Gestión de Cato. El valor de este campo no cambia durante la paginación del retorno de la API y puede ayudarle a compararlo fácilmente con el número total de registros recuperados.

Argumentos para entityLookup

Estos son los argumentos que puede pasar y definir las entidades que se devuelven en la consulta:

• accountIDs - ID de cuenta, para múltiples cuentas, ingrese los ID como un array (argumento obligatorio)
• tipo - devuelve entidades que coinciden con el tipo, por ejemplo, sitio o vpnUser (argumento obligatorio)
• límite - número máximo de entidades devueltas por esta consulta (el valor predeterminado es 50)
• desde - según el índice de entradas, inicie la consulta desde esta entidad específica
• buscar - filtrar el resultado de acuerdo a este valor
• entityIDs - IDs de entidad, para múltiples entidades, ingrese los ID como un array
• ordenar - define cómo se ordenan las entidades que devuelve la consulta

Argumento entityLookup accountIDs

Ingrese uno o más ID de cuenta para los datos que devuelve la consulta.

Este ID de cuenta se muestra en la página Administración > Información general.

El argumento accountIDs es obligatorio para la consulta.

Argumento entityLookup tipo

El argumento tipo define los datos de la entidad que devuelve la consulta. Estos son los valores compatibles para el argumento tipo: sitio, vpnUser y admins.

El argumento tipo es obligatorio para la consulta. Consulte el esquema para los elementos enum para cada valor.

Argumento entityLookup límite

El argumento límite define el número máximo de entidades que devuelve la consulta. Si no especifica el argumento límite, entonces la consulta está limitada a 50 entidades.

Cada consulta puede devolver un máximo de 1000 entidades.

Argumento entityLookup desde

El argumento desde define desde qué entidad empezar la consulta. Por ejemplo, si una cuenta tiene 100 usuarios VPN, establézcalo en 60 para mostrar solo las últimas 40 entidades de usuario VPN.

El primer elemento en la consulta es 0. Entonces, si desea mostrar solo a partir del elemento 20, establézcalo en 19.

Argumento entityLookup buscar

El argumento de búsqueda filtra la consulta para devolver solo los nombres de entidad coincidentes. El argumento de búsqueda es un valor de cadena.

Argumento entityLookup entityIDs

El argumento entityIDs solo devuelve entidades que coinciden con los IDs.

Argumento entityLookup ordenar

El argumento de ordenación le permite ordenar los datos según el id o nombre de las entidades, en orden ascendente o descendente.

• campo - use nombre o id como el valor del campo
• orden - ordene los resultados en orden ascendente (asc) o descendente (dsc)

Por ejemplo, para ordenar los resultados en orden ascendente (a-z) según el nombre, utilice este argumento: ordenar:{campo"nombre", orden: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"
    }
}