Queries device distribution tasks.

Usage notes

  • This operation can be called only by using the following endpoint: iot.cn-shanghai.aliyuncs.com.
  • Each Alibaba Cloud account can run a maximum of 5 queries per second (QPS).
    Note RAM users of an Alibaba Cloud account share the quota of the account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListDeviceDistributeJob

The operation that you want to perform. Set the value to ListDeviceDistributeJob.

CurrentPage Integer Yes 1

The number of the page to return. Default value: 1.

PageSize Integer Yes 10

The number of entries to return on each page. Maximum value: 200.

TargetUid String No 198***

The ID of the Alibaba Cloud account.

Status Integer No 1

The status of the distribution task.

  • 0: The task is being initialized.
  • 1: The task is being implemented.
  • 2: The task is completed. This status only indicates that the distribution task is completed. This status does not indicate that all products and devices are distributed. To obtain distribution results, call the QueryDeviceDistributeDetail operation.
  • 3: The task is unexpectedly interrupted.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code returned if the call fails. For more information, see Error codes.

Data Struct

The distribution tasks returned if the call is successful. For more information, see JobInfo.

JobInfo Array of items

The information about the distribution task.

items
GmtCreate Long 1581595942000

The time when the task was created.

JobId String UbmsMHmkqv0PiAG****010001

The ID of the distribution task.

ProductKey String a1BwAGV****

The ProductKey of the product to which the device belongs.

SourceInstanceId String iot-cn-6ja***

The ID of the source instance.

SourceUid String 198***

The ID of the Alibaba Cloud account.

Status Integer 1

The status of the distribution task.

  • 0: The task is being initialized.
  • 1: The task is being implemented.
  • 2: The task is completed. This status only indicates that the distribution task is completed. This status does not indicate that all products and devices are distributed. To obtain distribution results, call the QueryDeviceDistributeDetail operation.
  • 3: The task is unexpectedly interrupted.
Strategy Integer 0

The distribution policy.

  • 0: distributes devices to instances in a specified region.
  • 1: configures instance IDs in multiple regions and distributes devices to the nearest regions based on the IP addresses of the devices.
TargetInstanceConfigs Array of targetInstanceConfigs

The IDs of the destination instances.

  • If the value of the Strategy parameter is 1, multiple instance IDs exist.
  • If the value of the Strategy parameter is 0, only one instance ID exists.
targetInstanceConfigs
TargetInstanceId String iot-cn-6ja***

The ID of the destination instance.

TargetUid String 198***

The ID of the Alibaba Cloud account.

Total Integer 5

The total number of devices in the distribution task.

Total Integer 10

The total number of device distribution tasks.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The call failed.

Examples

Sample requests

http(s)://iot.cn-shanghai.aliyuncs.com/? Action=ListDeviceDistributeJob
&CurrentPage=1
&PageSize=10
&TargetUid=198***
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.