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

本页目录

  • 关于突变
  • team
  • abortOtaOnDevice
  • 的参数
  • 的返回字段
  • createAdoptKey
  • 的参数
  • 的返回字段
  • createDeviceGroup
  • 的参数
  • 的返回字段
  • deleteAdoptKey
  • 的参数
  • 的返回字段
  • deleteDevice
  • 的参数
  • 的返回字段
  • deleteDeviceApp
  • 的参数
  • 的返回字段
  • deleteDeviceGroup
  • 的参数
  • 的返回字段
  • deleteSnapsByFilter
  • 的参数
  • 的返回字段
  • deleteSnapsByIds
  • 的参数
  • 的返回字段
  • deviceGroupAddDevice
  • 的参数
  • 的返回字段
  • deviceGroupRemoveDevice
  • 的参数
  • 的返回字段
  • disableDeviceApp
  • 的参数
  • 的返回字段
  • enableDeviceApp
  • 的参数
  • 的返回字段
  • installAppOnDevice
  • 的参数
  • 的返回字段
  • rebootDevice
  • 的参数
  • 的返回字段
  • renameDeviceGroup
  • 的参数
  • 的返回字段
  • requestDeviceAppConnection
  • 的参数
  • 的返回字段
  • requestDeviceWebrtcConfig
  • 的参数
  • 的返回字段
  • revokeAdoptKey
  • 的参数
  • 的返回字段
  • setDeviceAppConfig
  • 的参数
  • 的返回字段
  • startDeviceApp
  • 的参数
  • 的返回字段
  • startOtaOnDevice
  • 的参数
  • 的返回字段
  • stopDeviceApp
  • 的参数
  • 的返回字段
  • 相关文档
最后更新
当您已经知道需要哪个写入操作并想要 Luxonis Hub GraphQL 控制 API 的精确公共突变表面时,请使用此页面。每个支持的突变都有自己的部分,因此您可以直接链接到它。

关于突变

每个 GraphQL 模式都有一个根突变类型。在 Luxonis Hub 中,公共根突变类型是 PublicMutation。使用此页面可以:
  • 确认确切的突变名称和参数名称
  • 检查每个突变结果类型上可用的顶级字段
  • 从指南或更新日志条目直接链接到一个突变字段
如果您需要输入对象详细信息,例如 InstallAppOnDeviceInput 或 StartOTAOnDeviceInput,请继续阅读 Schema 或通过自省检查实时模式。

team

进入经过身份验证的团队范围突变表面。路径: team类型: TeamScopedMutations!此页面上的所有其余突变部分都嵌套在 team 下,并使用路径 team.<field>。

abortOtaOnDevice

中止设备上已在进行的 OTA 更新。路径: team.abortOtaOnDevice返回: AbortOTAOnDeviceResult!

abortOtaOnDevice 的参数

  • deviceId (ID!): 您要中止 OTA 更新的设备的 ID。

abortOtaOnDevice 的返回字段

  • status (AbortOTAOnDeviceResultStatus!): 操作结果。
  • failedMessage (String): 操作未成功时的失败详细信息。

createAdoptKey

为设备入网创建采用密钥。路径: team.createAdoptKey返回: CreateAdoptKeyResult!

createAdoptKey 的参数

  • input (CreateAdoptKeyInput!): 采用密钥设置,包括名称、有效期和剩余使用次数。

createAdoptKey 的返回字段

  • status (CreateAdoptKeyResultStatus!): 操作结果。
  • key (UUID): 新生成的原始采用密钥值。
  • adoptKey (TeamAdoptKey): 创建的采用密钥的元数据。

createDeviceGroup

创建一个新的设备组。路径: team.createDeviceGroup返回: CreateDeviceGroupResult!

createDeviceGroup 的参数

  • input (CreateDeviceGroupInput!): 设备组设置。目前此输入包含组名称。

createDeviceGroup 的返回字段

  • status (CreateDeviceGroupResultStatus!): 操作结果。
  • deviceGroup (DeviceGroup): 创建的设备组的元数据。

deleteAdoptKey

删除采用密钥。路径: team.deleteAdoptKey返回: DeleteAdoptKeyResult!

deleteAdoptKey 的参数

  • adoptKeyId (ID!): 要删除的采用密钥的 ID。

deleteAdoptKey 的返回字段

  • status (DeleteAdoptKeyResultStatus!): 操作结果。

deleteDevice

从团队中删除设备记录。路径: team.deleteDevice返回: DeleteDeviceResult!

deleteDevice 的参数

  • deviceId (ID!): 要删除的设备的 ID。

deleteDevice 的返回字段

  • status (DeleteDeviceResultStatus!): 操作结果。

deleteDeviceApp

从设备中删除已安装的设备应用程序。路径: team.deleteDeviceApp返回: DeleteDeviceAppResult!

deleteDeviceApp 的参数

  • deviceAppId (ID!): 要删除的已安装设备应用程序的 ID。

deleteDeviceApp 的返回字段

  • status (DeleteDeviceAppResultStatus!): 操作结果。
  • failedMessage (String): 操作未成功时的失败详细信息。

deleteDeviceGroup

删除设备组。路径: team.deleteDeviceGroup返回: DeleteDeviceGroupResult!

deleteDeviceGroup 的参数

  • deviceGroupId (ID!): 要删除的设备组的 ID。

deleteDeviceGroup 的返回字段

  • status (DeleteDeviceGroupResultStatus!): 操作结果。

deleteSnapsByFilter

使用过滤器批量删除快照。路径: team.deleteSnapsByFilter返回: DeleteSnapsResult!

deleteSnapsByFilter 的参数

  • filter (EventSnapFilterInput!): 用于选择要删除的快照的过滤器。

deleteSnapsByFilter 的返回字段

  • status (DeleteSnapsResultStatus!): 操作结果。
  • bgTaskId (ID): 当删除异步继续时要轮询的后台任务 ID。

deleteSnapsByIds

按 ID 删除特定快照集。路径: team.deleteSnapsByIds返回: DeleteSnapsResult!

deleteSnapsByIds 的参数

  • ids ([ID!]!): 要删除的快照的 ID。

deleteSnapsByIds 的返回字段

  • status (DeleteSnapsResultStatus!): 操作结果。
  • bgTaskId (ID): 当删除异步继续时要轮询的后台任务 ID。

deviceGroupAddDevice

将一个设备添加到设备组。路径: team.deviceGroupAddDevice返回: AddDeviceToDeviceGroupResult!

deviceGroupAddDevice 的参数

  • deviceGroupId (ID!): 目标设备组的 ID。
  • input (AddDeviceToDeviceGroupInput!): 设备组分配输入。目前此输入包含设备 ID。

deviceGroupAddDevice 的返回字段

  • status (AddDeviceToDeviceGroupResultStatus!): 操作结果。

deviceGroupRemoveDevice

从设备组中移除一个设备。路径: team.deviceGroupRemoveDevice返回: RemoveDeviceFromDeviceGroupResult!

deviceGroupRemoveDevice 的参数

  • deviceGroupId (ID!): 设备组的 ID。
  • input (RemoveDeviceFromDeviceGroupInput!): 设备组移除输入。目前此输入包含设备 ID。

deviceGroupRemoveDevice 的返回字段

  • status (RemoveDeviceFromDeviceGroupResultStatus!): 操作结果。

disableDeviceApp

禁用已安装的设备应用程序。路径:team.disableDeviceApp返回:DisableDeviceAppResult!

disableDeviceApp 的参数

  • deviceAppId (ID!): 要禁用的已安装设备应用程序的 ID。

disableDeviceApp 的返回字段

  • status (DisableDeviceAppResultStatus!): 操作结果。
  • failedMessage (String): 操作未成功时的失败详细信息。

enableDeviceApp

启用已安装的设备应用程序。路径:team.enableDeviceApp返回:EnableDeviceAppResult!

enableDeviceApp 的参数

  • deviceAppId (ID!): 要启用的已安装设备应用程序的 ID。

enableDeviceApp 的返回字段

  • status (EnableDeviceAppResultStatus!): 操作结果。
  • failedMessage (String): 操作未成功时的失败详细信息。

installAppOnDevice

在设备上安装应用程序。路径:team.installAppOnDevice返回:InstallAppOnDeviceResult!

installAppOnDevice 的参数

  • deviceId (ID!): 应该安装应用程序的设备的 ID。
  • input (InstallAppOnDeviceInput!): 安装设置,包括应用程序标识符、可选版本、环境和启动行为。

installAppOnDevice 的返回字段

  • status (InstallAppOnDeviceResultStatus!): 操作结果。
  • failedMessage (String): 操作未成功时的失败详细信息。

rebootDevice

重启设备。路径:team.rebootDevice返回:RebootDeviceResult!

rebootDevice 的参数

  • deviceId (ID!): 要重启的设备的 ID。

rebootDevice 的返回字段

  • status (RebootDeviceResultStatus!): 操作结果。
  • failedMessage (String): 操作未成功时的失败详细信息。

renameDeviceGroup

重命名现有设备组。路径:team.renameDeviceGroup返回:RenameDeviceGroupResult!

renameDeviceGroup 的参数

  • deviceGroupId (ID!): 要重命名的设备组的 ID。
  • input (RenameDeviceGroupInput!): 重命名输入。目前此输入包含新的组名称。

renameDeviceGroup 的返回字段

  • status (RenameDeviceGroupResultStatus!): 操作结果。

requestDeviceAppConnection

请求设备应用程序会话的连接详细信息。路径:team.requestDeviceAppConnection返回:RequestDeviceAppConnectionResult!

requestDeviceAppConnection 的参数

  • deviceAppId (ID!): 要连接的已安装设备应用程序的 ID。

requestDeviceAppConnection 的返回字段

  • status (RequestDeviceAppConnectionResultStatus!): 操作结果。
  • failedMessage (String): 操作未成功时的失败详细信息。
  • connection (AppConnectionResponse): 连接负载。如果存在,选择 deviceAppId 和 state。

requestDeviceWebrtcConfig

请求设备的浏览器端 WebRTC 引导详细信息。路径:team.requestDeviceWebrtcConfig返回:RequestDeviceWebrtcConfigResult!

requestDeviceWebrtcConfig 的参数

  • deviceId (ID!): 要连接的设备的 ID。

requestDeviceWebrtcConfig 的返回字段

  • status (RequestDeviceWebrtcConfigResultStatus!): 操作结果。
  • failedMessage (String): 操作未成功时的失败详细信息。
  • config (WebRtcConfigResponse): WebRTC 引导负载。如果存在,选择 authToken 和 clientId。

revokeAdoptKey

撤销采用密钥而不删除其记录。路径:team.revokeAdoptKey返回:RevokeAdoptKeyResult!

revokeAdoptKey 的参数

  • adoptKeyId (ID!): 要撤销的采用密钥的 ID。

revokeAdoptKey 的返回字段

  • status (RevokeAdoptKeyResultStatus!): 操作结果。

setDeviceAppConfig

更新设备应用程序的运行时配置。路径:team.setDeviceAppConfig返回:SetDeviceAppConfigResult!

setDeviceAppConfig 的参数

  • deviceAppId (ID!): 要配置的已安装设备应用程序的 ID。
  • input (SetDeviceAppConfigInput!): 配置更新,包括环境对象和重启行为。

setDeviceAppConfig 的返回字段

  • status (SetDeviceAppConfigResultStatus!): 操作结果。
  • failedMessage (String): 操作未成功时的失败详细信息。

startDeviceApp

启动已安装的设备应用程序。路径:team.startDeviceApp返回:StartDeviceAppResult!

startDeviceApp 的参数

  • deviceAppId (ID!): 要启动的已安装设备应用程序的 ID。
  • input (StartDeviceAppInput!): 运行时覆盖,例如环境更改或应用程序启用行为。

startDeviceApp 的返回字段

  • status (StartDeviceAppResultStatus!): 操作结果。
  • failedMessage (String): 操作未成功时的失败详细信息。

startOtaOnDevice

在设备上启动 OTA 更新。路径:team.startOtaOnDevice返回:StartOTAOnDeviceResult!

startOtaOnDevice 的参数

  • deviceId (ID!): 要更新的设备的 ID。
  • input (StartOTAOnDeviceInput!): OTA 设置,包括固件 ID 和可选的重启行为。

startOtaOnDevice 的返回字段

  • status (StartOTAOnDeviceResultStatus!): 操作结果。
  • failedMessage (String): 操作未成功时的失败详细信息。

stopDeviceApp

停止正在运行的设备应用程序。路径:team.stopDeviceApp返回:StopDeviceAppResult!

stopDeviceApp 的参数

  • deviceAppId (ID!): 要停止的已安装设备应用程序的 ID。

stopDeviceApp 的返回字段

  • status (StopDeviceAppResultStatus!): 操作结果。
  • failedMessage (String): 操作未成功时的失败详细信息。

相关文档