CancelOTATaskByDevice_物联网平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

该接口只能取消待推送、已推送、升级中状态的设备升级。

QPS 限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为 10。

说明 RAM 用户共享阿里云账号配额。

流控信息

请求速率为10/1(s)。更多流控信息,请前往配额中心查看

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
IotInstanceIdstring

实例 ID。您可在物联网平台控制台的实例概览页面,查看当前实例的 ID展开详情

示例值:iot_instc_pu****_c*-v64********
FirmwareIdstring

OTA 升级包 ID,OTA 升级包的唯一标识符。展开详情

示例值:T0F5b5tpFnHQrgfk****030100参考取值来源:
    ListOTAFirmware
    CreateOTAFirmware
ProductKeystring

要取消升级的设备所属产品的 ProductKey。

示例值:a1V4kde****参考取值来源:
    CreateProduct
    QueryProductList
    ReleaseProduct
    ListProductByTags
    BindLicenseProduct
    BatchBindProductsIntoProject
JobIdstring

升级批次 ID。传入此参数则只取消指定批次下的设备升级任务。展开详情

示例值:wahVIzGkCMuAUE2gDERM02****参考取值来源:
    ListJob
    CreateJob
DeviceNamearray<string>

要取消升级的设备名称。展开详情

示例值:device1子级条数 <= 200

请求说明

调用 API 时,除了本文介绍的该 API 的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回参数

字段名称字段详情
Codestring

调用失败时,返回的错误码。更多信息,请参见错误码

示例值:iot.system.SystemException
ErrorMessagestring

调用失败时,返回的出错信息。

示例值:系统异常
RequestIdstring

阿里云为该请求生成的唯一标识符。

示例值:A01829CE-75A1-4920-B775-921146A1AB79
Successboolean

是否调用成功。展开详情

示例值:true

返回示例

变更历史

暂无变更历史