V2.1 Cancel OTA Task¶

取消 OTA job 中指定的某个设备的 OTA 升级 task。

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

操作权限¶

使用此 API 前，确保服务账号已被授予包含下列服务和操作权限的策略。有关授权服务账号的更多信息，参见管理服务账号。

需授权的服务	所需操作权限
固件	Control OTA

请求格式¶

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

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	资产所属的组织ID。如何获取orgId信息>>
jobId	Query	必需	String	OTA task所在的OTA job ID。

请求参数（Body）¶

名称	必需/可选	数据类型	描述
deviceKeys	必需	String数组	需要取消OTA task的设备的device key。

错误码¶

代码	错误信息	描述
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