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

Crea un paquete de actualización OTA para dispositivos.

Notas de uso

Antes de llamar a esta operación, ejecute la operación GenerateOTAUploadURL para generar la información de carga y, posteriormente, llame a la operación PostObject de Object Storage Service (OSS) para cargar los archivos.

Límites

Se pueden crear hasta 500 paquetes de actualización en una sola instancia.

Límites de QPS

Esta operación admite hasta 10 llamadas por segundo por cuenta.

Nota

Los usuarios de Resource Access Management (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, se recomienda ejecutar esta operación en OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	CreateOTAFirmware	La operación que desea ejecutar. Establezca el valor en CreateOTAFirmware.
DestVersion	String	Sí	2.0.0	El número de versión del paquete de actualización OTA. Caracteres válidos: letras, dígitos, puntos (.), guiones (-) y guiones bajos (_). Longitud: de 1 a 64 caracteres.
FirmwareName	String	Sí	Firmware2	El nombre del paquete de actualización OTA. Debe ser único dentro de una cuenta de Alibaba Cloud y no se puede modificar después de crear el paquete. Longitud: de 1 a 40 caracteres. Caracteres válidos: letras, dígitos, guiones (-), guiones bajos (_) y paréntesis (). Debe comenzar con una letra o un dígito.
IotInstanceId	String	No	iot-cn-0pp1n8t****	El ID de la instancia. Consulte el ID de instancia en la página Descripción general de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificar este parámetro. De lo contrario, la solicitud fallará. Si la página Descripción general o el ID de instancia no se muestran en la consola de IoT Platform, no es necesario especificar este parámetro.
FirmwareUrl	String	No	https://iotx-ota.oss-cn-shanghai.aliyuncs.com/ota/bcd6142594d0183a16d825ad8225/A6B3400B70CA4D6D872160D1A91A.bin	La URL del archivo para agregar al paquete de actualización OTA. La URL indica la ubicación de almacenamiento del archivo en OSS. Llame a la operación GenerateOTAUploadURL para generar esta URL. Importante Si desea agregar solo un archivo al paquete de actualización OTA, debe especificar este parámetro.
FirmwareSign	String	No	93230c3bde425a9d7984a594ac55****	El valor de firma del archivo para agregar al paquete de actualización OTA. El valor se calcula mediante un algoritmo de firma, como Secure Hash Algorithm 256 (SHA-256) o MD5. Importante Si desea agregar solo un archivo al paquete de actualización OTA, puede especificar este parámetro. Si no lo especifica, se utiliza el valor MD5 del archivo en OSS.
SignMethod	String	No	MD5	El algoritmo de firma utilizado para firmar el archivo. Valores válidos: MD5 (predeterminado) SHA256
FirmwareSize	Integer	No	900	El tamaño del archivo para agregar al paquete de actualización OTA. Unidad: bytes. Importante Si desea agregar solo un archivo al paquete de actualización OTA, puede especificar este parámetro. Si no lo especifica, se utiliza el tamaño del archivo en OSS.
ProductKey	String	No	a1uctKe****	La clave ProductKey del producto al que pertenece el paquete de actualización OTA.
FirmwareDesc	String	No	OTA function updated	La descripción del paquete de actualización OTA. La longitud máxima permitida es de 100 caracteres.
Type	Integer	No	0	El tipo de paquete de actualización OTA. Valores válidos: 0: El archivo cargado contiene un paquete de actualización completa. IoT Platform envía el paquete completo al dispositivo para su actualización. 1: El archivo cargado contiene solo las diferencias entre el paquete de actualización más reciente y el anterior. IoT Platform envía únicamente estas diferencias al dispositivo para su actualización. Valor predeterminado: 0.
SrcVersion	String	No	1.0.0	El número de versión del módulo OTA del dispositivo por actualizar. Llame a la operación QueryDeviceDetail y consulte el valor de FirmwareVersion en la respuesta. Nota Si establece Type en 1, debe especificar este parámetro y su valor no puede ser igual al de DestVersion. Si establece Type en 0, no es necesario especificar este parámetro.
ModuleName	String	No	WifiConfigModify	El nombre del módulo OTA. Los módulos OTA son las unidades actualizables de los dispositivos que pertenecen al mismo producto. Nota Si no especifica este parámetro, se utiliza el módulo OTA predeterminado. Este valor indica que se actualiza el firmware completo del dispositivo. Llame a la operación CreateOTAModule para crear un módulo OTA personalizado. También puede llamar a la operación ListOTAModuleByProduct para consultar los módulos OTA existentes de un producto.
NeedToVerify	Boolean	No	true	Indica si se debe verificar el paquete de actualización OTA antes de crear una tarea de actualización por lotes. Valores válidos: true (predeterminado) false
Udi	String	No	{"ota_notice":"Update the underlying camera driver to resolve the issue of blurry images in videos."}	Información personalizada para enviar al dispositivo. No hay restricciones de formato, pero el contenido no puede exceder los 4,096 caracteres. Después de crear el paquete de actualización OTA y la tarea correspondiente, IoT Platform envía esta información personalizada al dispositivo especificado junto con la notificación de actualización.
MultiFiles.N.Name	String	No	Firmware1	El nombre del archivo para agregar al paquete de actualización OTA. Longitud: de 1 a 32 caracteres. Se pueden especificar hasta 20 nombres de archivo. Cada nombre debe ser único dentro del paquete de actualización. Importante Si desea agregar varios archivos al paquete de actualización OTA, debe especificar este parámetro.
MultiFiles.N.Size	Integer	No	200	El tamaño del archivo para agregar al paquete de actualización OTA. Unidad: bytes. Nota Si desea agregar varios archivos al paquete de actualización OTA, puede especificar este parámetro. Si no lo especifica, se utiliza el tamaño del archivo en OSS.
MultiFiles.N.Url	String	No	https://iotx-ota.oss-cn-shanghai.aliyuncs.com/ota/bcd6142594d0183a16d825ad8225/A6B3400B70CA4D6D872160D1A91A.bin	La URL del archivo para agregar al paquete de actualización OTA. La URL indica la ubicación de almacenamiento del archivo en OSS. Llame a la operación GenerateOTAUploadURL para generar una URL para cada archivo. Importante Si desea agregar varios archivos al paquete de actualización OTA, debe especificar este parámetro.
MultiFiles.N.SignValue	String	No	93230c3bde425a9d7984a594ac45****	El valor de firma del archivo para agregar al paquete de actualización OTA. El valor se calcula mediante un algoritmo de firma. Nota Si desea agregar varios archivos al paquete de actualización OTA, puede especificar este parámetro. Si no lo especifica, se utiliza el valor MD5 del archivo en OSS.
MultiFiles.N.FileMd5	String	No	93230c3bde425a9d7984a594ac56***	El valor MD5 del archivo para agregar al paquete de actualización OTA. Nota Si desea agregar varios archivos al paquete de actualización OTA, puede especificar este parámetro. Si no lo especifica, se utiliza el valor MD5 del archivo en OSS.

Además de los parámetros de solicitud específicos de la operación mencionados anteriormente, debe especificar los parámetros de solicitud comunes al llamar a esta operación. 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	El código de error devuelto si la solicitud falla. Para obtener más información, consulte Códigos de error.
Data	Struct		La información del paquete de actualización OTA devuelta si la solicitud fue exitosa.
FirmwareId	String	s8SSHiKjpBfrM3BSN0z803****	El ID único del paquete de actualización OTA, asignado por IoT Platform.
UtcCreate	String	2019-11-04T06:21:54.607Z	La hora en que se creó el paquete de actualización OTA, en formato UTC.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la solicitud falla.
RequestId	String	291438BA-6E10-4C4C-B761-243B9A0D324F	El ID de la solicitud.
Success	Boolean	true	Indica si la solicitud fue exitosa. Valores válidos: true false

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateOTAFirmware
&ProductKey=a1uctKe****
&FirmwareName=Firmware2
&DestVersion=2.0.0
&FirmwareUrl=https%3A%2F%2iotx-ota.oss-cn-shanghai.aliyuncs.com%2Fota%2F****%2F****.bin
&SignMethod=MD5
&FirmwareSign=93230c3bde425a9d7984a594ac55****
&FirmwareSize=900
&FirmwareDesc=OTA function updated
&Type=0
&ModuleName=WifiConfigModify
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<CreateOTAFirmwareResponse>
    <Data>
        <FirmwareId>s8SSHiKjpBfrM3BSN0z803****</FirmwareId>
        <UtcCreate>2019-11-04T06:21:54.607Z</UtcCreate>
    </Data>
    <RequestId>E4BD5A12-7C1D-4712-A7D5-B2432331165E</RequestId>
    <Success>true</Success>
</CreateOTAFirmwareResponse>

Formato JSON

{  
  "Data": {
    "FirmwareId": "s8SSHiKjpBfrM3BSN0z803****",
    "UtcCreate": "2019-11-04T06:21:54.607Z"
  },
  "RequestId": "291438BA-6E10-4C4C-B761-243B9A0D324F",
  "Success": true
}

Códigos de error

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.