ListDeviceDistributeJob - 阿里云物联网平台

使用说明

如果在企业版实例中调用该接口，请求参数IotInstanceId必须填写。否则，调用接口会失败。

QPS限制

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

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

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ListDeviceDistributeJob	系统规定参数。取值：ListDeviceDistributeJob。
PageSize	Integer	是	10	每页显示的分发任务数量。最大不超过200条。
TargetUid	String	否	198***	设备分发的目标阿里云账号ID。
CurrentPage	Integer	否	1	指定从返回结果中的第几页开始显示。默认值是1。 NextToken与CurrentPage是设置显示结果的条件参数，可任选一个传入。如果同时传入，则NextToken优先级更高。 NextToken参数的使用说明，请参见NextToken描述。
Status	Integer	否	1	设备分发任务的状态。 0：任务初始化。 1：任务执行中。 2：任务完成。该状态仅表示分发任务执行完成，不表示所有产品和设备都分发成功。获取分发结果详情，请调用QueryDeviceDistributeDetail。 3：任务异常中断。
JobId	String	否	UbmsMHmkqv0PiAG****010001	设备分发任务的ID。任务的全局唯一标识符。
NextToken	String	否	TGlzdFJlc291***	下一页标识，首次查询无需传入。 NextToken与CurrentPage是设置显示结果的条件参数，可任选一个传入。如果同时传入，则NextToken优先级更高。重要定义查询结果的偏移数量为：PageSize×（CurrentPage-1）。当偏移数量大于10,000时，必须传入上一次调用本接口返回的NextToken值，才会返回Data数据。否则，接口请求会被中断，无法返回Data数据。
ProductKey	String	否	aw3zse****	设备所属的产品ProductKey。

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

返回数据


名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。更多信息，请参见错误码。
Data	Struct		调用成功后，返回的设备分发任务列表，详情参见JobInfo下信息。
JobInfo	Array of items		任务的信息。
items
GmtCreate	Long	1581595942000	任务的创建时间。
JobId	String	UbmsMHmkqv0PiAG****010001	任务的ID。
ProductKey	String	a1BwAGV****	设备所属产品的ProductKey。
SourceInstanceId	String	iot-cn-6ja***	源实例ID。
SourceInstanceName	String	实例调试1	源实例名称。
SourceRegion	String	cn-shanghai	源实例所在地域。
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。
TargetInstanceName	String	实例调试2	目标实例名称。
TargetRegion	String	cn-shanghai	目标实例所在地域。
TargetUid	String	198***	目标阿里云账号ID。
Total	Integer	5	分发任务中的设备总数。
NextToken	String	TGlzdFJlc291***	下一页标识。可在下次请求时传入，来获取下一页数据。如果返回值为空，则表示没有下一页数据了。
Total	Integer	10	返回的设备分发任务总条数。
ErrorMessage	String	系统异常	调用失败时，返回的出错信息。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里云为该请求生成的唯一标识符。
Success	Boolean	true	是否调用成功。 true：调用成功。 false：调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListDeviceDistributeJob
&CurrentPage=1
&PageSize=10
&TargetUid=198***
&<公共请求参数>

正常返回示例

XML格式

<ListDeviceDistributeJobResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <NextToken>TGlzdFJlc291***</NextToken>
        <Total>10</Total>
        <JobInfo>
              <items>
                    <Status>1</Status>
                    <SourceInstanceName>实例调试1</SourceInstanceName>
                    <GmtCreate>1581595942000</GmtCreate>
                    <SourceUid>198***</SourceUid>
                    <Total>5</Total>
                    <Strategy>0</Strategy>
                    <TargetUid>198***</TargetUid>
                    <SourceRegion>cn-shanghai</SourceRegion>
                    <SourceInstanceId>iot-cn-6ja***</SourceInstanceId>
                    <ProductKey>a1BwAGV****</ProductKey>
                    <JobId>UbmsMHmkqv0PiAG****010001</JobId>
                    <TargetInstanceConfigs>
                          <targetInstanceConfigs>
                                <TargetRegion>cn-shanghai</TargetRegion>
                                <TargetInstanceName>实例调试2</TargetInstanceName>
                                <TargetInstanceId>iot-cn-6ja***</TargetInstanceId>
                          </targetInstanceConfigs>
                    </TargetInstanceConfigs>
              </items>
        </JobInfo>
  </Data>
  <Success>true</Success>
</ListDeviceDistributeJobResponse>

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "NextToken":"TGlzdFJlc291***",
        "Total": 10,
        "JobInfo": {
            "items": {
                "Status": 1,
                "SourceInstanceName": "实例调试1",
                "GmtCreate": 1581595942000,
                "SourceUid": "198***",
                "Total": 5,
                "Strategy": 0,
                "TargetUid": "198***",
                "SourceRegion": "cn-shanghai",
                "SourceInstanceId": "iot-cn-6ja***",
                "ProductKey": "a1BwAGV****",
                "JobId": "UbmsMHmkqv0PiAG****010001",
                "TargetInstanceConfigs": {
                    "targetInstanceConfigs": {
                        "TargetRegion": "cn-shanghai",
                        "TargetInstanceName": "实例调试2",
                        "TargetInstanceId": "iot-cn-6ja***"
                    }
                }
            }
        }
    },
    "Success": true
}

错误码

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