调用该接口查询设备所关联的升级作业列表。

限制说明

单个阿里云账号调用该接口的每秒请求数(QPS)限流为10,子账号共享主账号配额。

请求参数

名称 类型 是否必需 描述
Action String 要执行的操作,取值:ListOTATaskByDevice
FirmwareId String 固件ID,固件的唯一标识符。

固件ID是调用CreateOTAFirmware创建固件时返回的参数之一。

您可以调用ListOTAFirmware,从返回参数中查看。

ProductKey String 要查询的设备所属产品的ProductKey。
DeviceNames List<String> 要查询的设备名称列表。
说明
  • 列表中不能有重复的设备名称。
  • 最多可传入50个设备名称。
TaskStatus String 设备升级状态列表,
  • QUEUED:待推送。
  • NOTIFIED:已推送。
  • IN_PROGRESS:升级中。
  • SUCCEEDED:升级成功。
  • FAILED:升级失败。
JobId String 传入此参数,指定升级批次ID,仅查询指定设备在该批次中的升级作业。

不传入此参数,则查询指定设备所有关联的全部升级作业。

PageSize Integer 指定返回结果中,每页显示的设备升级作业数量。最大限制:100。
CurrentPage Integer 指定从返回结果中的第几页开始显示。页数从1开始排序。
IotInstanceId String 公共实例不传此参数;您购买的实例需传入实例ID。
公共请求参数 - 公共请求参数,请参见公共参数

返回参数

名称 类型 描述
RequestId String 阿里云为该请求生成的唯一标识符。
Success Boolean 是否调用成功。true表示调用成功,false表示调用失败。
ErrorMessage String 调用失败时,返回的出错信息。
Code String 调用失败时,返回的错误码。错误码详情,请参见错误码
CurrentPage Integer 当前页码。
PageSize Integer 每页显示的设备升级作业数量。
PageCount Integer 总页数。
Total Long 设备升级作业数量总计。
Data List<SimpleOTATaskInfo> 调用成功时,返回的设备升级作业信息。详情请见下表SimpleOTATaskInfo。
表 1. SimpleOTATaskInfo
名称 类型 描述
TaskId String 设备升级作业ID。
JobId String 升级批次ID。
FirmwareId String 固件ID。
TaskStatus String 设备升级状态。
  • QUEUED:待推送。
  • NOTIFIED:已推送。
  • IN_PROGRESS:升级中。
  • SUCCEEDED:升级成功。
  • FAILED:升级失败。
ProductKey String 设备所属产品的ProductKey。
ProductName String 设备所属产品的名称。
DeviceName String 设备名称。
IotId String 设备ID。
SrcVersion String 设备的原固件版本。
DestVersion String 升级的目标固件版本。
UtcCreate String 升级作业创建时的时间,UTC格式。
UtcModified String 升级作业最后一次修改时的时间,UTC格式。
TaskDesc String 升级作业描述信息。当设备升级超时、升级作业被取消等场景下,该参数承载具体的错误信息。
Progress String 当前的升级进度。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTATaskByDevice
&FirmwareId=q3j9OYBjUAZMv1hlMgdo03****
&ProductKey=a1GUfrM****
&DeviceName.1=testDevice1
&DeviceName.2=testDevice2
&PageSize=10
&CurrentPage=1
&公共请求参数

返回示例

  • JSON格式
    {
      "PageCount": 1,
      "Data": {
        "SimpleOTATaskInfo": [{
          "SrcVersion": "1.0.0",
          "DeviceName": "testDevice1",
          "FirmwareId": "q3j9OYBjUAZMv1hlMgdo03****",
          "IotId": "SR8FiTu1R9tlUR2V1bmi00105****",
          "ProductKey": "a1GUfrM****",
          "JobId": "7glPHmaDYLAYMD1HHutT02****",
          "TaskDesc": "report version is not conform",
          "DestVersion": "1.0.1",
          "UtcCreate": "2019-11-04T03:38:15.000Z",
          "UtcModified": "2019-11-04T03:38:15.000Z",
          "TaskStatus": "FAILED",
          "ProductName": "MyProduct",
          "TaskId": "y3tOmCDNgpR8F9jnVEzC01****",
          "Progress": "0.00"
        }, {
          "SrcVersion": "1.0.0",
          "DeviceName": "testDevice2",
          "FirmwareId": "q3j9OYBjUAZMv1hlMgdo03****",
          "IotId": "nadRdeffljdEndlfadgadfse****",
          "ProductKey": "a1GUfrM****",
          "JobId": "7glPHmaDYLAYMD1HHutT02****",
          "TaskDesc": "",
          "DestVersion": "1.0.1",
           "UtcCreate": "2019-11-04T03:38:22.000Z",
          "UtcModified": "2019-11-04T03:38:22.000Z",
          "TaskStatus": "SUCCEEDED",
          "ProductName": "MyProduct",
          "TaskId": "ZS9sNBb1ahsu6khqr9II01****",
          "Progress": "100.00"
        }]
      },
      "PageSize": 10,
      "RequestId": "A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B",
      "CurrentPage": 1,
      "Success": true,
      "Total": 2
    }
  • XML格式
    <?xml version="1.0" encoding="utf-8"?>
    <ListOTATaskByDeviceResponse>
      <PageCount>1</PageCount>
      <Data>
        <SimpleOTATaskInfo>
          <SrcVersion>1.0.0</SrcVersion>
          <DeviceName>testDevice1</DeviceName>
          <FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
          <IotId>SR8FiTu1R9tlUR2V1bmi00105****</IotId>
          <ProductKey>a1GUfrM41vP</ProductKey>
          <JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
          <TaskDesc>report version is not conform</TaskDesc>
          <DestVersion>1.0.1</DestVersion>
          <UtcCreate>2019-11-04T03:38:15.000Z</UtcCreate>
          <UtcModified>2019-11-04T03:38:15.000Z</UtcModified>
          <TaskStatus>FAILED</TaskStatus>
          <ProductName>MyProduct</ProductName>
          <TaskId>y3tOmCDNgpR8F9jnVEzC01****</TaskId>
          <Progress>0.00</Progress>
        </SimpleOTATaskInfo>
        <SimpleOTATaskInfo>
          <SrcVersion>1.0.0</SrcVersion>
          <DeviceName>testDevice2</DeviceName>
          <FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
          <IotId>nadRdeffljdEndlfadgadfse****</IotId>
          <ProductKey>a1GUfrM41vP</ProductKey>
          <JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
          <TaskDesc></TaskDesc>
          <DestVersion>1.0.1</DestVersion>
          <UtcCreate>2019-11-04T03:38:22.000Z</UtcCreate>
          <UtcModified>2019-11-04T03:38:22.000Z</UtcModified>
          <TaskStatus>SUCCEEDED</TaskStatus>
          <ProductName>MyProduct</ProductName>
          <TaskId>ZS9sNBb1ahsu6khqr9II01****</TaskId>
          <Progress>100.00</Progress>
        </SimpleOTATaskInfo>
      </Data>
      <PageSize>10</PageSize>
      <RequestId>A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B</RequestId>
      <Success>true</Success>
      <CurrentPage>1</CurrentPage>
      <Total>2</Total>
    </ListOTATaskByDeviceResponse>