调用该接口查询指定任务下的作业。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为5。
RAM用户共享阿里云账号配额。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QueryTask |
系统规定参数。取值:QueryTask。 |
TaskId | String | 是 | MSnT9***q010101 |
任务下作业的ID。 |
IotInstanceId | String | 否 | iot-cn-0pp1n8t**** |
实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。
实例的更多信息,请参见实例概述。 |
用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
示例
请求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryTask
&TaskId=MSnT9***q010101
&<公共请求参数>
正常返回示例
XML
格式
<QueryTaskResponse>
<RequestId>512FF8FD-A97F-4AAF-B0A2-7BE3D3A19BB3</RequestId>
<Data>
<Status>SUCCEEDED</Status>
<Progress>80</Progress>
<TaskId>MSnT9***q010101</TaskId>
<Message>this is message about task execution</Message>
<JobName>MyTestJobIax6Eq</JobName>
<IotId>BDjhI****01</IotId>
<StatusDetail>{ "msg":"this is message reported by device" }</StatusDetail>
<UtcModified>2019-05-21T13:03:56.000Z</UtcModified>
<UtcQueueTime>2019-05-21T13:03:53.000Z</UtcQueueTime>
<ProductKey>a1S****</ProductKey>
<JobId>sGWotgRkutxX*****</JobId>
<DeviceName>mydevice</DeviceName>
</Data>
<Success>true</Success>
</QueryTaskResponse>
JSON
格式
{
"RequestId": "512FF8FD-A97F-4AAF-B0A2-7BE3D3A19BB3",
"Data": {
"Status": "SUCCEEDED",
"Progress": 80,
"TaskId": "MSnT9***q010101",
"Message": "this is message about task execution",
"JobName": "MyTestJobIax6Eq",
"IotId": "BDjhI****01",
"StatusDetail": "{ \"msg\":\"this is message reported by device\" }",
"UtcModified": "2019-05-21T13:03:56.000Z",
"UtcQueueTime": "2019-05-21T13:03:53.000Z",
"ProductKey": "a1S****",
"JobId": "sGWotgRkutxX*****",
"DeviceName": "mydevice"
},
"Success": true
}
错误码
访问错误中心查看更多错误码。