Queries the result of a device distribution task.

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 QueryDeviceDistributeDetail

The operation that you want to perform. Set the value to QueryDeviceDistributeDetail.
JobId String Yes UbmsMHmkqv0PiAG****010001

The ID of the distribution task. The ID globally identifies the task.

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.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.
File String https://iotx-***.oss-cn-shanghai.aliyuncs.com/job***/7u***

The URL of the file that contains the distribution result. The URL indicates a storage location of the file in Object Storage Service (OSS). The URL is valid for 10 minutes.

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=QueryDeviceDistributeDetail
&JobId=UbmsMHmkqv0PiAG****010001
&<Common request parameters>

Sample success responses

XML format 

<QueryDeviceDistributeDetailResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <File>https://iotx-***.oss-cn-shanghai.aliyuncs.com/job***/7u***</File>
  <Success>true</Success>
</QueryDeviceDistributeDetailResponse>

JSON format 

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "File": "https://iotx-***.oss-cn-shanghai.aliyuncs.com/job***/7u***",
    "Success": true
}

Error codes

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