Queries all the update batches of a device by update package.
Limits
Each Alibaba Cloud account can run a maximum of 10 queries per second (QPS).
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListOTAJobByDevice |
The operation that you want to perform. Set the value to ListOTAJobByDevice. |
CurrentPage | Integer | Yes | 1 |
The number of the page to return. Pages start from page 1. |
DeviceName | String | Yes | light1 |
The name of the device. |
FirmwareId | String | Yes | FJFx8JzpnhpIsKftRjjm03**** |
The ID of the update package. The ID is the unique identifier for the update package. An update package ID is returned when you call the CreateOTAFirmware API operation to create the update package. You can call the ListOTAFirmware API operation to view the update package ID in the response. |
PageSize | Integer | Yes | 10 |
The number of entries to return on each page. Maximum value: 100. |
ProductKey | String | Yes | a19mzPZ**** |
The key of the product to which the device belongs. |
IotInstanceId | String | No | iot-cn-0pp1n8t**** |
The instance ID. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased. |
In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this API operation. For more information, see Common request parameters.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | MissingFirmwareId |
The error code returned if the call fails. For more information about error codes, see Error codes. |
CurrentPage | Integer | 1 |
The page number of the returned page. |
Data | Array of SimpleOTAJobInfo |
The update batch information that is returned if the call succeeds. For more information, see the following SimpleOTAJobInfo parameter. |
|
SimpleOTAJobInfo | |||
FirmwareId | String | FJFx8JzpnhpIsKftRjjm03**** |
The ID of the update package. |
JobId | String | HvKuBpuk3rdk6E92CP**** |
The ID of the update batch. |
JobStatus | String | COMPLETED |
The status of the update batch. Valid values:
|
JobType | String | UPGRADE_FIRMWARE |
The type of the update batch. Valid values:
|
ProductKey | String | a19mzPZ**** |
The key of the product to which the update package belongs. The product key is the unique identifier for the product. |
SelectionType | String | STATIC |
The update policy of the update batch. Valid value:
|
Tags | Array of OtaTagDTO |
The tags of the update batch. |
|
OtaTagDTO | |||
Key | String | key1 |
The name of each tag. |
Value | String | value1 |
The value of the tag. |
TargetSelection | String | ALL |
The scope of the update batch. Valid values:
Note The value ALL is returned when you call the CreateOTADynamicUpgradeJob API operation to create a dynamic update batch.
|
UtcCreate | String | 2019-12-28T02:43:10.000Z |
The time when the update batch was created. The time is in the UTC format. |
UtcEndTime | String | 2019-12-29T02:43:10.000Z |
The end time of the update batch. The time is in the UTC format. Note This parameter is returned only if the update batch is completed.
|
UtcModified | String | 2019-12-29T02:43:10.000Z |
The last modification time of the update batch. The time is in the UTC format. |
UtcStartTime | String | 2019-12-29T02:43:10.000Z |
The start time of the update batch. The time is in the UTC format. |
ErrorMessage | String | FirmwareId is mandatory for this action |
The error message returned if the call fails. |
PageCount | Integer | 1 |
The total number of pages returned. |
PageSize | Integer | 10 |
The number of entries returned per page. |
RequestId | String | A01829CE-75A1-4920-B775-921146A1AB79 |
The globally unique ID that Alibaba Cloud generates for the request. |
Success | Boolean | true |
Indicates whether the call succeeds. true indicates that the call succeeded. false indicates that the call failed. |
Total | Integer | 1 |
The total number of update packages returned. |
Examples
Sample requests
https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAJobByDevice
&FirmwareId=FJFx8JzpnhpIsKftRjjm03****
&ProductKey=a19mzPZ****
&DeviceName=light
&PageSize=10
&CurrentPage=1
&Common request parameters
Sample success responses
XML
format
<ListOTAJobByDeviceResponse>
<PageCount>1</PageCount>
<Data>
<SimpleOTAJobInfo>
<SelectionType>STATIC</SelectionType>
<TargetSelection>SPECIFIC</TargetSelection>
<JobType>UPGRADE_FIRMWARE</JobType>
<FirmwareId>FJFx8JzpnhpIsKftRjjm03****</FirmwareId>
<UtcStartTime>2019-12-28T02:43:10.000Z</UtcStartTime>
<ProductKey>a19mzPZ****</ProductKey>
<JobId>HvKuBpuk3rdk6E92CPQN02****</JobId>
<UtcModified>2019-12-28T02:43:10.000Z</UtcModified>
<JobStatus>IN_PROGRESS</JobStatus>
<UtcCreate>2019-12-28T02:43:10.000Z</UtcCreate>
</SimpleOTAJobInfo>
</Data>
<PageSize>10</PageSize>
<RequestId>5D58AC86-D5BF-4B39-834E-913E7F2C985D</RequestId>
<CurrentPage>1</CurrentPage>
<Success>true</Success>
<Total>1</Total>
</ListOTAJobByDeviceResponse>
JSON
format
{
"PageCount": 1,
"Data": {
"SimpleOTAJobInfo": [{
"SelectionType": "STATIC",
"TargetSelection": "SPECIFIC",
"JobType": "UPGRADE_FIRMWARE",
"FirmwareId": "FJFx8JzpnhpIsKftRjjm03****",
"UtcStartTime": "2019-12-28T02:43:10.000Z",
"ProductKey": "a19mzPZ****",
"JobId": "HvKuBpuk3rdk6E92CPQN02****",
"UtcModified": "2019-12-28T02:43:10.000Z",
"JobStatus": "IN_PROGRESS",
"UtcCreate": "2019-12-28T02:43:10.000Z"
}]
},
"PageSize": 10,
"RequestId": "5D58AC86-D5BF-4B39-834E-913E7F2C985D",
"CurrentPage": 1,
"Success": true,
"Total": 1
}
Error codes
For a list of error codes, visit the API Error Center.