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

Resumen de entityLookup

La consulta entityLookup funciona con entidades de la Aplicación de Gestión de Cato, como sitios y usuarios de VPN. La consulta puede ayudarle a buscar un nombre de 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 separadas dentro de cada cuenta de cliente a la que se conecta la API de Cato. Para más información sobre la limitación de velocidad y la consulta de la API entityLookup, consulte Comprensión de la limitación de velocidad de API de Cato.

Detalles de los Campos de entityLookup

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

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

Items de entityLookup

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

• entity - muestra el id, name de la Aplicación de Gestión de Cato, y el type de entidad, usualmente sitio o usuarioVPN
• description - descripción de la entidad de la Aplicación de Gestión de Cato
• helperFields - información y datos adicionales relevantes 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 de la devolución 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 son devueltas por la consulta:

• accountIDs - IDs de cuenta, para múltiples cuentas, ingrese los IDs como un array (argumento obligatorio)
• type - devuelve entidades que coincidan con el tipo, por ejemplo el site o usuarioVPN (argumento obligatorio)
• limit - número máximo de entidades devueltas para esta consulta (valor predeterminado es 50)
• from - según el índice de entradas, comience la consulta desde esta entidad específica
• search - filtra el retorno de acuerdo con este valor
• entityIDs - IDs de entidad, para múltiples entidades, ingrese los IDs como un array
• sort - define cómo se ordenan las entidades que la consulta devuelve

Argumento accountIDs para entityLookup

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

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

El argumento accountIDs es obligatorio para la consulta.

Argumento type para entityLookup

El argumento de tipo define los datos de la entidad que la consulta devuelve. Estos son los valores admitidos para el argumento type: site, usuarioVPN y admins.

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

Argumento limit para entityLookup

El argumento limit define el número máximo de entidades que la consulta devuelve. Si no especifica el argumento limit, entonces la consulta se limita a 50 entidades.

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

Argumento from para entityLookup

El argumento from define desde qué entidad comenzar la consulta. Por ejemplo, si una cuenta tiene 100 usuarios VPN, configúrelo a 60 para mostrar solo las últimas 40 entidades de usuario VPN.

El primer ítem en la consulta es 0. Entonces, si desea mostrar solo a partir del ítem 20, configúrelo a 19.

Argumento search para entityLookup

El argumento search filtra la consulta para devolver solo los nombres de entidades coincidentes. El argumento search es un valor de tipo string.

Argumento entityIDs para entityLookup

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

Argumento sort para entityLookup

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

• field - use name o id como el valor del campo
• order - 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: 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"
    }
}