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

Consulta los detalles de un paquete de actualización OTA específico, incluido el nombre, el tipo y el estado del paquete.

Límites

Cada cuenta de Alibaba Cloud admite un máximo de 20 consultas por segundo (QPS).

Nota

Los usuarios 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 su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer 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í	QueryOTAFirmware	La operación que desea ejecutar. Establezca el valor en QueryOTAFirmware.
FirmwareId	String	Sí	s8SSHiKjpBfrM3BSN0z803****	El ID único del paquete de actualización OTA. Se devuelve un ID de paquete de actualización cuando llama a la operación CreateOTAFirmware para crear el paquete de actualización. Llame a la operación ListOTAFirmware y consulte el ID del paquete de actualización en la respuesta.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe configurar este parámetro. Si no establece este parámetro, la llamada fallará. Si su instancia no tiene página de Overview o ID, no necesita establecer este parámetro. Para obtener más información, consulte Descripción general.

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

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
FirmwareInfo	Struct		La información del paquete de actualización devuelta si la llamada es exitosa. Para obtener más información, consulte FirmwareInfo.
DestVersion	String	4.0.0	El número de versión del paquete de actualización OTA.
FirmwareDesc	String	modified-WiFi-module	La descripción del paquete de actualización OTA.
FirmwareId	String	UfuxnwygsuSkVE0VCN****0100	El ID único del paquete de actualización OTA.
FirmwareName	String	t3q5rkNm	El nombre del paquete de actualización OTA.
FirmwareSign	String	3d04ab6462633508606e5f3daac8****	La firma del paquete de actualización OTA. Nota Este parámetro está disponible si el paquete de actualización OTA contiene un solo archivo.
FirmwareSize	Integer	924	El tamaño del archivo del paquete de actualización OTA. Unidad: bytes. Nota Este parámetro está disponible si el paquete de actualización OTA contiene un solo archivo.
FirmwareUrl	String	https://ota-*.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948/5E962CF83DB1495E8337E9C8A4D1.bin?Expires=1577587360&OSSAccessKeyId=cS8uRRy54Rsz&Signature=farzC8%2FVMN4HYdEtXvdiC2OevH**	La URL del archivo del paquete de actualización almacenado en Object Storage Service (OSS). Nota Este parámetro está disponible si el paquete de actualización OTA contiene un solo archivo.
ModuleName	String	WifiConfigModify	El nombre del módulo. Las actualizaciones OTA se basan en los módulos de firmware de un dispositivo. Para obtener más información, consulte Agregar un módulo OTA personalizado a un paquete de actualización.
MultiFiles	Array of OtaPackageFileDTO		La información sobre los archivos del paquete de actualización OTA. Este parámetro está disponible si el paquete de actualización OTA contiene varios archivos.
FileMd5	String	3d04ab6462633508606e5f3d****	El valor MD5 del archivo del paquete de actualización OTA.
Name	String	firmware1	El nombre del archivo del paquete de actualización OTA.
SignValue	String	3d04ab6462633508606e5f3d****	La firma del archivo del paquete de actualización OTA.
Size	Integer	200	El tamaño del archivo del paquete de actualización OTA. Unidad: bytes.
Url	String	https://ota-*.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948/5E962CF83DB1495E8337E9C8A4D1.bin?Expires=1577587360&OSSAccessKeyId=cS8uRRy54Rsz&Signature=farzC8%2FVMN4HYdEtXvdiC2OevH**	La URL del archivo del paquete de actualización almacenado en Object Storage Service (OSS).
ProductKey	String	a19mzPZ****	La ProductKey del producto al que pertenece el paquete de actualización OTA.
ProductName	String	MyProduct	El nombre del producto al que pertenece el paquete de actualización OTA.
SignMethod	String	MD5	El método de firma del paquete de actualización OTA.
SrcVersion	String	1.0.0	El número de versión del paquete de actualización original que se va a actualizar. Nota Este parámetro se devuelve si realiza una actualización diferencial. Para obtener más información sobre los tipos de paquetes de actualización, consulte la descripción del parámetro Type.
Status	Integer	2	El estado del paquete de actualización OTA. Valores válidos: -1: no se requiere verificación 0: sin verificar 1: verificado 2: verificando 3: error en la verificación
Type	Integer	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 de actualización completa a un 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 solo las diferencias a un dispositivo para su actualización.
Udi	String	{"ota_notice":"Upgrade the underlying camera driver to solve the problem of blurred video images. "}	La información personalizada enviada al dispositivo. La información puede tener hasta 4,096 caracteres de longitud. No hay límite en el formato del contenido. Después de agregar el paquete de actualización y crear una tarea de actualización, IoT Platform envía la información personalizada al dispositivo especificado junto con la notificación de actualización.
UtcCreate	String	2019-12-28T02:42:22.000Z	La hora en que se creó el paquete de actualización OTA. La hora se muestra en UTC.
UtcModified	String	2019-12-28T02:42:41.000Z	La hora de la última modificación de la tarea de actualización. La hora se muestra en UTC.
VerifyProgress	Integer	0	El estado de verificación del paquete de actualización OTA. Valores válidos: 0: sin verificar 100: verificado Un valor N entre 0 y 100 indica que la tarea de actualización tiene un progreso del N por ciento. Compruebe el parámetro de respuesta Status para consultar el estado de verificación.
RequestId	String	A01829CE-75A1-4920-B775-921146A1AB79	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryOTAFirmware
&FirmwareId=s8SSHiKjpBfrM3BSN0z803****
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<QueryOTAFirmwareResponse>
  <RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
  <FirmwareInfo>
        <SrcVersion></SrcVersion>
        <FirmwareSign>3d04ab6462633508606e5f3daac8****</FirmwareSign>
        <ProductKey>a19mzPZ****</ProductKey>
        <Type>0</Type>
        <UtcModified>2019-12-28T02:42:41.000Z</UtcModified>
        <SignMethod>MD5</SignMethod>
        <UtcCreate>2019-12-28T02:42:22.000Z</UtcCreate>
        <FirmwareSize>924</FirmwareSize>
        <Status>2</Status>
        <FirmwareId>UfuxnwygsuSkVE0VCN****0100</FirmwareId>
        <FirmwareDesc>modified-WiFi-module</FirmwareDesc>
        <FirmwareUrl>https://ota-***.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948****/5E962CF83DB1495E8337E9C8A4D1****.bin?Expires=1577587360&amp;OSSAccessKeyId=cS8uRRy54Rsz****&amp;Signature=farzC8%2FVMN4HYdEtXvdiC2OevH****</FirmwareUrl>
        <DestVersion>4.0.0</DestVersion>
        <ProductName>MyProduct</ProductName>
        <FirmwareName>t3q5rkNm</FirmwareName>
        <ModuleName>WifiConfigModify</ModuleName>
        <Udi>{"ota_notice":"Upgrade the underlying camera driver to solve the problem of blurred video images. "}</Udi>
        <VerifyProgress>0</VerifyProgress>
  </FirmwareInfo>
  <Success>true</Success>
</QueryOTAFirmwareResponse>

Formato JSON

{
  "RequestId": "A01829CE-75A1-4920-B775-921146A1AB79",
  "FirmwareInfo": {
    "SrcVersion": "",
    "FirmwareSign": "3d04ab6462633508606e5f3daac8****",
    "ProductKey": "a19mzPZ****",
    "Type": 0,
    "UtcModified": "2019-12-28T02:42:41.000Z",
    "SignMethod": "MD5",
    "UtcCreate": "2019-12-28T02:42:22.000Z",
    "FirmwareSize": 924,
    "Status": 2,
    "FirmwareId": "UfuxnwygsuSkVE0VCN****0100",
    "FirmwareDesc": "modified-WiFi-module",
    "FirmwareUrl": "https://ota-***.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948****/5E962CF83DB1495E8337E9C8A4D1****.bin?Expires=1577587360&OSSAccessKeyId=cS8uRRy54Rsz****&Signature=farzC8%2FVMN4HYdEtXvdiC2OevH****",
    "DestVersion": "4.0.0",
    "ProductName": "MyProduct",
    "FirmwareName": "t3q5rkNm",
    "ModuleName": "WifiConfigModify",
    "Udi":"{\"ota_notice\":\" Upgrade the underlying camera driver to solve the problem of blurred video images. \"}",
    "VerifyProgress": 0
  },
  "Success": true
}

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.