CancelOTATaskByJob_物联网平台_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.

接口说明

使用说明

调用本接口时,除必传参数 JobId,还需对照非必选参数,传入待取消升级作业对应的类型或状态,否则调用接口会失败。

QPS 限制

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

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

流控信息

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

授权信息

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

请求参数

字段名称字段详情
IotInstanceIdstring

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

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

升级批次 ID。展开详情

示例值:7glPHmaDYLAYMD1HHutT02****参考取值来源:
    ListJob
    CreateJob
CancelScheduledTaskboolean

取消定时升级批次下的设备升级作业,即调用 CreateOTAStaticUpgradeJob 时,传入了 ScheduleTime 参数创建的升级批次。取值:展开详情

示例值:false
CancelQueuedTaskboolean

取消批次下所有状态为待推送(QUEUED)的设备升级作业。取值:展开详情

示例值:false
CancelInProgressTaskboolean

取消批次下所有状态为升级中(IN_PROGRESS)的设备升级作业。取值:展开详情

示例值:false
CancelNotifiedTaskboolean

取消批次下所有状态为已推送(NOTIFIED)的设备升级作业。取值:展开详情

示例值:false
CancelUnconfirmedTaskboolean

取消批次下所有状态为待确认(CONFIRM)的设备升级作业。取值:展开详情

示例值:false

请求说明

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

返回参数

字段名称字段详情
Codestring

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

示例值:iot.system.SystemException
ErrorMessagestring

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

示例值:系统异常
RequestIdstring

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

示例值:291438BA-6E10-4C4C-B761-243B9A0D324F
Successboolean

表示是否调用成功。展开详情

示例值:true

返回示例

变更历史

暂无变更历史