调用该接口更新任务下作业配置。

QPS限制

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

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 UpdateJob

系统规定参数。取值：UpdateJob。
JobId String 是 XUbmsMHmkqv0PiAG****010001

任务ID。任务的全局唯一标识符。
IotInstanceId String 否 iot-cn-0pp1n8t****

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

重要
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无ID值，则无需传入。

实例的更多信息，请参见实例概述。

Description String 否 jobDescription

任务描述信息。长度不超过100个字符。
TimeoutConfig Json 否 {"inProgressTimeoutInMinutes": 60}

任务下作业执行的超时时间。

更多信息，请参见下文“TimeoutConfig定义”。
RolloutConfig Json 否 {"maximumPerMinute": 1000}

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

名称

类型

描述

maximumPerMinute

Integer

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

messageQoS

String

发送消息类型，仅对自定义任务和Pub批量消息推送任务生效。可取值：

QoS0，表示最多发送一次。

QoS1，表示最少发送一次。如果QoS1消息未接收到PUBACK消息，会在设备重连时，重新推送给设备。

示例


{
  "maximumPerMinute": 1000,
  "messageQos":"Qos1"
}
TimeoutConfig定义

名称

类型

描述

inProgressTimeoutInMinutes

Integer

任务下作业执行的超时时间，单位为分钟。

该参数仅对自定义任务生效。

从任务开始执行（状态更新为IN_PROGRESS）时计算，如果超过了超时时间，任务下作业仍未执行完成，将被自动设置为TIMED_OUT状态。

取值范围：最大值为3600，最小值为1，默认值为60。

示例


{
  "inProgressTimeoutInMinutes": 60
}

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

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

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

ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

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

Success Boolean true

表示是否调用成功。

  • true：调用成功。
  • false：调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=UpdateJob
&JobId=XUbmsMHmkqv0PiAG****010001
&TimeoutConfig={"inProgressTimeoutInMinutes": 60}
&<公共请求参数>

正常返回示例

XML格式 

<UpdateJobResponse>
   <RequestId>B78B4FD1-AE89-417B-AD55-367EBB0C6759</RequestId>
   <Success>true</Success>
</UpdateJobResponse>

JSON格式 

{
    "RequestId":"B78B4FD1-AE89-417B-AD55-367EBB0C6759",
    "Success":true
}

错误码

访问错误中心查看更多错误码。