Create a firmware verification job.

Limits

You must complete firmware verification before pushing the firmware to devices for batch updates. Only verified firmware can be used to update devices in batches. You can call the QueryOTAFirmware operation to view the firmware verification status.

This operation has the following limits:

  • You cannot initiate another verification job for a firmware that is being verified or has been verified.
  • A maximum of 10 devices can be specified for a firmware verification job.
  • The maximum number of queries per second (QPS) for a single Alibaba Cloud account to call this operation is 10. The quota is shared between the Alibaba Cloud account and RAM users.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to CreateOTAVerifyJob.
ProductKey String Yes The key of the product to which the firmware belongs.
FirmwareId String Yes The firmware ID. It is the unique identifier of the firmware.

The firmware ID is a response parameter that is returned by the CreateOTAFirmware operation.

You can call the ListOTAFirmware operation to check the firmware ID.

TargetDeviceNames List<String> Yes The list of devices that are used for firmware verification.
Note
  • The devices in the list must belong to the same product as the firmware.
  • The list cannot contain duplicate device names.
  • The list can contain up to 10 device names.
TimeoutInMinutes Integer No The timeout period for a device to update the firmware. Unit: minutes. Valid values: 1 to 1,440.
IotInstanceId String No The ID of your IoT Platform instance. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased.
Common request parameters N/A Yes For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Description
RequestId String The globally unique ID that is generated by Alibaba Cloud for the request.
Success Boolean Indicates whether the call is successful. true indicates that the call was successful. false indicates that the call failed.
ErrorMessage String The error message returned if the call fails.
Code String The error code returned if the call fails. For more information about error codes, see Error codes.
Data Data The job information returned when the call is successful. For more information, see the following table Data.
Table 1. Data
Parameter Type Description
JobId String The ID for the firmware verification job.
UtcCreate String The time when the firmware verification job was created in UTC.

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

  • JSON format
    {
      "Data": {
        "JobId": "wahVIzGkCMuAUE2gDERM02****",
        "UtcCreate": "2019-11-04T06:22:19.566Z"
      },
      "RequestId": "29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1",
      "Success": true
    }
  • XML format
    <? xml version="1.0" encoding="utf-8"? >
    <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>