ListOTAUnfinishedTaskByDevice - IoT Platform

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.	指定的產品不存在。

訪問錯誤中心查看更多錯誤碼。