調用該接口查詢任務詳情。

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
}