此页面由 AI 自动翻译。查看英文原版

本页目录

  • 关于查询
  • status
  • publicApp
  • publicApps
  • team
  • adoptKey
  • adoptKeys
  • app
  • appRelease
  • apps
  • device
  • deviceApp
  • deviceApps
  • deviceGroup
  • deviceGroups
  • deviceUpgrades
  • devices
  • eventFile
  • snap
  • snaps
  • snapsExtrasKeyValues
  • snapsExtrasKeys
  • snapsTags
  • 相关文档

查询

当您已经知道需要执行的读取操作,并且想要 Luxonis Hub GraphQL 控制 API 的确切公共查询接口时,请使用此页面。每个支持的查询都有自己的部分,因此您可以直接链接到它。

关于查询

每个 GraphQL schema 都有一个根查询类型。在 Luxonis Hub 中,公共根查询类型是 PublicQuery使用此页面来:
  • 检查一个字段是否是支持的公共接口的一部分
  • 确认确切的参数名称和类型
  • 从指南或更新日志条目直接链接到查询字段
如果您需要输入对象详细信息,例如 DevicesFilterInputEventSnapFilterInput,请继续查看 Schema 或通过内省检查实时 schema。

status

返回一个基本的 API 状态字符串。路径: status类型: String!

publicApp

按 ID 获取一个公共应用。路径: publicApp类型: AppDetail

publicApp 的参数

  • appId (ID!): 要获取的公共应用的 ID。

publicApps

列出具有游标分页的公共应用。路径: publicApps类型: AppConnection!

publicApps 的参数

  • after (String): 返回指定游标之后的项目。
  • first (Int): 返回列表中的前 n 项。
  • orderBy (AppOrderBy): 返回的应用的排序顺序。

team

进入经过身份验证的团队范围查询接口。路径: team类型: TeamScopedQueries!此页面上所有剩余的查询部分都嵌套在 team 下,并使用路径 team.<field>

adoptKey

按 ID 获取一个采用密钥。路径: team.adoptKey类型: TeamAdoptKey

adoptKey 的参数

  • adoptKeyId (ID!): 要获取的采用密钥的 ID。

adoptKeys

列出已通过身份验证的团队的采用密钥。路径: team.adoptKeys类型: TeamAdoptKeyConnection!

adoptKeys 的参数

  • after (String): 返回指定游标之后的项目。
  • first (Int): 返回列表中的前 n 项。
  • orderBy (TeamAdoptKeyOrderBy): 返回的采用密钥的排序顺序。

app

按 ID 获取团队可见的一个应用。路径: team.app类型: AppDetail

app 的参数

  • appId (ID!): 要获取的应用的 ID。

appRelease

按 ID 获取一个应用发布版本。路径: team.appRelease类型: AppReleaseWithDetail

appRelease 的参数

  • appReleaseId (ID!): 要获取的应用发布版本的 ID。

apps

列出团队可见的应用。路径: team.apps类型: AppConnection!

apps 的参数

  • after (String): 返回指定游标之后的项目。
  • filter (AppsFilterInput): 返回的应用的筛选选项。
  • first (Int): 返回列表中的前 n 项。
  • orderBy (AppOrderBy): 返回的应用的排序顺序。

device

按 ID 获取一个设备。路径: team.device类型: DeviceWithDetail

device 的参数

  • deviceId (ID!): 要获取的设备的 ID。

deviceApp

按 ID 获取一个已安装的设备应用。路径: team.deviceApp类型: DeviceAppDetail

deviceApp 的参数

  • id (ID!): 要获取的已安装设备应用的 ID。

deviceApps

列出单个设备已安装的设备应用。路径: team.deviceApps类型: DeviceAppConnection!

deviceApps 的参数

  • after (String): 返回指定游标之后的项目。
  • deviceId (ID!): 要列出已安装应用的设备的 ID。
  • first (Int): 返回列表中的前 n 项。
  • orderBy (DeviceAppOrderBy): 返回的设备应用的排序顺序。

deviceGroup

按 ID 查找单个设备组。路径: team.deviceGroup类型: DeviceGroup

deviceGroup 的参数

  • id (ID!): 要获取的设备组的 ID。

deviceGroups

查找具有游标分页的设备组。路径: team.deviceGroups类型: DeviceGroupConnection!

deviceGroups 的参数

  • after (String): 返回指定游标之后的项目。
  • first (Int): 返回列表中的前 n 项。
  • orderBy (DeviceGroupOrderBy): 返回的设备组的排序顺序。

deviceUpgrades

列出单个设备的升级记录。路径: team.deviceUpgrades类型: DeviceUpgradeConnection!

deviceUpgrades 的参数

  • after (String): 返回指定游标之后的项目。
  • filter (DeviceUpgradeFilterInput!): 返回的升级记录的筛选选项。
  • first (Int): 返回列表中的前 n 项。
  • orderBy (DeviceUpgradeOrderBy): 返回的升级记录的排序顺序。

devices

根据条件查找设备。路径: team.devices类型: DeviceConnection!

devices 的参数

  • after (String): 返回指定游标之后的项目。
  • filter (DevicesFilterInput): 返回的设备的筛选选项。
  • first (Int): 返回列表中的前 n 项。
  • orderBy (DeviceOrderBy): 返回的设备的排序顺序。

eventFile

按 ID 获取一个存储的事件文件。路径: team.eventFile类型: EventFile

eventFile 的参数

  • fileId (ID!): 要获取的事件文件的 ID。

snap

按 ID 获取一个事件快照。路径: team.snap类型: EventSnap

snap 的参数

  • snapId (ID!): 要获取的事件快照的 ID。

snaps

根据条件列出事件快照。路径: team.snaps类型: EventSnapConnection!

snaps 的参数

  • after (String): 返回指定游标之后的项目。
  • filter (EventSnapFilterInput): 返回的快照的筛选选项。
  • first (Int): 返回列表中的前 n 项。
  • orderBy (EventSnapOrderBy): 返回的快照的排序顺序。

snapsExtrasKeyValues

返回匹配快照中一个附加键的观察值。路径: team.snapsExtrasKeyValues类型: [String!]!

snapsExtrasKeyValues 的参数

  • input (SnapsExtrasKeyValuesInput!): 附加索引的搜索选项。
  • key (String!): 要列出其值的附加键。

snapsExtrasKeys

返回匹配快照中观察到的附加键。路径: team.snapsExtrasKeys类型: [String!]!

snapsExtrasKeys 的参数

  • input (SnapsExtrasKeysInput!): 附加索引的搜索选项。

snapsTags

返回匹配快照中观察到的标签。路径: team.snapsTags类型: [String!]!

snapsTags 的参数

  • input (SnapsTagsInput!): 标签索引的搜索选项。

相关文档