调用该接口获取设备分发任务的详细信息。

使用说明

  • 调用云服务的接入地址Endpoint仅支持华东2（上海），即iot.cn-shanghai.aliyuncs.com。
  • 单阿里云账号调用该接口的每秒请求数（QPS）最大限制为10。
    说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

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

系统规定参数。取值：QueryDeviceDistributeJob。
JobId String 是 UbmsMHmkqv0PiAG****010001

分发任务ID。任务的全局唯一标识符。

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

返回数据

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

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

Data Struct

调用成功后，返回的设备分发任务详情。
GmtCreate Long 1581595942000

分发任务的创建时间。
JobId String UbmsMHmkqv0PiAG****010001

分发任务的ID。
ProductKey String a1BwAGV****

设备所属产品的ProductKey。

SourceInstanceId String iot-cn-6ja***

源实例ID。
SourceUid String 198***

阿里云账号ID。
Status Integer 1

分发任务状态。

  • 0：任务初始化。
  • 1：任务执行中。
  • 2：任务完成。该状态仅表示分发任务执行完成，不表示所有产品和设备都分发成功。获取分发结果详情，请调用QueryDeviceDistributeDetail。
  • 3：任务异常中断。
Strategy Integer 0

分发策略。

  • 0：指定地域，将设备分发到指定地域的指定实例。
  • 1：就近接入，配置了多个地域的实例ID，设备将根据设备的IP位置动态接入其中距离最近的地域。
TargetInstanceConfigs Array of targetInstanceConfigs

目标实例ID列表。

  • 当参数Strategy为1时，列表可有多个实例ID。
  • 当参数Strategy为0时，列表有一个实例ID。
targetInstanceConfigs
TargetInstanceId String iot-cn-6ja***

目标实例ID。
TargetUid String 198***

阿里云账号ID。
Total Integer 5

分发任务中的设备总数。
ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

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

表示是否调用成功。

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

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceDistributeJob
&JobId=UbmsMHmkqv0PiAG****010001
&<公共请求参数>

正常返回示例

XML 格式 

<QueryDeviceDistributeJobResponse>
  <RequestId> E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Status>1</Status>
        <GmtCreate>1581595942000</GmtCreate>
        <SourceUid>198***</SourceUid>
        <Total>5</Total>
        <Strategy>0</Strategy>
        <TargetUid>198***</TargetUid>
        <SourceInstanceId>iot-cn-6ja***</SourceInstanceId>
        <TargetInstanceConfigs>
              <targetInstanceConfigs>
                    <TargetInstanceId>iot-cn-6ja***</TargetInstanceId>
              </targetInstanceConfigs>
        </TargetInstanceConfigs>
        <ProductKey>a1BwAGV****</ProductKey>
        <JobId>UbmsMHmkqv0PiAG****010001</JobId>
  </Data>
  <Success>true</Success>
</QueryDeviceDistributeJobResponse>

JSON 格式 

{
	"RequestId": " E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
	"Data": {
		"Status": "1",
		"GmtCreate": "1581595942000",
		"SourceUid": "198***",
		"Total": "5",
		"Strategy": "0",
		"TargetUid": "198***",
		"SourceInstanceId": "iot-cn-6ja***",
		"TargetInstanceConfigs": {
			"targetInstanceConfigs": [{
				"TargetInstanceId": "iot-cn-6ja***"
			}]
		},
		"ProductKey": "a1BwAGV****",
		"JobId": "UbmsMHmkqv0PiAG****010001"
	},
	"Success": "true"
}

错误码

访问错误中心查看更多错误码。