ListOTAUnfinishedTaskByDevice - 阿里云物联网平台

QPS限制

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

说明单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListOTAUnfinishedTaskByDevice	系统规定参数。取值：ListOTAUnfinishedTaskByDevice。
IotInstanceId	String	否	iot-c3j***	实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。重要若有ID值，必须传入该ID值，否则调用会失败。若无实例概览页面或ID值，则无需传入。实例的更多信息，请参见实例概述。
ModuleName	String	否	WifiConfigModify	OTA模块名称。传入时，表示查询指定模块的升级任务。不传入时，表示查询所有模块的升级任务。
TaskStatusList.N	RepeatList	否	QUEUED	查询多个指定升级状态下的设备升级作业。 CONFIRM：待确认。 QUEUED：待推送。 NOTIFIED：已推送。 IN_PROGRESS：升级中。说明单次调用本接口，可传入多个状态进行查询。该参数与TaskStatus二选一使用。
ProductKey	String	否	a19mzPZ****	设备所属产品的ProductKey。重要如果传入该参数，需同时传入DeviceName。
DeviceName	String	否	light	设备名称。重要如果传入该参数，需同时传入ProductKey。
TaskStatus	String	否	CONFIRM	查询单个指定升级状态下的设备升级作业。 CONFIRM：待确认。 QUEUED：待推送。 NOTIFIED：已推送。 IN_PROGRESS：升级中。说明单次调用本接口，仅可传入一个状态进行查询。该参数与TaskStatusList二选一使用。
IotId	String	否	TfmUAeJjQQhCPH84UVNn0010c6****	要查询设备的设备ID。重要如果传入该参数，则无需传入ProductKey和DeviceName。IotId作为设备唯一标识符，和ProductKey与DeviceName的组合是一一对应的关系。如果您同时传入IotId和ProductKey与DeviceName的组合，则以IotId为准。

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

返回数据

名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。更多信息，请参见错误码。
Data	Array of SimpleOTATaskInfo		调用成功时，返回的升级作业信息。详细内容，请参见以下SimpleOTATaskInfo。
SimpleOTATaskInfo
DestVersion	String	1.0.1	升级的目标版本。
DeviceName	String	light	设备名称。
FirmwareId	String	q3j9OYBjUAZMv1hlMgdo03****	升级包ID。
IotId	String	nadRdeffljdEndlfadgadfse****	设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。
JobId	String	7glPHmaDYLAYMD1HHutT02****	升级批次ID。
ModuleName	String	WifiConfigModify	OTA模块名称。
ProductKey	String	a1GUfrM****	设备所属产品的ProductKey。
ProductName	String	MyProduct	设备所属产品的名称。
SrcVersion	String	1.0.0	设备的原版本。
TaskId	String	y3tOmCDNgpR8F9jnVEzC01****	设备升级作业ID。
TaskStatus	String	CONFIRM	设备升级作业状态。 CONFIRM：待确认。 QUEUED：待推送。 NOTIFIED：已推送。 IN_PROGRESS：升级中。
UtcCreate	String	2019-11-04T03:38:22.000Z	升级作业创建时的时间，UTC格式。
UtcModified	String	2021-11-04T03:38:22.000Z	升级作业最后一次修改时的时间，UTC格式。
ErrorMessage	String	系统异常	调用失败时，返回的出错信息。
RequestId	String	A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B	阿里云为该请求生成的唯一标识符。
Success	Boolean	true	表示是否调用成功。 true：调用成功。 false：调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAUnfinishedTaskByDevice
&ProductKey=a19mzPZ****
&DeviceName=light
&TaskStatus=CONFIRM
&<公共请求参数>

正常返回示例

XML格式

<ListOTAUnfinishedTaskByDevice>
  <Data>
        <SimpleOTATaskInfo>
              <SrcVersion>1.0.0</SrcVersion>
              <DeviceName>testDevice1</DeviceName>
              <FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
              <IotId>SR8FiTu1R9tlUR2V1bmi00105****</IotId>
              <ProductKey>a1GUfrM****</ProductKey>
              <JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
              <DestVersion>1.0.1</DestVersion>
              <UtcCreate>2019-11-04T03:38:15.000Z</UtcCreate>
              <UtcModified>2019-11-04T03:38:15.000Z</UtcModified>
              <TaskStatus>QUEUED</TaskStatus>
              <ProductName>MyProduct</ProductName>
              <TaskId>y3tOmCDNgpR8F9jnVEzC01****</TaskId>
              <ModuleName>WifiConfigModify</ModuleName>
        </SimpleOTATaskInfo>
        <SimpleOTATaskInfo>
              <SrcVersion>1.0.0</SrcVersion>
              <DeviceName>testDevice2</DeviceName>
              <FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
              <IotId>nadRdeffljdEndlfadgadfse****</IotId>
              <ProductKey>a1GUfrM****</ProductKey>
              <JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
              <DestVersion>1.0.1</DestVersion>
              <UtcCreate>2019-11-04T03:38:22.000Z</UtcCreate>
              <UtcModified>2019-11-04T03:38:22.000Z</UtcModified>
              <TaskStatus>CONFIRM</TaskStatus>
              <ProductName>MyProduct</ProductName>
              <TaskId>ZS9sNBb1ahsu6khqr9II01****</TaskId>
              <ModuleName>ConfigModify</ModuleName>
        </SimpleOTATaskInfo>
  </Data>
  <RequestId>A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B</RequestId>
  <Success>true</Success>
</ListOTAUnfinishedTaskByDevice>

JSON格式

{
  "Data": {
    "SimpleOTATaskInfo": [{
      "SrcVersion": "1.0.0",
      "DeviceName": "testDevice1",
      "FirmwareId": "q3j9OYBjUAZMv1hlMgdo03****",
      "IotId": "SR8FiTu1R9tlUR2V1bmi00105****",
      "ProductKey": "a1GUfrM****",
      "JobId": "7glPHmaDYLAYMD1HHutT02****",
      "DestVersion": "1.0.1",
      "UtcCreate": "2019-11-04T03:38:15.000Z",
      "UtcModified": "2019-11-04T03:38:15.000Z",
      "TaskStatus": "QUEUED",
      "ProductName": "MyProduct",
      "TaskId": "y3tOmCDNgpR8F9jnVEzC01****",
      "ModuleName": "WifiConfigModify"
    }, {
      "SrcVersion": "1.0.0",
      "DeviceName": "testDevice2",
      "FirmwareId": "q3j9OYBjUAZMv1hlMgdo03****",
      "IotId": "nadRdeffljdEndlfadgadfse****",
      "ProductKey": "a1GUfrM****",
      "JobId": "7glPHmaDYLAYMD1HHutT02****",
      "DestVersion": "1.0.1",
      "UtcCreate": "2019-11-04T03:38:22.000Z",
      "UtcModified": "2019-11-04T03:38:22.000Z",
      "TaskStatus": "CONFIRM",
      "ProductName": "MyProduct",
      "TaskId": "ZS9sNBb1ahsu6khqr9II01****",
      "ModuleName": "ConfigModify"
    }]
  },
  "RequestId": "A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B",
  "Success": true
}

错误码

HttpCode	错误码	错误信息	描述
400	iot.common.InvalidPageParams	The specified pagination size or pagination parameter is invalid.	分页大小或者分页页号不合法。
400	iot.ota.NullOtaModuleName	the module name can not be empty.	模块名称为空。
400	iot.ota.InvalidOtaModuleName	the format of module name is invalid.	无效的模块名称。
400	iot.firmware.InvalidTaskStatus	Invalid TaskStatus.	无效的批次状态。
400	iot.device.InvalidFormattedDeviceNameInNameArray	The deviceName list contains an invalid device name.	设备名称列表中存在非法格式的设备名称。
400	iot.firmware.ListOTATaskByDeviceFailed	Failed to list OTA tasks by device.	查询设备下的升级记录失败。
400	iot.prod.NotExistedProduct	The specified product does not exist.	指定的产品不存在。

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