概览硬件软件云平台
此页面由 AI 自动翻译。查看英文原版
Hub 控制
舰队管理
Luxonis HubAI
平台集成
组织
高级

本页目录

  • About mutations
  • team
  • abortOtaOnDevice
  • Arguments for
  • Return fields for
  • createAdoptKey
  • Arguments for
  • Return fields for
  • createDeviceGroup
  • Arguments for
  • Return fields for
  • deleteAdoptKey
  • Arguments for
  • Return fields for
  • deleteDevice
  • Arguments for
  • Return fields for
  • deleteDeviceApp
  • Arguments for
  • Return fields for
  • deleteDeviceGroup
  • Arguments for
  • Return fields for
  • deleteSnapsByFilter
  • Arguments for
  • Return fields for
  • deleteSnapsByIds
  • Arguments for
  • deviceGroupAddDevice
  • deviceGroupRemoveDevice
  • disableDeviceApp
  • enableDeviceApp
  • installAppOnDevice
  • rebootDevice
  • renameDeviceGroup
  • requestDeviceAppConnection
  • requestDeviceWebrtcConfig
  • revokeAdoptKey
  • setDeviceAppConfig
  • startDeviceApp
  • startOtaOnDevice
  • stopDeviceApp
  • 相关文档

Mutations

当您已经知道需要执行哪个写入操作，并希望了解 Luxonis Hub GraphQL 控制 API 的精确公共突变接口时，请使用此页面。每个支持的突变都有自己的部分，因此您可以直接链接到它。

About mutations

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

team

进入经过身份验证的团队范围突变接口。Path: teamType: TeamScopedMutations!此页面上所有剩余的突变部分都嵌套在 team 下，并使用路径 team.<field>。

abortOtaOnDevice

中止设备上正在进行的 OTA 更新。Path: team.abortOtaOnDeviceReturns: AbortOTAOnDeviceResult!

Arguments for abortOtaOnDevice

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

Return fields for abortOtaOnDevice

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

createAdoptKey

创建用于设备入网的采用密钥。Path: team.createAdoptKeyReturns: CreateAdoptKeyResult!

Arguments for createAdoptKey

  • input (CreateAdoptKeyInput!): 采用密钥设置，包括名称、过期时间和剩余使用次数。

Return fields for createAdoptKey

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

createDeviceGroup

创建新的设备组。Path: team.createDeviceGroupReturns: CreateDeviceGroupResult!

Arguments for createDeviceGroup

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

Return fields for createDeviceGroup

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

deleteAdoptKey

删除采用密钥。Path: team.deleteAdoptKeyReturns: DeleteAdoptKeyResult!

Arguments for deleteAdoptKey

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

Return fields for deleteAdoptKey

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

deleteDevice

从团队中删除设备记录。Path: team.deleteDeviceReturns: DeleteDeviceResult!

Arguments for deleteDevice

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

Return fields for deleteDevice

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

deleteDeviceApp

从设备中删除已安装的设备应用程序。Path: team.deleteDeviceAppReturns: DeleteDeviceAppResult!

Arguments for deleteDeviceApp

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

Return fields for deleteDeviceApp

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

deleteDeviceGroup

删除设备组。Path: team.deleteDeviceGroupReturns: DeleteDeviceGroupResult!

Arguments for deleteDeviceGroup

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

Return fields for deleteDeviceGroup

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

deleteSnapsByFilter

使用过滤器批量删除快照。Path: team.deleteSnapsByFilterReturns: DeleteSnapsResult!

Arguments for deleteSnapsByFilter

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

Return fields for deleteSnapsByFilter

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

deleteSnapsByIds

按 ID 删除一组特定的快照。Path: team.deleteSnapsByIdsReturns: DeleteSnapsResult!

Arguments for 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!): 要撤销的 adopt key 的 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): 操作不成功时的失败详情。

相关文档

Schema

Inspect the live schema endpoint, SDL workflow, and introspection options.

Types

Inspect the public object and connection types used by mutation results.

Queries

Switch to the supported public read operations for the same API surface.

About GraphQL

Return to request shape, authentication, and public API boundaries.