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

Consulta las versiones de los módulos over-the-air (OTA) que reporta un dispositivo.

Límites de frecuencia

Cada cuenta de Alibaba Cloud puede invocar esta operación hasta 10 veces por segundo (QPS).

Nota

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

Depuración

Alibaba Cloud ofrece OpenAPI Explorer para simplificar el uso de la API. OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda invocar 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í	ListOTAModuleVersionsByDevice	La operación que desea ejecutar. Establezca el valor en `ListOTAModuleVersionsByDevice`.
CurrentPage	Integer	Sí	1	Número de página a devolver. Valor predeterminado: 1.
PageSize	Integer	Sí	10	Número de entradas por página. Valor máximo: 200.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Obligatorio si su instancia tiene un ID. La llamada fallará sin este valor. No es obligatorio si su instancia no tiene página Overview ni ID. Descripción general.
ProductKey	String	No	aluctKe****	ProductKey del producto al que pertenece el dispositivo. Nota Si especifica este parámetro, también debe especificar DeviceName.
DeviceName	String	No	newdevice	DeviceName del dispositivo. Nota Si especifica este parámetro, también debe especificar ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	ID único global del dispositivo, emitido por IoT Platform. Nota Si especifica este parámetro, no necesita especificar ProductKey ni DeviceName. El parámetro IotId define un identificador único global (GUID) del dispositivo, que corresponde a una combinación de ProductKey y DeviceName. Si especifica tanto IotId como la combinación de ProductKey y DeviceName, IotId tendrá prioridad.

Esta operación también requiere parámetros de solicitud 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. Consulte Códigos de error.
CurrentPage	Integer	1	Número de la página devuelta.
Data	Array of SimpleOTAModuleInfo		Detalles de la versión del módulo OTA devueltos en una llamada exitosa. Consulte SimpleOTAModuleInfo en esta tabla.
SimpleOTAModuleInfo
DeviceName	String	newDevice	DeviceName del dispositivo.
IotId	String	QjIFT***000101	ID del dispositivo.
ModuleName	String	barcodeScanner	Nombre del módulo OTA.
ModuleVersion	String	1.0	Versión del módulo que reporta el dispositivo.
ProductKey	String	aluctKe****	ProductKey del producto al que pertenece el dispositivo.
ErrorMessage	String	A system exception occurred.	Mensaje de error. Se devuelve solo si la llamada falla.
PageCount	Integer	1	Número total de páginas devueltas.
PageSize	Integer	10	Número de versiones de módulo devueltas en cada página.
RequestId	String	291438BA-6E10-4C4C-B761-243B9A0D324F	ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.
Total	Integer	10	Número total de versiones de módulo que reporta el dispositivo.

Ejemplos

Solicitudes de ejemplo

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAModuleVersionsByDevice
&CurrentPage=1
&PageSize=10
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<ListOTAModuleVersionsByDeviceResponse>
  <requestId>67AF7881-704C-40CC-B296-72F91380A117</requestId>
  <success>true</success>
  <code></code>
  <errorMessage></errorMessage>
  <PageSize>10</PageSize>
  <PageCount>1</PageCount>
  <CurrentPage>1</CurrentPage>
  <Total>1</Total>
  <Data>
        <SimpleOTAModuleInfo>
              <IotId>QjIFT***000101</IotId>
              <ModuleVersion>1.6940.1</ModuleVersion>
              <ModuleName>default</ModuleName>
              <ProductKey>a14***S</ProductKey>
              <DeviceName>newDevice</DeviceName>
        </SimpleOTAModuleInfo>
  </Data>
</ListOTAModuleVersionsByDeviceResponse>

Formato JSON

{
    "requestId": "67AF7881-704C-40CC-B296-72F91380A117",
    "success": true,
    "code": "",
    "errorMessage": null,
    "PageSize": 10,
    "PageCount": 1,
    "CurrentPage": 1,
    "Total": 1,
    "Data": {
        "SimpleOTAModuleInfo": [
            {
                "IotId": "QjIFT***000101",
                "ModuleVersion": "1.6940.1",
                "ModuleName": "default",
                "ProductKey": "a14***S",
                "DeviceName": "newDevice"
            }
        ]
    }
}

Códigos de error

Visite el Centro de errores de API para consultar la lista de códigos de error.