ListOTAModuleByProduct - IoT Platform - Centre de documentation Alibaba Cloud

Répertorie tous les modules OTA d'un produit.

Limites

Chaque compte Alibaba Cloud peut exécuter au maximum 10 requêtes par seconde (QPS).

Remarque

Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota de ce compte.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de la requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	ListOTAModuleByProduct	L'opération à effectuer. Définissez la valeur sur ListOTAModuleByProduct.
ProductKey	String	Oui	a1uctKe****	Clé ProductKey du produit.
IotInstanceId	String	Non	iot-cn-0pp1n8t****	ID de l'instance. Vous pouvez consulter l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez définir ce paramètre. À défaut, l'appel échouera. Si votre instance ne dispose pas de page Overview ou d'ID, il n'est pas nécessaire de définir ce paramètre. Pour plus d'informations, consultez la rubrique Vue d'ensemble.

Outre les paramètres de requête spécifiques à l'opération, vous devez spécifier les paramètres de requête communs lors de l'appel. Pour plus d'informations, consultez la rubrique Paramètres de requête communs.

Paramètres de la réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez la rubrique Codes d'erreur.
Data	Array of OtaModuleDTO		Modules OTA renvoyés en cas de succès de l'appel.
AliasName	String	Barcode_scanner	Alias du module OTA.
Desc	String	This module represents the firmware of the barcode scanner.	Description du module OTA.
GmtCreate	String	2020-10-13T09:46Z	Heure de création du module OTA, affichée au format UTC.
GmtModified	String	2020-10-19T09:46Z	Dernière heure de mise à jour du module OTA, affichée au format UTC.
ModuleName	String	barcodeScanner	Nom du module OTA.
ProductKey	String	aluctKe****	Clé ProductKey du produit.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	74C2BB8D-1D6F-41F5-AE68-6B2310883F63	ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAModuleByProduct
&ProductKey=a1uctKe****
&<Common request parameters>

Exemple de réponse réussie

Format 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>

Format 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
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs API.