我们强烈建议您在开始使用 Cato API 之前，请查看 Cato API 的支持政策。

entityLookup 概览

entityLookup 查询与 Cato 管理应用程序中的实体（例如站点和 VPN 用户）一起工作。 该查询可以帮助您查找实体名称以返回特定 ID，并自动提取账户中的实体列表。 每个实体返回时都会附带其他相关信息，例如创建日期和描述。

对于经销商账户，您可以在每个连接到 Cato API 的客户账户中创建单独的 API 密钥。 有关速率限制和 entityLookup API 查询的更多信息，请查看 了解 Cato API 速率限制。

entityLookup 字段详细信息

以下是 auditFeed 字段可以显示的查询详情：

• 项目 - 项字段包含每个实体的数据
• 总计 - 此查询返回的实体总数

entityLookup 项目

EntityInfo 字段显示每个实体的数据，包括：

• 实体 - 显示来自 Cato 管理应用程序的 id、名称 和类型，通常是站点或 vpnUser
• 描述 - Cato 管理应用程序的实体描述
• helperFields - 额外的相关信息和关于实体的数据

entityLookup 总数

总计字段显示 Cato 管理应用程序中您的账户的实体总数。 此字段的值不会在 API 分页过程中改变，可以帮助您轻松地将其与检索到的记录总数进行比较。

entityLookup 参数

以下是您可以传递并定义由查询返回的实体的参数：

• 账户ID - 对于多个账户，请将ID作为数组输入（必填参数）
• 类型 - 返回与类型匹配的实体，例如 站点 或 vpnUser（必填参数）
• 限制 - 此查询返回的实体最大数目（默认值为 50）
• 从 - 根据条目的索引，从该特定实体开始查询
• 搜索 - 根据此值过滤返回结果
• 实体ID - 对于多个实体，请将ID作为数组输入
• 排序 - 定义查询返回的实体如何排序

entityLookup 账户ID 参数

输入一个或多个账户ID以获取查询返回的数据。

此账户ID显示在管理 > 常规信息页面。

accountIDs 参数是该查询的必填项。

entityLookup 类型 参数

类型参数定义了查询返回的实体数据。 以下是支持类型参数的值：站点、vpnUser 和 管理员。

类型参数是此查询的必填项。 请参考每个值的 枚举 项目的模式。

entityLookup 限制 参数

限制参数定义了查询返回的实体最大数目。 如果不指定限制参数，查询将限定为 50 个实体。

每个查询最多可以返回 1000 个实体。

entityLookup 从 参数

从参数定义了从哪个实体开始查询。 例如，如果一个账户有 100 个 VPN 用户，请将其设置为 60 以仅显示最后 40 个 VPN 用户实体。

查询中的第一个项目是 0。 因此，如果您只想从项目 20 开始显示，则将其设置为 19。

entityLookup 搜索 参数

搜索参数过滤查询，只返回匹配的实体名称。 搜索参数是一个字符串值。

entityLookup 实体ID 参数

entityIDs 参数仅返回与 ID 匹配的实体。

entityLookup 排序 参数

排序参数允许您按实体的 id 或名称对数据进行升序或降序排序。

• 字段 - 使用 名称 或 id 作为字段值
• 顺序 - 按升序 (asc) 或降序 (dsc) 对结果进行排序

例如，按名称升序排列结果（a-z），请使用此参数：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: 实体类型!, $parent: 实体输入!) {
    entityLookup (accountID: $accountID, type: $type, parent: $parent) {
        项目 {
            实体 {
                id
                名称
                类型
            }
            描述
            helperFields
            }
        }
    }
}

{
    "accountID": "26",
    "类型": "网卡类型",
    "parent": {
        "id": 52180,
        "类型": "站点"
    }
}