调用该接口查询阿里云账号下的任务列表。
QPS限制
单个阿里云账号调用该接口的每秒请求数(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。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。
实例的更多信息,请参见实例概述。 |
Status | String | 否 | IN_PROGRESS |
任务状态。取值范围:
|
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
示例
请求示例
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>
<ScheduledTime>1557062301656</ScheduledTime>
<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>
<ScheduledTime>1557064501656</ScheduledTime>
<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",
"ScheduledTime": 1557062301656,
"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",
"ScheduledTime": 1557064501656,
"Description": "TestDescription",
"UtcCreate": "2019-05-21T11:45:37.000Z",
"JobName": "MyTestJobOEfwJN",
"UtcModified": "2019-05-21T17:15:46.000Z",
"JobId": "Z20nyanW5***010001"
}]
},
"Success": true
}
错误码
访问错误中心查看更多错误码。