UpdateJob_物联网平台_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)最大限制为 5。

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
iot:UpdateJob
Update
全部资源
*

请求参数

字段名称字段详情
IotInstanceIdstring

实例 ID。展开详情

示例值:iot-cn-0pp1n8t****
Descriptionstring

任务描述信息。长度不超过 100 个字符。

示例值:jobDescription
TimeoutConfigobject

任务下作业执行的超时时间。展开详情

示例值:{"inProgressTimeoutInMinutes": 60}
RolloutConfigobject

任务下每分钟推送的作业数量。取值范围为 50~1000。

示例值:{"maximumPerMinute": 1000}
JobIdstring

任务 ID。任务的全局唯一标识符。

示例值:XUbmsMHmkqv0PiAG****010001参考取值来源:
    ListJob
    CreateJob

请求说明

RolloutConfig 定义

名称类型描述
maximumPerMinuteInteger任务下每分钟推送的作业数量。默认值是 1000。取值范围为 50~1000。
messageQoSString发送消息类型,仅对自定义任务和 Pub 批量消息推送任务生效。可取值:
QoS0,表示最多发送一次。
QoS1,表示最少发送一次。如果 QoS1 消息未接收到 PUBACK 消息,会在设备重连时,重新推送给设备。

示例

{
  "maximumPerMinute": 1000,
  "messageQos":"Qos1"
}

TimeoutConfig 定义

名称类型描述
inProgressTimeoutInMinutesInteger任务下作业执行的超时时间,单位为分钟。
该参数仅对自定义任务生效。
从任务开始执行(状态更新为IN_PROGRESS)时计算,如果超过了超时时间,任务下作业仍未执行完成,将被自动设置为 TIMED_OUT 状态。
取值范围:最大值为 3600,最小值为 1,默认值为 60。

示例

{
  "inProgressTimeoutInMinutes": 60
}

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

返回参数

字段名称字段详情
Codestring

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

示例值:iot.system.SystemException
ErrorMessagestring

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

示例值:系统异常
RequestIdstring

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

示例值:E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565
Successboolean

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

示例值:true

返回示例

变更历史

暂无变更历史

相关示例

资源管理平台/设备管理/任务JOB增删改查功能
2022-02-16