调用该接口查询指定任务或指定设备下的作业列表。

使用说明

  • 如果在企业版实例中调用该接口,请求参数IotInstanceId必须填写。否则,调用接口会失败。
  • 单阿里云账号调用该接口的每秒请求数(QPS)最大限制为5。
    说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListTask

系统规定参数。取值:ListTask。

Limit Integer 10

每页显示的记录数。默认值为10,最大值为50。

IotInstanceId String iot-cn-0pp1n8t****

实例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。IotIdProductKeyDeviceName不可同时为空。

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
}