ListOTAModuleVersionsByDevice - Query OTA module versions - IoT Platform

Limitation de débit

Chaque compte Alibaba Cloud peut appeler cette opération jusqu'à 10 fois par seconde (QPS).

Remarque

Les utilisateurs RAM partagent le quota du compte Alibaba Cloud.

Débogage

Alibaba Cloud met à votre disposition OpenAPI Explorer pour simplifier l'utilisation des API. OpenAPI Explorer calcule automatiquement la valeur de la signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListOTAModuleVersionsByDevice	Opération à effectuer. Définissez la valeur sur `ListOTAModuleVersionsByDevice`.
CurrentPage	Integer	Yes	1	Numéro de la page à renvoyer. Valeur par défaut : 1.
PageSize	Integer	Yes	10	Nombre d'entrées par page. Valeur maximale : 200.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID de l'instance. Vous pouvez consulter l'ID de l'instance sur la page Overview de la console IoT Platform. Important Obligatoire si votre instance possède un ID. L'appel échoue en l'absence de cet identifiant. Non requis si votre instance ne possède pas de page Overview ni d'ID. Vue d'ensemble.
ProductKey	String	No	aluctKe****	ProductKey du produit auquel appartient l'appareil. Remarque Si vous spécifiez ce paramètre, vous devez également spécifier DeviceName.
DeviceName	String	No	newdevice	DeviceName de l'appareil. Remarque Si vous spécifiez ce paramètre, vous devez également spécifier ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	ID global unique de l'appareil, délivré par IoT Platform. Remarque Si vous spécifiez ce paramètre, il n'est pas nécessaire de spécifier ProductKey ni DeviceName. Le paramètre IotId correspond à un identifiant global unique (GUID) de l'appareil, qui est une combinaison de ProductKey et de DeviceName. Si vous spécifiez à la fois IotId et la combinaison de ProductKey et DeviceName, IotId est prioritaire.

Cette opération nécessite également des paramètres de requête communs.

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Consultez les Codes d'erreur.
CurrentPage	Integer	1	Numéro de la page renvoyée.
Data	Array of SimpleOTAModuleInfo		Détails de la version du module OTA renvoyés en cas de réussite de l'appel. Consultez SimpleOTAModuleInfo dans ce tableau.
SimpleOTAModuleInfo
DeviceName	String	newDevice	DeviceName de l'appareil.
IotId	String	QjIFT***000101	ID de l'appareil.
ModuleName	String	barcodeScanner	Nom du module OTA.
ModuleVersion	String	1,0	Version du module signalée par l'appareil.
ProductKey	String	aluctKe****	ProductKey du produit auquel appartient l'appareil.
ErrorMessage	String	A system exception occurred.	Message d'erreur. Renvoyé uniquement en cas d'échec de l'appel.
PageCount	Integer	1	Nombre total de pages renvoyées.
PageSize	Integer	10	Nombre de versions de module renvoyées par page.
RequestId	String	291438BA-6E10-4C4C-B761-243B9A0D324F	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é.
Total	Integer	10	Nombre total de versions de module signalées par l'appareil.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

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

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

Codes d'erreur

Consultez le Centre d'erreurs API pour obtenir la liste des codes d'erreur.