Creates a task to verify an over-the-air (OTA) update package.
Usage notes
- You must verify an update package before you push the package to devices for a batch update. Only verified update packages can be used to update devices in batches. You can call the QueryOTAFirmware operation to view the status of a verification task.
- You cannot initiate a verification task for an update package that is being verified or has been verified.
- You can specify a maximum of 10 devices for a verification task.
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 | CreateOTAVerifyJob |
The operation that you want to perform. Set the value to CreateOTAVerifyJob. |
FirmwareId | String | Yes | nx3xxVvFdwvn6dim50PY03**** |
The ID of the update package. The FirmwareId parameter is returned when you call the CreateOTAFirmware operation to create an OTA update package. You can call the ListOTAFirmware operation and view the update package ID in the response. |
ProductKey | String | Yes | a1VJwBw**** |
The ProductKey of the product to which the OTA update package belongs. |
Tag.N.Key | String | Yes | key1 |
The key of the update batch tag. The key must be 1 to 30 characters in length and can contain letters, digits, and periods (.). You can add up to 10 tags for each update batch. The tags of an update batch are sent to devices when IoT Platform pushes update notifications to these devices. Note Update batch tags are optional. If you want to specify a tag, you must specify the
Tag.N.Value and Tag.N.Key parameters in pair.
|
Tag.N.Value | String | Yes | value1 |
The value of the update batch tag. The value must be 1 to 1,024 characters in length. You can add up to 10 tags for each update batch. The total tag keys and values cannot exceed 4,096 characters in length. Note Update batch tags are optional. If you want to specify a tag, you must specify the
Tag.N.Value and Tag.N.Key parameters in pair.
|
TargetDeviceName.N | RepeatList | Yes | testdevice |
The list of devices to be verified. Note
|
IotInstanceId | String | No | iot_instc_pu****_c*-v64******** |
The ID of the instance. You can view the instance ID on the Overview page in the IoT Platform console. Notice
For more information, see Overview. |
TimeoutInMinutes | Integer | No | 1440 |
The timeout period for a device to update the firmware. Unit: minutes. Valid values: 1 to 1440. |
NeedPush | Boolean | No | true |
Specifies whether to automatically push update tasks from IoT Platform to devices.
|
NeedConfirm | Boolean | No | false |
Specifies whether to control the update by using a mobile app. You must develop the mobile app as needed.
|
DownloadProtocol | String | No | HTTPS |
The download protocol of the update package. Valid values: HTTPS and MQTT. Default value: HTTPS. After the device receives the update package information pushed by IoT Platform, this protocol is used to download the update package. Notice If you need to download the update package over MQTT, take note of the following items:
|
In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information, see Common request 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 task information returned if the call is successful. For more information, see the following parameters. |
|
JobId | String | wahVIzGkCMuAUE2gDERM02**** |
The ID of the verification task. |
UtcCreate | String | 2019-11-04T06:22:19.566Z |
The time when the verification task was created. The time is displayed in UTC. |
ErrorMessage | String | A system exception occurred. |
The error message returned if the call fails. |
RequestId | String | 29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1 |
The ID of the request. |
Success | Boolean | true |
Indicates whether the call was successful.
|
Examples
Sample requests
https://iot.cn-shanghai.aliyuncs.com/?Action=CreateOTAVerifyJob
&FirmwareId=nx3xxVvFdwvn6dim50PY03****
&ProductKey=a1VJwBw****
&TargetDeviceNames.1=testdevice
&TimeoutInMinutes=1440
&<Common request parameters>
Sample success responses
XML
format
<CreateOTAVerifyJobResponse>
<Data>
<JobId>wahVIzGkCMuAUE2gDERM02****</JobId>
<UtcCreate>2019-11-04T06:22:19.566Z</UtcCreate>
</Data>
<RequestId>29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1</RequestId>
<Success>true</Success>
</CreateOTAVerifyJobResponse>
JSON
format
{
"Data": {
"JobId": "wahVIzGkCMuAUE2gDERM02****",
"UtcCreate": "2019-11-04T06:22:19.566Z"
},
"RequestId": "29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1",
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.