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

Consulta todos los módulos OTA de un producto.

Límites

Cada cuenta de Alibaba Cloud admite 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. Para su comodidad, se recomienda llamar 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í	ListOTAModuleByProduct	La operación que desea ejecutar. Establezca el valor en ListOTAModuleByProduct.
ProductKey	String	Sí	a1uctKe****	El ProductKey del producto.
IotInstanceId	String	No	iot-cn-0pp1n8t****	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, configure este parámetro. De lo contrario, la llamada fallará. Si su instancia no tiene página de Overview o ID, omita este parámetro. Para obtener más información, consulte Descripción general.

Además de los parámetros específicos de la operación anteriores, especifique los 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.
Data	Array of OtaModuleDTO		Los módulos OTA devueltos si la llamada es exitosa.
AliasName	String	Barcode_scanner	El alias del módulo OTA.
Desc	String	This module represents the firmware of the barcode scanner.	La descripción del módulo OTA.
GmtCreate	String	2020-10-13T09:46Z	La hora en que se creó el módulo OTA. La hora se muestra en formato UTC.
GmtModified	String	2020-10-19T09:46Z	La última vez que se actualizó el módulo OTA. La hora se muestra en formato UTC.
ModuleName	String	barcodeScanner	El nombre del módulo OTA.
ProductKey	String	aluctKe****	El ProductKey del producto.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	74C2BB8D-1D6F-41F5-AE68-6B2310883F63	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=ListOTAModuleByProduct
&ProductKey=a1uctKe****
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<ListOTAModuleByProductResponse>
      <RequestId>74C2BB8D-1D6F-41F5-AE68-6B2310883F63</RequestId>
      <Data>
            <Desc>This module represents the firmware of the barcode scanner.</Desc>
            <GmtCreate>2020-10-13T09:46Z</GmtCreate>
            <ModuleName>barcodeScanner</ModuleName>
            <AliasName>Barcode_scanner</AliasName>
            <GmtModified>2020-10-19T09:46Z</GmtModified>
            <ProductKey>a1uctKe****</ProductKey>
      </Data>
      <Success>true</Success>
</ListOTAModuleByProductResponse>

Formato JSON

{
    "Data": {
        "Desc": "This module represents the firmware of the barcode scanner.",
        "GmtCreate": "2020-10-13T09:46Z",
        "ModuleName": "barcodeScanner",
        "AliasName": "Barcode_scanner",
        "GmtModified": "2020-10-19T09:46Z",
        "ProductKey": "a1uctKe****"
    },
    "RequestId": "74C2BB8D-1D6F-41F5-AE68-6B2310883F63",
    "Success": true
}

Códigos de error

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