V2.1 Cancel OTA Task¶

取消一个设备的 OTA 升级 task。

该 API 支持在 EnOS 2.2.0 及以上环境中使用。

操作权限¶

确保已获取调用该 API 的权限。更多信息，参见获取 API 调用权限。

请求格式¶

POST https://{apigw-address}/connect-service/v2.1/ota-jobs?action=cancelTask

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	OTA task 所属的 OU ID。如何获取orgId信息>>
jobId	Query	必需	String	OTA task 所在的 OTA job ID。前往 EnOS 应用门户 > 开发者控制台，在运行监控 > OTA 升级中的任务 ID 列查看 Job ID。

请求参数（Body）¶

名称	必需/可选	数据类型	描述
deviceKeys	必需	String数组	需要取消 OTA task 的设备的device key。如何获取设备的 deviceKey 信息>>

错误码¶

代码	错误信息	描述
24404	Job not found	找不到 OTA job。
24617	Job not running	OTA job 未运行，无法取消。
24620	Only init or published tasks can be canceled	才能取消init或published的OTA job。

示例¶

请求示例¶

url: https://{apigw-address}/connect-service/v2.1/ota-jobs?action=cancelTask&orgId=yourOrgId&jobId=yourJobId
method: POST
requestBody: {"deviceKeys":["deviceKey1","deviceKey2"]}

返回示例¶

{
    "code":0,
    "msg":"OK",
    "requestId":"3bdf31b4-e357-4d4c-8cf9-a40dc129a407",
    "data":null
}

SDK 示例¶

你可以在 Github 上获取接入服务的 SDK 示例：

Java
Python