ListOTAFirmware - IoT Platform - Centre de documentation Alibaba Cloud

Limites

Chaque compte Alibaba Cloud est limité à 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’appeler cette opération dans OpenAPI Explorer, qui génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	ListOTAFirmware	L’opération à effectuer. Définissez la valeur sur ListOTAFirmware.
CurrentPage	Integer	Oui	1	Numéro de la page à renvoyer. La numérotation commence à 1.
PageSize	Integer	Oui	10	Nombre d’entrées à renvoyer par page. Valeur maximale : 100.
IotInstanceId	String	Non	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 Si votre instance possède un ID, vous devez renseigner ce paramètre. À défaut, l’appel échoue. Si votre instance ne possède pas de page Overview ou d’ID, il n’est pas nécessaire de renseigner ce paramètre. Pour plus d’informations, consultez Overview.
ProductKey	String	Non	a19mzPZ****	ProductKey du produit auquel appartient le package de mise à jour OTA. Si vous spécifiez ce paramètre, seuls les packages de mise à jour OTA du produit indiqué sont renvoyés. Si vous omettez ce paramètre, tous les packages de mise à jour OTA du compte Alibaba Cloud actuel sont renvoyés.
DestVersion	String	Non	4.0.0	Numéro de version du package de mise à jour OTA. Si vous spécifiez ce paramètre, seul le package correspondant à la version indiquée est renvoyé.

Outre les paramètres spécifiques à cette opération, vous devez inclure 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 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.
CurrentPage	Integer	1	Numéro de la page renvoyée.
ErrorMessage	String	A system exception occurred.	Message d’erreur renvoyé en cas d’échec de l’appel.
FirmwareInfo	Array of SimpleFirmwareInfo		Packages de mise à jour OTA renvoyés en cas de succès de l’appel. Pour plus d’informations, consultez SimpleFirmwareInfo.
SimpleFirmwareInfo
DestVersion	String	4.0.0	Numéro de version du package de mise à jour OTA.
FirmwareDesc	String	firmwareDesc	Description du package de mise à jour OTA.
FirmwareId	String	UfuxnwygsuSkVE0VCN****0100	ID unique du package de mise à jour OTA.
FirmwareName	String	t3q5rkNm	Nom du package de mise à jour OTA.
FirmwareSign	String	3d04ab6462633508606e5f3daac8****	Signature du package de mise à jour OTA.
FirmwareSize	Integer	924	Taille du package de mise à jour, en octets.
ModuleName	String	module1234	Nom du module.
ProductKey	String	a19mzPZ****	ProductKey du produit auquel appartient le package de mise à jour OTA.
ProductName	String	MyProduct	Nom du produit auquel appartient le package de mise à jour OTA.
SignMethod	String	MD5	Méthode de signature du package de mise à jour OTA.
SrcVersion	String	V1.0.0	Numéro de version du package d’origine à mettre à jour. Remarque La valeur de retour est nulle en cas de mise à jour complète.
Status	Integer	0	État du package de mise à jour OTA. Valeurs possibles : 0 : non vérifié 1 : vérifié 2 : en cours de vérification 3 : échec de la vérification
Type	Integer	0	Type du package de mise à jour OTA. Valeurs possibles : 0 : firmware complet 1 : firmware différentiel
UtcCreate	String	2019-12-28T02:42:22.000Z	Heure de création du package de mise à jour, au format UTC.
UtcModified	String	2019-12-28T02:42:22.000Z	Heure de la dernière modification de la tâche de mise à jour, au format UTC.
PageCount	Integer	1	Nombre total de pages.
PageSize	Integer	10	Nombre d’entrées renvoyées par page.
RequestId	String	A01829CE-75A1-4920-B775-921146A1AB79	ID de la requête.
Success	Boolean	true	Indique si l’appel a abouti. true : L’appel a réussi. false : L’appel a échoué.
Total	Integer	1	Nombre total de packages de mise à jour OTA.

Exemples

Exemple de requête

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

Exemple de réponse en cas de succès

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>

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
}

Codes d’erreur

Pour obtenir la liste des codes d’erreur, visitez le Centre d’erreurs de l’API.