ListTask查詢指定任務或裝置的作業列表-物聯網平台-阿里雲

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ListTask	系統規定參數。取值：ListTask。
Limit	Integer	是	10	每頁顯示的記錄數。預設值為10，最大值為50。
IotInstanceId	String	否	iot-cn-0pp1n8t****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
JobId	String	否	sGWotgRk***010001	任務ID。任務的通用唯一識別碼。說明如果傳入Device參數，此參數不傳。
NextToken	String	否	22dhgg***	下一頁標識。首次查詢可不傳入值。如果存在下一頁，服務會返回NextToken值，下次請求時傳入。 NextToken值有效時間為1分鐘。失效後，將返回對應的錯誤碼。
Device	Json	否	{}	裝置資訊。更多資訊，請參見下文“Device定義”。說明如果傳入JobId參數，此參數不傳。
Status	String	否	QUEUED	任務作業的狀態。取值範圍： QUEUED：待調度。 SENT：已調度。 IN_PROGRESS：執行中。 FAILED：失敗。 REJECTED：已拒絕。 TIMED_OUT：已逾時。 SUCCEEDED：已成功。 CANCELLED：已取消。

Device定義

名稱	類型	描述
IotId	String	裝置ID。IotId、ProductKey、DeviceName不可同時為空白。
ProductKey	String	裝置所屬產品的ProductKey。如果傳入該參數，需同時傳入DeviceName。
DeviceName	String	裝置名稱。如果傳入該參數，需同時傳入ProductKey。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Array of data		調用成功時，返回任務下作業詳情，請參見以下參數說明。
data
DeviceName	String	mydevice	裝置名稱。
IotId	String	BDjhIC***i000101	物聯網平台為該裝置頒發的ID，作為該裝置的唯一識別碼。
JobId	String	sGWotg***010001	任務ID。任務的通用唯一識別碼。
JobName	String	MyTestJobIax6Eq	任務名稱。
ProductKey	String	a1S0OM***	裝置所屬產品的ProductKey。
Progress	String	80	任務下作業執行進度。
Status	String	SUCCEEDED	任務作業的狀態。 QUEUED：待調度。 SENT：已調度。 IN_PROGRESS：執行中。 FAILED：失敗。 REJECTED：已拒絕。 TIMED_OUT：已逾時。 SUCCEEDED：成功。 CANCELLED：已取消。
TaskId	String	MSnT9wl***q010101	任務下作業的ID。作業的通用唯一識別碼。
UtcModified	String	2019-05-21T13:03:56.000Z	作業資訊的修改時間。
UtcQueueTime	String	2019-05-21T13:03:53.000Z	作業的排隊時間。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
NextToken	String	223sdf***	下一頁標識。如果存在下一頁，服務會返回NextToken值，下次請求時傳入。 NextToken值有效時間為1分鐘。失效後，將返回對應的錯誤碼。
RequestId	String	512FF8FD-A97F-4AAF-B0A2-7BE3D3A19BB3	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListTask
&Limit=10
&JobId=XUbmsMHmkqv0PiAG****010001
&<公用請求參數>

正常返回樣本

XML格式

<ListTaskResponse>
  <NextToken>223sdf***</NextToken>
  <RequestId>512FF8FD-A97F-4AAF-B0A2-7BE3D3A19BB3</RequestId>
  <Data>
        <data>
              <Status>SUCCEEDED</Status>
              <IotId>BDjhIC***i000101</IotId>
              <Progress>80</Progress>
              <TaskId>MSnT9wl***q010101</TaskId>
              <JobName>MyTestJobIax6Eq</JobName>
              <UtcModified>2019-05-21T13:03:56.000Z</UtcModified>
              <UtcQueueTime>2019-05-21T13:03:53.000Z</UtcQueueTime>
              <ProductKey>a1S0OM***</ProductKey>
              <JobId>sGWotg***010001</JobId>
              <DeviceName>mydevice</DeviceName>
        </data>
  </Data>
  <Success>true</Success>
</ListTaskResponse>

JSON格式

{
    "NextToken": "223sdf***",
    "RequestId": "512FF8FD-A97F-4AAF-B0A2-7BE3D3A19BB3",
    "Data": {
        "data": {
            "Status": "SUCCEEDED",
            "IotId": "BDjhIC***i000101",
            "Progress": 80,
            "TaskId": "MSnT9wl***q010101",
            "JobName": "MyTestJobIax6Eq",
            "UtcModified": "2019-05-21T13:03:56.000Z",
            "UtcQueueTime": "2019-05-21T13:03:53.000Z",
            "ProductKey": "a1S0OM***",
            "JobId": "sGWotg***010001",
            "DeviceName": "mydevice"
        }
    },
    "Success": true
}

錯誤碼

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