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

Consulta los paquetes de actualización por aire (OTA).

Límites

Cada cuenta de Alibaba Cloud puede ejecutar un máximo de 10 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. Le recomendamos llamar a esta operación desde OpenAPI Explorer, ya que genera dinámicamente código de ejemplo para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListOTAFirmware	La operación que desea ejecutar. Establezca el valor en ListOTAFirmware.
CurrentPage	Integer	Sí	1	El número de la página que se devolverá. La numeración comienza en 1.
PageSize	Integer	Sí	10	El número de entradas que se devolverán en cada página. Valor máximo: 100.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Consulte el ID de la instancia en la página Descripción general de la consola de IoT Platform. Importante Si su instancia tiene un ID, configure este parámetro. De lo contrario, la llamada fallará. Si su instancia no tiene una página Descripción general ni ID, no es necesario configurar este parámetro. Para obtener más información, consulte Descripción general.
ProductKey	String	No	a19mzPZ****	El ProductKey del producto al que pertenece el paquete de actualización OTA. Si especifica este parámetro, solo se devuelven los paquetes de actualización OTA del producto indicado. Si no lo especifica, se devuelven los paquetes de actualización OTA de la cuenta actual de Alibaba Cloud.
DestVersion	String	No	4.0.0	El número de versión del paquete de actualización OTA. Si especifica este parámetro, solo se devuelve el paquete de actualización OTA con la versión indicada.

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 de solicitud comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error que se devuelve si la llamada falla. Para obtener más información, consulte Códigos de error.
CurrentPage	Integer	1	El número de la página devuelta.
ErrorMessage	String	A system exception occurred.	El mensaje de error que se devuelve si la llamada falla.
FirmwareInfo	Array of SimpleFirmwareInfo		Los paquetes de actualización OTA que se devuelven si la llamada es exitosa. Para obtener más información, consulte SimpleFirmwareInfo.
SimpleFirmwareInfo
DestVersion	String	4.0.0	El número de versión del paquete de actualización OTA.
FirmwareDesc	String	firmwareDesc	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.
FirmwareSize	Integer	924	El tamaño del paquete de actualización. Unidad: bytes.
ModuleName	String	module1234	El nombre del módulo.
ProductKey	String	a19mzPZ****	El 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	V1.0.0	El número de versión del paquete de actualización original que se va a actualizar. Nota El valor devuelto es nulo si ejecuta una actualización completa.
Status	Integer	0	El estado del paquete de actualización OTA. Valores válidos: 0: sin verificar 1: verificado 2: en verificación 3: error de verificación
Type	Integer	0	El tipo del paquete de actualización OTA. Valores válidos: 0: firmware completo 1: firmware diferencial
UtcCreate	String	2019-12-28T02:42:22.000Z	La hora en la que se creó el paquete de actualización, en formato UTC.
UtcModified	String	2019-12-28T02:42:22.000Z	La hora de la última modificación de la tarea de actualización, en formato UTC.
PageCount	Integer	1	El número total de páginas.
PageSize	Integer	10	El número de entradas devueltas por página.
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 presentó errores.
Total	Integer	1	El número total de paquetes de actualización OTA.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAFirmware
&CurrentPage=1
&PageSize=10
&ProductKey=a19mzPZ****
&DestVersion=4.0.0
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<ListOTAFirmwareResponse>
  <PageCount>1</PageCount>
  <PageSize>10</PageSize>
  <RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
  <FirmwareInfo>
        <SimpleFirmwareInfo>
              <SrcVersion>1.0.0</SrcVersion>
              <FirmwareSign>3d04ab6462633508606e5f3daac8****</FirmwareSign>
              <ProductKey>a19mzPZ****</ProductKey>
              <Type>0</Type>
              <UtcModified>2019-12-28T02:42:22.000Z</UtcModified>
              <SignMethod>MD5</SignMethod>
              <UtcCreate>2019-12-28T02:42:22.000Z</UtcCreate>
              <FirmwareSize>924</FirmwareSize>
              <Status>0</Status>
              <FirmwareId>UfuxnwygsuSkVE0VCN****0100</FirmwareId>
              <FirmwareDesc>firmwareDesc</FirmwareDesc>
              <DestVersion>4.0.0</DestVersion>
              <ProductName>MyProduct</ProductName>
              <FirmwareName>t3q5rkNm</FirmwareName>
              <ModuleName>module1234</ModuleName>
        </SimpleFirmwareInfo>
  </FirmwareInfo>
  <CurrentPage>1</CurrentPage>
  <Success>true</Success>
  <Total>1</Total>
</ListOTAFirmwareResponse>

Formato JSON

{
  "PageCount": 1,
  "PageSize": 10,
  "RequestId": "A01829CE-75A1-4920-B775-921146A1AB79",
  "FirmwareInfo": {
    "SimpleFirmwareInfo": [{
      "SrcVersion": "1.0.0",
      "FirmwareSign": "3d04ab6462633508606e5f3daac8****",
      "ProductKey": "a19mzPZ****",
      "Type": 0,
      "UtcModified": "2019-12-28T02:42:22.000Z",
      "SignMethod": "MD5",
      "UtcCreate": "2019-12-28T02:42:22.000Z",
      "FirmwareSize": 924,
      "Status": 0,
      "FirmwareId": "UfuxnwygsuSkVE0VCN****0100",
      "FirmwareDesc": "firmwareDesc",
      "DestVersion": "4.0.0",
      "ProductName": "MyProduct",
      "FirmwareName": "t3q5rkNm",
      "ModuleName": "module1234"
    }]
  },
  "CurrentPage": 1,
  "Success": true,
  "Total": 1
}

Códigos de error

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