调用该接口查询指定任务下的作业。

使用说明

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

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

调试

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

请求参数

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

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

TaskId String MSnT9***q010101

任务下作业的ID。

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

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

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

返回数据

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

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

Data Struct

调用成功时,返回的作业详情,请参见以下参数说明。

DeviceName String mydevice

设备名称。

IotId String BDjhI****01

物联网平台为该设备颁发的ID,作为该设备的唯一标识符。

JobId String sGWotgRkutxX*****

作业所属任务的ID。

JobName String MyTestJobIax6Eq

作业所属任务的名称。

Message String this is message about task execution

任务执行的相关信息,例如执行的错误信息。

ProductKey String a1S****

设备所属产品的ProductKey。

Progress String 80

作业的进度。

Status String SUCCEEDED

作业的状态。

  • QUEUED:待调度。
  • SENT:已调度。
  • IN_PROGRESS:执行中。
  • FAILED:失败。
  • REJECTED:已拒绝。
  • TIMED_OUT:已超时。
  • SUCCEEDED:已成功。
  • CANCELLED:已取消。
StatusDetail String { "msg":"this is message reported by device" }

任务作业执行过程中设备上报的信息。

TaskId String MSnT9***q010101

作业ID。作业的全局唯一标识符。

UtcModified String 2019-05-21T13:03:56.000Z

作业信息的修改时间。

UtcQueueTime String 2019-05-21T13:03:53.000Z

作业的排队时间。

ErrorMessage String 系统异常

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

RequestId String 512FF8FD-A97F-4AAF-B0A2-7BE3D3A19BB3

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

Success Boolean true

表示是否调用成功。

  • true:调用成功。
  • false:调用失败。

示例

请求示例

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
}