--- title: "Cato API - EntityLookup" slug: "cato-api-entitylookup" updated: 2026-07-30T03:23:43Z published: 2026-07-30T03:23:43Z canonical: "knowledge.catonetworks.com/cato-api-entitylookup" --- > ## Documentation Index > Fetch the complete documentation index at: https://knowledge.catonetworks.com/llms.txt > Use this file to discover all available pages before exploring further. # Cato API - EntityLookup 我们强烈建议您在开始使用Cato API之前,请查看[Cato API支持政策](/v1/docs/support-policy-for-the-cato-api)。 ## entityLookup概述 entityLookup查询适用于Cato 管理应用程序的实体,例如站点和VPN用户。 该查询可以帮助您查找实体名称以返回特定ID,并自动提取帐户中的实体列表。 每个实体都会返回其他相关信息,例如创建时间和描述。 对于经销商账户,您可以在每个与 Cato API 连接的客户账户中创建单独的 API 密钥。 有关费率限制和entityLookup API查询的更多信息,请参阅[了解Cato API费率限制](/v1/docs/understanding-cato-api-rate-limiting)。 ## entityLookup字段详细信息 这些是auditFeed字段可以显示的查询详情: - 项目 - 项目字段包含每个实体的数据 - 总计 - 为此查询返回的实体总数 ## entityLookup项目 EntityInfo字段显示每个实体的数据,包括: - 实体 - 显示Cato 管理应用程序中的**id**、**名称**和实体的**类型**,通常是站点或vpnUser - 描述 - 来自Cato 管理应用程序的实体描述 - 辅助字段 - 关于实体的其他相关信息和数据 ## entityLookup总计 总计字段显示您的帐户在Cato 管理应用程序中的实体总数。 在API返回的分页过程中,此字段的值不会改变,可以帮助您轻松将其与检索到的记录总数进行比较。 ## entityLookup参数 这些是可以传递的参数,用于定义查询返回的实体: - accountIDs - 帐户ID,对于多个帐户,将ID作为数组输入(必填参数) - 类型 - 返回与类型匹配的实体,例如**站点**或**vpnUser**(必填参数) - 限制 - 为此查询返回的最大实体数(默认值为50) - 从 - 根据条目的索引,从此特定实体开始查询 - 搜索 - 根据此值过滤返回 - entityIDs - 实体ID,对于多个实体,将ID作为数组输入 - 排序 - 定义查询返回的实体的排序方式 ## entityLookup accountIDs参数 输入一个或多个帐户ID以获取查询返回的数据。 此帐户ID显示在管理 > 常规信息页面。 查询的accountIDs参数是必需的。 ## entityLookup类型参数 类型参数定义查询返回的实体数据。 这些是类型参数支持的值:**站点**、**vpnUser**和**管理员**。 查询的类型参数是必填参数。 请参阅每个值的枚举项目的模式。 ## entityLookup限制参数 限制参数定义查询返回的最大实体数。 如果您未指定限制参数,则查询限制为50个实体。 每个查询最多可返回1000个实体。 ## entityLookup从参数 从参数定义查询开始的实体。 例如,如果账户有100个VPN用户,设置到**60**,只显示最后40个VPN用户实体。 查询中的第一个项目是0。 因此,如果您只想从第20项开始显示,则设置为19。 ## entityLookup搜索参数 搜索参数过滤查询仅返回匹配的实体名称。 搜索参数是一个字符串值。 ## entityLookup实体ID参数 实体ID参数仅返回与ID匹配的实体。 ## entityLookup排序参数 排序参数允许您按实体的id或名称对数据进行排序,升序或降序。 - 字段 - 使用**名称**或**id**作为字段值 - 顺序 - 以升序(**asc**)或降序(**dsc**)排列结果 例如,要按名称顺序在升序(a-z)中排列结果,请使用此参数:`sort:{field:"name", order:"asc"}` ## entityLookup父参数 父参数用于查询具有层次结构的实体,您需要提供实体及其父节点。 例如,对于类型`networkInterface`,您需要输入具有以下值的父节点:**id** <站点 id>,**类型** 站点。 ## entityLookup查询示例 本节有entityLookup查询的示例。 ### 查询帐户中的所有站点 **示例Postman脚本** ```plaintext 查询entityLookup ($accountID: ID!, $type: EntityType!, $search: String) {    entityLookup (accountID: $accountID, type: $type, search: $search) {        项目 {            实体 {                id                名称            }        }    } } ``` **GraphQL变量** ```plaintext {    "accountID": "26",    "type": "站点" } ``` ### 使用站点名称搜索站点 **示例Postman脚本** ```plaintext 查询entityLookup ($accountID: ID!, $type: EntityType!, $search: String) {    entityLookup (accountID: $accountID, type: $type, search: $search) {        项目 {            实体 {                id                名称            }        }    } } ``` **GraphQL变量** ```plaintext {    "accountID": "26",    "type": "站点",    "search": "MySite" } ``` ### 搜索包括父参数在内的networkInterface **示例Postman脚本** ```plaintext 查询entityLookup ($accountID: ID!, $type: EntityType!, $parent: EntityInput!) {    entityLookup (accountID: $accountID, type: $type, parent: $parent) {        项目 {            实体 {                id                名称                类型            }            描述            辅助字段            }        } } ``` **GraphQL变量** ```plaintext {    "accountID": "26",    "type": "networkInterface",    "parent": {        "id": 52180,        "type": "站点"    } } ```