调用该接口取消动态升级策略。
使用说明
只支持取消动态升级批次所关联的动态升级策略。该接口对静态升级批次无效。
该接口执行成功后,会将动态升级批次的状态(JobStatus)设置为已取消(CANCELED)。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。
说明 RAM用户共享阿里云账号配额。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CancelOTAStrategyByJob |
系统规定参数。取值:CancelOTAStrategyByJob。 |
JobId | String | 是 | HvKuBpuk3rdk6E92CP****0200 |
升级批次ID。 您调用CreateOTADynamicUpgradeJob创建批次返回的JobId。您也可以在物联网平台控制台固件的固件详情页查看。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** |
实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 注意
实例的更多信息,请参见实例概述。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | iot.system.SystemException |
调用失败时,返回的错误码。更多信息,请参见错误码。 |
ErrorMessage | String | 系统异常 |
调用失败时,返回的出错信息。 |
RequestId | String | 291438BA-6E10-4C4C-B761-243B9A0D324F |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
是否调用成功。
|
示例
请求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=CancelOTAStrategyByJob
&JobId=HvKuBpuk3rdk6E92CP****0200
&<公共请求参数>
正常返回示例
XML
格式
<CancelOTAStrategyByJobResponse>
<RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
<Success>true</Success>
</CancelOTAStrategyByJobResponse>
JSON
格式
{
"RequestId": "291438BA-6E10-4C4C-B761-243B9A0D324F",
"Success": true
}
错误码
访问错误中心查看更多错误码。