CreateOTAVerifyJob - IoT Platform - Centro de documentación de Alibaba Cloud

Cree una tarea para comprobar un paquete de actualización over-the-air (OTA).

Notas de uso

Antes de enviar un paquete de actualización a los dispositivos para una actualización por lotes, debe comprobar el paquete. Solo los paquetes comprobados se pueden usar en actualizaciones por lotes. Llame a la operación QueryOTAFirmware para consultar el estado de verificación.
No es posible iniciar una tarea de verificación para un paquete de actualización que ya se está verificando o que superó la verificación.
Especifique un máximo de 10 dispositivos para cada tarea de verificación.

Límites de QPS

Cada cuenta puede llamar a esta operación hasta 10 veces por segundo.

Nota

Los usuarios de RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, le recomendamos llamar a esta operación desde OpenAPI Explorer, ya que genera de forma dinámica el código de ejemplo correspondiente a distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	CreateOTAVerifyJob	Operación que desea ejecutar. Establezca el valor en CreateOTAVerifyJob.
FirmwareId	String	Sí	nx3xxVvFdwvn6dim50PY03****	ID del paquete de actualización. El parámetro FirmwareId se devuelve cuando llama a la operación CreateOTAFirmware para crear un paquete de actualización OTA. También puede llamar a la operación ListOTAFirmware para obtener el ID del paquete.
ProductKey	String	Sí	a1VJwBw****	ProductKey del producto al que pertenece el paquete de actualización OTA.
Tag.N.Key	String	Sí	key1	Clave de la etiqueta del lote de actualización. Debe tener entre 1 y 30 caracteres, y puede contener letras, dígitos y puntos (.). Agregue hasta 10 etiquetas por lote de actualización. Las etiquetas del lote de actualización se envían a los dispositivos cuando IoT Platform les envía las notificaciones de actualización. Nota Las etiquetas del lote de actualización son opcionales. Si desea especificar una etiqueta, configure los parámetros Tag.N.Value y Tag.N.Key en conjunto.
Tag.N.Value	String	Sí	value1	Valor de la etiqueta del lote de actualización. Debe tener entre 1 y 1,024 caracteres. Agregue hasta 10 etiquetas por lote de actualización. La longitud total de las claves y los valores de todas las etiquetas no puede superar los 4096 caracteres. Nota Las etiquetas del lote de actualización son opcionales. Si desea especificar una etiqueta, configure los parámetros Tag.N.Value y Tag.N.Key en conjunto.
TargetDeviceName.N	RepeatList	Sí	testdevice	Dispositivo que desea especificar en la tarea de verificación. Nota Los dispositivos deben pertenecer al mismo producto que el paquete de actualización. Cada DeviceName debe ser único. Especifique hasta 10 valores de DeviceName.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID de la instancia de IoT. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, especifíquelo en este parámetro. De lo contrario, la llamada fallará. Si no se generó ninguna página Overview ni ningún ID para su instancia, no es necesario configurar este parámetro. Para obtener más información, consulte Descripción general.
TimeoutInMinutes	Integer	No.	1440	Tiempo de espera para que un dispositivo actualice el firmware, en minutos. Valores válidos: de 1 a 1440.
NeedPush	Boolean	No	true	Indica si las tareas de actualización se envían automáticamente a los dispositivos. Valores válidos: true (predeterminado): después de crear un lote de actualización, IoT Platform envía automáticamente las tareas de actualización a los dispositivos en línea especificados. En este caso, el dispositivo aún puede iniciar una solicitud para obtener información sobre la tarea de actualización OTA desde IoT Platform. false: el dispositivo debe iniciar una solicitud para obtener información sobre la tarea de actualización OTA desde IoT Platform.
NeedConfirm	Boolean	No	false	Indica si la actualización requiere confirmación mediante una aplicación móvil. Desarrolle la aplicación móvil según sus necesidades de negocio. Valores válidos: false (predeterminado): el dispositivo obtiene la información de la tarea de actualización OTA según el valor del parámetro NeedPush. true: para aplicar una actualización OTA a un dispositivo, confirme la actualización desde su aplicación móvil. Después, el dispositivo obtendrá la información de la tarea de actualización OTA según el valor del parámetro NeedPush.
DownloadProtocol	String	No	HTTPS	Protocolo que usan los dispositivos para descargar el paquete de actualización. Valores válidos: HTTPS y MQTT. Valor predeterminado: HTTPS. Importante Si descarga el paquete de actualización mediante HTTPS, el tamaño máximo del archivo es de 1,000 MB. Formatos de archivo compatibles: `.bin`, `.dav`, `.tar`, `.gz`, `.zip`, `.gzip`, `.apk`, `.tar.gz`, `.tar.xz` o `.pack`. Para obtener más información sobre los límites, consulte Descripción general de la actualización OTA. Si desea descargar el paquete de actualización mediante MQTT, tenga en cuenta lo siguiente: Regiones compatibles: China (Shanghai), China (Beijing) y China (Shenzhen). El paquete de actualización OTA solo puede contener un archivo y su tamaño no puede superar los 16 MB. Use la versión más reciente de Link SDK for C para desarrollar las funciones del dispositivo que ejecutan las actualizaciones OTA y descargan archivos mediante MQTT. Para obtener más información, consulte Código de ejemplo para descargar un paquete de actualización OTA con un solo archivo mediante MQTT.

Además de los parámetros de solicitud específicos de esta operación, debe especificar los parámetros de solicitud comunes al llamarla. Para obtener más información, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	Código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
Data	Struct		Información de la tarea devuelta si la llamada es exitosa. Para obtener más información, consulte los siguientes parámetros.
JobId	String	wahVIzGkCMuAUE2gDERM02****	ID de la tarea de verificación.
UtcCreate	String	2019-11-04T06:22:19.566Z	Hora en que se creó la tarea de verificación, que se muestra en formato UTC.
ErrorMessage	String	A system exception occurred.	Mensaje de error devuelto si la llamada falla.
RequestId	String	29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1	ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. Valores válidos: true false

Ejemplos

Solicitudes de ejemplo

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateOTAVerifyJob
&FirmwareId=nx3xxVvFdwvn6dim50PY03****
&ProductKey=a1VJwBw****
&Tag.1.Key=key1
&Tag.1.Value=value1
&TargetDeviceName.1=testdevice
&TimeoutInMinutes=1440
&<Common request parameters>

Respuesta exitosa de ejemplo

Formato XML

<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>

Formato JSON

{
  "Data": {
    "JobId": "wahVIzGkCMuAUE2gDERM02****",
    "UtcCreate": "2019-11-04T06:22:19.566Z"
  },
  "RequestId": "29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1",
  "Success": true
}

Códigos de error

Para consultar la lista de códigos de error, visite el centro de errores de API.