ListOTATaskByJob - IoT Platform

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為10。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ListOTATaskByJob	系統規定參數。取值：ListOTATaskByJob。
JobId	String	是	7glPHmaDYLAYMD1HHutT02****	升級批次ID，升級批次的唯一識別碼。您調用CreateOTAVerifyJob、CreateOTAStaticUpgradeJob或CreateOTADynamicUpgradeJob返回的JobId。您也可以在物聯網平台控制台上OTA升級包的升級包詳情頁查看。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
PageSize	Integer	否	10	指定返回結果中，每頁顯示的裝置升級作業數量。最大限制：100。重要 CurrentPage與PageSize相乘的值必須小於或等於100,000。
TaskStatus	String	否	FAILED	傳入此參數，則查詢指定升級狀態下的裝置升級作業。 CONFIRM：待確認。 QUEUED：待推送。 NOTIFIED：已推送。 IN_PROGRESS：升級中。 SUCCEEDED：升級成功。 FAILED：升級失敗。 CANCELED：已取消。不傳入此參數，則查詢指定升級批次下的全部裝置升級作業。
CurrentPage	Integer	否	1	指定從返回結果中的第幾頁開始顯示。頁數從1開始排序。重要 CurrentPage與PageSize相乘的值必須小於或等於100,000。
DeviceNames.N	RepeatList	否	device1	指定查詢的裝置名稱列表。說明最多傳入裝置名稱50個。如果傳入該參數，則無需傳入PageSize和CurrentPage。如果您同時傳入DeviceNames.N、PageSize和CurrentPage，則以DeviceNames.N為準。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
CurrentPage	Integer	1	當前頁碼。
Data	Array of SimpleOTATaskInfo		調用成功時，返回的裝置升級作業資訊。更多資訊，請參見SimpleOTATaskInfo下的參數。
SimpleOTATaskInfo
DestVersion	String	1.0.1	升級的目標OTA升級包版本。
DeviceName	String	testDevice2	裝置名稱。
FirmwareId	String	q3j9OYBjUAZMv1hlMgdo03****	升級包ID。
IotId	String	nadRdeffljdEndlfadgadfse****	裝置ID。
JobId	String	7glPHmaDYLAYMD1HHutT02****	升級批次ID。
ProductKey	String	a1GUfrM****	裝置所屬產品的ProductKey。
ProductName	String	MyProduct	裝置所屬產品的名稱。
Progress	String	0.00	當前的升級進度。
SrcVersion	String	1.0.0	裝置的原韌體版本。
TaskDesc	String	report version is not conform	升級作業描述資訊。當裝置升級逾時、升級作業被取消等情境下，該參數承載具體的錯誤資訊。
TaskId	String	y3tOmCDNgpR8F9jnVEzC01****	裝置升級作業ID。
TaskStatus	String	FAILED	裝置升級狀態。 CONFIRM：待確認。 QUEUED：待推送。 NOTIFIED：已推送。 IN_PROGRESS：升級中。 SUCCEEDED：升級成功。 FAILED：升級失敗。 CANCELED：已取消。
Timeout	String	1440	裝置升級逾時時間，單位是分鐘。說明如果發起批量升級未設定逾時時間，該參數傳回值為空白。
UtcCreate	String	2019-11-04T03:38:22.000Z	升級作業建立時的時間，UTC格式。
UtcModified	String	2019-11-04T03:38:22.000Z	升級作業最後一次修改時的時間，UTC格式。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
PageCount	Integer	1	總頁數。
PageSize	Integer	10	每頁顯示的裝置升級作業數量。
RequestId	String	A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。
Total	Integer	2	裝置升級作業數量總計。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTATaskByJob
&JobId=7glPHmaDYLAYMD1HHutT02****
&PageSize=10
&CurrentPage=1
&<公用請求參數>

正常返回樣本

XML格式

<ListOTATaskByJobResponse>
  <PageCount>1</PageCount>
  <Data>
        <SimpleOTATaskInfo>
              <SrcVersion>1.0.0</SrcVersion>
              <DeviceName>testDevice1</DeviceName>
              <FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
              <IotId>SR8FiTu1R9tlUR2V1bmi00105****</IotId>
              <ProductKey>a1GUfrM****</ProductKey>
              <JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
              <TaskDesc>report version is not conform</TaskDesc>
              <DestVersion>1.0.1</DestVersion>
              <Timeout>1440</Timeout>
              <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>a1GUfrM****</ProductKey>
              <JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
              <TaskDesc></TaskDesc>
              <DestVersion>1.0.1</DestVersion>
              <Timeout>1000</Timeout>
              <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>
  <CurrentPage>1</CurrentPage>
  <Success>true</Success>
  <Total>2</Total>
</ListOTATaskByJobResponse>

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",
      "Timeout":"1440",
      "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",
      "Timeout":"1000",
      "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
}

錯誤碼

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