调用该接口查询任务详情。

QPS限制

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

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

调试

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

请求参数

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

系统规定参数。取值：QueryJob。
JobId String 是 450407b***

任务ID。任务的全局唯一标识符。
IotInstanceId String 否 iot-cn-0pp1n8t****

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

重要
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无ID值，则无需传入。

实例的更多信息，请参见实例概述。

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

返回数据

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

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

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

任务的描述信息。
JobDocument String { "serviceIdentifier": "test_service", "params": { "key1": "value1", "key2": "value2" } }

下发给设备的任务执行规则文件
JobFile Struct

任务文件的下载信息。
FileUrl String https://iotx-***.oss-cn-shanghai.aliyuncs.com/job***/7u***.sh?Expires=16***&OSSAccessKeyId=LTA***&Signature=TTTejn***

任务文件的下载地址，地址有效时间为30分钟。
Sign String TTTejn***

签名，通过URL上传的文件，根据相应的签名方法生成的签名参数。
SignMethod String SHA256

签名方法，可取值MD5和SHA256。
JobId String 450407b***

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

任务名称。
RolloutConfig Struct

任务下作业推送速率配置。
MaximumPerMinute Integer 10

任务下每分钟作业推送数量。
MessageQoS String Qos1

发送消息类型，仅对自定义任务和Pub批量消息推送任务包含该参数。可取值：

  • QoS0，表示最多发送一次。
  • QoS1，表示最少发送一次。如果QoS1消息未接收到PUBACK消息，会在设备重连时，重新推送给设备。
ScheduledTime Long 1557062301656

任务调度时间的毫秒数。
Status String CANCELLED

任务状态。取值范围：

  • INITIALIZING：初始化。
  • WAITING：待调度。
  • IN_PROGRESS：执行中。
  • COMPLETED：已完成。
  • CANCELLING：取消中。
  • CANCELLED：已取消。
  • REMOVING：删除中。
  • TIMED_OUT：已超时。
TargetConfig Struct

设备任务的目标设备配置。
TargetDevices Array of targetDevices

目标设备列表。
targetDevices
DeviceName String a1Ix***

设备名称。
ProductKey String nCwfSBzc***

设备所属产品的ProductKey。
TargetGroup String 1234

目标设备所属设备分组的标识符（GroupID）。
TargetProduct String nCwfSBzc***

目标设备所属产品的ProductKey。
TargetType String DEVICE_LIST

目标设备的配置类型，取值：

  • DEVICE_LIST：设备列表。
  • GROUP_ID：设备分组ID。
  • PRODUCT_KEY：产品ProductKey。
TimeoutConfig Struct

任务下作业执行的超时配置
InProgressTimeoutInMinutes Integer 5

任务下作业执行的超时时间，单位为分钟。
Type String SET_PROPERTY

任务类型。取值：

  • INVOKE_SERVICE：设备批量服务调用任务。
  • SET_PROPERTY：设备批量属性设置任务。
  • PUB：Pub批量消息推送任务。
  • CUSTOM_JOB：自定义任务。
UtcCreate String 2020-12-13T04:09:51.000Z

任务创建时间。
UtcModified String 2020-12-13T04:10:00.000Z

任务信息修改时间。
ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String A6BEAB33-03E6-4CE0-A94F-9E24C5512BAD

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

表示是否调用成功。

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

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryJob
&JobId=XUbmsMHmkqv0PiAG****010001
&公共请求参数

正常返回示例

XML格式

<QueryJobResponse>
    <RequestId>A6BEAB33-03E6-4CE0-A94F-9E24C5512BAD</RequestId>
    <Data>
            <Status>CANCELLED</Status>
		    <ScheduledTime>1557062301656</ScheduledTime>
            <Type>SET_PROPERTY</Type>
            <TimeoutConfig>
                    <InProgressTimeoutInMinutes>5</InProgressTimeoutInMinutes>
            </TimeoutConfig>
            <Description>jobDescription</Description>
            <UtcCreate>2020-12-13T04:09:51.000Z</UtcCreate>
            <JobFile>
                    <FileUrl>https://iotx-***.oss-cn-shanghai.aliyuncs.com/job***/7u***.sh?Expires=16***&amp;OSSAccessKeyId=LTA***&amp;Signature=TTTejn***</FileUrl>
                    <Sign>1235</Sign>
                    <SignMethod>SHA256</SignMethod>
            </JobFile>
            <JobDocument>{}</JobDocument>
            <JobName>test</JobName>
            <UtcModified>2020-12-13T04:10:00.000Z</UtcModified>
            <JobId>450407b***</JobId>
            <TargetConfig>
                    <TargetDevices>
                            <targetDevices>
                                    <ProductKey>nCwf***</ProductKey>
                                    <DeviceName>a1IxS***</DeviceName>
                            </targetDevices>
                            <targetDevices>
                                    <ProductKey>24VI***</ProductKey>
                                    <DeviceName>a1***</DeviceName>
                            </targetDevices>
                            <targetDevices>
                                    <ProductKey>6NDWQ***</ProductKey>
                                    <DeviceName>a1I***</DeviceName>
                            </targetDevices>
                            <targetDevices>
                                    <ProductKey>EQtTJT***</ProductKey>
                                    <DeviceName>a1IxS***</DeviceName>
                            </targetDevices>
                            <targetDevices>
                                    <ProductKey>rUdc33Vr***</ProductKey>
                                    <DeviceName>a1IxS***</DeviceName>
                            </targetDevices>
                    </TargetDevices>
                    <TargetType>DEVICE_LIST</TargetType>
            </TargetConfig>
    </Data>
    <Success>true</Success>
</QueryJobResponse>

JSON格式

{
    "RequestId": "A6BEAB33-03E6-4CE0-A94F-9E24C5512BAD",
    "Data": {
        "Status": "CANCELLED",
        "ScheduledTime": 1557062301656,
        "Type": "SET_PROPERTY",
        "TimeoutConfig": {
            "InProgressTimeoutInMinutes": 5
        },
        "Description": "jobDescription",
        "UtcCreate": "2020-12-13T04:09:51.000Z",
        "JobFile": {
            "FileUrl": "https://iotx-***.oss-cn-shanghai.aliyuncs.com/job***/7u***.sh?Expires=16***&amp;OSSAccessKeyId=LTA***&amp;Signature=TTTejn***",
            "Sign": "1235",
            "SignMethod": "SHA256"
        },
        "JobDocument": "{}",
        "JobName": "test",
        "UtcModified": "2020-12-13T04:10:00.000Z",
        "JobId": "450407b***",
        "TargetConfig": {
            "TargetDevices": {
                "targetDevices": [
                    {
                        "ProductKey": "nCwf***",
                        "DeviceName": "a1IxS***"
                    },
                    {
                        "ProductKey": "24VI***",
                        "DeviceName": "a1***"
                    },
                    {
                        "ProductKey": "6NDWQ***",
                        "DeviceName": "a1I***"
                    },
                    {
                        "ProductKey": "EQtTJT***",
                        "DeviceName": "a1IxS***"
                    },
                    {
                        "ProductKey": "rUdc33Vr***",
                        "DeviceName": "a1IxS***"
                    }
                ]
            },
            "TargetType": "DEVICE_LIST"
        }
    },
    "Success": true
}