Creates a firmware verification task.

Limits

  • You must verify a firmware file before you push the file to devices for a batch update. Only verified firmware can be used to update devices in batches. You can call the QueryOTAFirmware operation to view the status of the firmware verification.
  • You cannot initiate a verification task for a firmware file that is being verified or has been verified.
  • You can specify a maximum of 10 devices for a firmware verification task.
  • Each Alibaba Cloud account can run a maximum of 10 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 CreateOTAVerifyJob

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

FirmwareId String Yes nx3xxVvFdwvn6dim50PY03****

The ID of the firmware.

A firmware ID is returned when you call the CreateOTAFirmware operation to create a firmware file.

You can call the ListOTAFirmware operation and view the firmware ID in the response.

ProductKey String Yes a1VJwBw****

The ProductKey of the product to which the firmware belongs.

TargetDeviceName.N RepeatList Yes testdevice

The list of devices to be verified.

Note
  • The devices in the list must belong to the same product as the firmware.
  • Device names must be unique.
  • You can specify a maximum of 10 devices.
IotInstanceId String No iot_instc_pu****_c*-v64********

The ID of the instance. This parameter is not required for the public instance but required for Enterprise Edition instances.

TimeoutInMinutes Integer No 1440

The timeout period for a device to update the firmware. Unit: minutes. Valid values: 1 to 1440.

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 task information returned if the call is successful. For more information, see the following parameters.

JobId String wahVIzGkCMuAUE2gDERM02****

The ID of the firmware verification task.

UtcCreate String 2019-11-04T06:22:19.566Z

The time when the firmware 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.

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

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.