调用该接口查询阿里云账号下的任务列表。

使用说明

单阿里云账号调用该接口的每秒请求数(QPS)最大限制为5。

说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

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

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

CurrentPage Integer 1

当前页码。

PageSize Integer 20

每页展示的任务条数。最大值为50。

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

实例ID。公共实例不传此参数,企业版实例需传入。

Status String IN_PROGRESS

任务状态。取值范围:

  • INITIALIZING:初始化。
  • WAITING:待调度。
  • IN_PROGRESS:执行中。
  • COMPLETED:已完成。
  • CANCELLING:取消中。
  • CANCELLED:已取消。
  • REMOVING:删除中。

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时,返回的错误码。更多信息,请参见错误码

Data Array of data

调用成功时,返回的任务详情信息,请参见以下参数说明。

data
Description String TestDescription

任务的描述信息。

JobId String Z20nyanW5****010001

任务ID。任务的全局唯一标识符。

JobName String MyTestJobOEfwJN

任务名称。

Status String COMPLETED

任务状态。

Type String CUSTOM_JOB

任务类型。

UtcCreate String 2019-05-21T11:45:37.000Z

任务创建时间。

UtcModified String 2019-05-21T17:15:46.000Z

任务信息修改时间。

ErrorMessage String 系统异常

调用失败时,返回的出错信息。

Page Integer 1

当前页码。

PageSize Integer 5

当前页面任务条数。

RequestId String BF449394-1C7D-4144-B7C4-9C3FA29F8B64

阿里云为该请求生成的唯一标识符。

Success Boolean true

表示是否调用成功。

  • true:调用成功。
  • false:调用失败。
Total Integer 20

返回的任务总条数。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListJob
&CurrentPage=1
&PageSize=20
&<公共请求参数>

正常返回示例

XML 格式

<ListJobResponse>
  <PageSize>5</PageSize>
  <RequestId>BF449394-1C7D-4144-B7C4-9C3FA29F8B64</RequestId>
  <Total>20</Total>
  <Page>1</Page>
  <Data>
        <data>
              <Status>COMPLETED</Status>
              <Type>CUSTOM_JOB</Type>
              <Description>TestDescription</Description>
              <UtcCreate>2019-05-21T13:03:52.000Z</UtcCreate>
              <JobName>MyTestJobIax6Eq</JobName>
              <UtcModified>2019-05-21T17:39:10.000Z</UtcModified>
              <JobId>sGWotg***4F010001</JobId>
        </data>
        <data>
              <Status>COMPLETED</Status>
              <Type>CUSTOM_JOB</Type>
              <Description>TestDescription</Description>
              <UtcCreate>2019-05-21T11:45:37.000Z</UtcCreate>
              <JobName>MyTestJobOEfwJN</JobName>
              <UtcModified>2019-05-21T17:15:46.000Z</UtcModified>
              <JobId>Z20nyanW5***010001</JobId>
        </data>
  </Data>
  <Success>true</Success>
</ListJobResponse>

JSON 格式

{
    "PageSize": 5,
    "RequestId": "BF449394-1C7D-4144-B7C4-9C3FA29F8B64",
    "Total": 20,
    "Page": 1,
    "Data": {
        "data": [{
        "Status": "COMPLETED",
        "Type": "CUSTOM_JOB",
        "Description": "TestDescription",
        "UtcCreate": "2019-05-21T13:03:52.000Z",
        "JobName": "MyTestJobIax6Eq",
        "UtcModified": "2019-05-21T17:39:10.000Z",
        "JobId": "sGWotg***4F010001"
      }, {
            "Status": "COMPLETED",
            "Type": "CUSTOM_JOB",
            "Description": "TestDescription",
            "UtcCreate": "2019-05-21T11:45:37.000Z",
            "JobName": "MyTestJobOEfwJN",
            "UtcModified": "2019-05-21T17:15:46.000Z",
            "JobId": "Z20nyanW5***010001"
      }]
    },
    "Success": true
}