QueryOTAFirmware - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les détails d'un package de mise à jour OTA spécifié, notamment son nom, son type et son état.

Limites

Chaque compte Alibaba Cloud peut exécuter un maximum de 20 requêtes par seconde (QPS).

Remarque

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

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. Il 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	QueryOTAFirmware	Opération à effectuer. Définissez la valeur sur QueryOTAFirmware.
FirmwareId	String	Oui	s8SSHiKjpBfrM3BSN0z803****	ID unique du package de mise à jour OTA. L'ID du package de mise à jour est renvoyé lors de l'appel à l'opération CreateOTAFirmware pour créer le package. Appelez l'opération ListOTAFirmware et consultez l'ID du package dans la réponse.
IotInstanceId	String	Non	iot_instc_pu***_c-v64********	ID de l'instance. Vous pouvez afficher l'ID de l'instance sur la page Aperçu de la console IoT Platform. Important Si votre instance possède un ID, vous devez configurer ce paramètre. À défaut, l'appel échoue. Si votre instance ne possède pas de page Aperçu ou d'ID, il n'est pas nécessaire de définir ce paramètre. Pour plus d'informations, consultez Aperçu.

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 à cette opération. Pour plus d'informations, consultez 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 Codes d'erreur.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
FirmwareInfo	Struct		Informations sur le package de mise à jour renvoyées en cas de succès de l'appel. Pour plus d'informations, consultez FirmwareInfo.
DestVersion	String	4.0.0	Numéro de version du package de mise à jour OTA.
FirmwareDesc	String	modified-WiFi-module	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. Remarque Ce paramètre est disponible si le package de mise à jour OTA contient un seul fichier.
FirmwareSize	Integer	924	Taille du fichier de package de mise à jour OTA. Unité : octets. Remarque Ce paramètre est disponible si le package de mise à jour OTA contient un seul fichier.
FirmwareUrl	String	https://ota-*.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948/5E962CF83DB1495E8337E9C8A4D1.bin?Expires=1577587360&OSSAccessKeyId=cS8uRRy54Rsz&Signature=farzC8%2FVMN4HYdEtXvdiC2OevH**	URL du fichier de package de mise à jour stocké dans Object Storage Service (OSS). Remarque Ce paramètre est disponible si le package de mise à jour OTA contient un seul fichier.
ModuleName	String	WifiConfigModify	Nom du module. Les mises à jour OTA sont basées sur les modules firmware d'un appareil. Pour plus d'informations, consultez Ajouter un module OTA personnalisé à un package de mise à jour.
MultiFiles	Array of OtaPackageFileDTO		Informations sur les fichiers du package de mise à jour OTA. Ce paramètre est disponible si le package contient plusieurs fichiers.
FileMd5	String	3d04ab6462633508606e5f3d****	Valeur MD5 du fichier de package de mise à jour OTA.
Name	String	firmware1	Nom du fichier de package de mise à jour OTA.
SignValue	String	3d04ab6462633508606e5f3d****	Signature du fichier de package de mise à jour OTA.
Size	Integer	200	Taille du fichier de package de mise à jour OTA. Unité : octets.
Url	String	https://ota-*.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948/5E962CF83DB1495E8337E9C8A4D1.bin?Expires=1577587360&OSSAccessKeyId=cS8uRRy54Rsz&Signature=farzC8%2FVMN4HYdEtXvdiC2OevH**	URL du fichier de package de mise à jour stocké dans Object Storage Service (OSS).
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	1.0.0	Numéro de version du package original à mettre à jour. Remarque Ce paramètre est renvoyé en cas de mise à jour différentielle. Pour plus d'informations sur les types de packages de mise à jour, consultez la description du paramètre Type.
Status	Integer	2	État du package de mise à jour OTA. Valeurs valides : -1 : aucune vérification requise 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 valides : 0 : Le fichier téléchargé contient un package de mise à jour complet. IoT Platform pousse le package complet vers l'appareil pour la mise à jour. 1 : Le fichier téléchargé contient uniquement les différences entre le dernier package de mise à jour et le précédent. IoT Platform pousse uniquement les différences vers l'appareil pour la mise à jour.
Udi	String	{"ota_notice":"Upgrade the underlying camera driver to solve the problem of blurred video images. "}	Informations personnalisées poussées vers l'appareil. La longueur maximale est de 4 096 caractères. Aucun format de contenu n'est imposé. Après avoir ajouté le package de mise à jour et créé une tâche de mise à jour, IoT Platform envoie les informations personnalisées à l'appareil spécifié lors de la poussée de la notification de mise à jour.
UtcCreate	String	2019-12-28T02:42:22.000Z	Heure de création du package de mise à jour OTA. L'heure est affichée au format UTC.
UtcModified	String	2019-12-28T02:42:41.000Z	Heure de la dernière modification de la tâche de mise à jour. L'heure est affichée au format UTC.
VerifyProgress	Integer	0	État de vérification du package de mise à jour OTA. Valeurs valides : 0 : non vérifié 100 : vérifié Une valeur N comprise entre 0 et 100 indique que la tâche de mise à jour est achevée à N %. Consultez le paramètre de réponse Status pour connaître l'état de la vérification.
RequestId	String	A01829CE-75A1-4920-B775-921146A1AB79	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

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryOTAFirmware
&FirmwareId=s8SSHiKjpBfrM3BSN0z803****
&<Common request parameters>

Exemples de réponses réussies

Format XML

<QueryOTAFirmwareResponse>
  <RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
  <FirmwareInfo>
        <SrcVersion></SrcVersion>
        <FirmwareSign>3d04ab6462633508606e5f3daac8****</FirmwareSign>
        <ProductKey>a19mzPZ****</ProductKey>
        <Type>0</Type>
        <UtcModified>2019-12-28T02:42:41.000Z</UtcModified>
        <SignMethod>MD5</SignMethod>
        <UtcCreate>2019-12-28T02:42:22.000Z</UtcCreate>
        <FirmwareSize>924</FirmwareSize>
        <Status>2</Status>
        <FirmwareId>UfuxnwygsuSkVE0VCN****0100</FirmwareId>
        <FirmwareDesc>modified-WiFi-module</FirmwareDesc>
        <FirmwareUrl>https://ota-***.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948****/5E962CF83DB1495E8337E9C8A4D1****.bin?Expires=1577587360&amp;OSSAccessKeyId=cS8uRRy54Rsz****&amp;Signature=farzC8%2FVMN4HYdEtXvdiC2OevH****</FirmwareUrl>
        <DestVersion>4.0.0</DestVersion>
        <ProductName>MyProduct</ProductName>
        <FirmwareName>t3q5rkNm</FirmwareName>
        <ModuleName>WifiConfigModify</ModuleName>
        <Udi>{"ota_notice":"Upgrade the underlying camera driver to solve the problem of blurred video images. "}</Udi>
        <VerifyProgress>0</VerifyProgress>
  </FirmwareInfo>
  <Success>true</Success>
</QueryOTAFirmwareResponse>

Format JSON

{
  "RequestId": "A01829CE-75A1-4920-B775-921146A1AB79",
  "FirmwareInfo": {
    "SrcVersion": "",
    "FirmwareSign": "3d04ab6462633508606e5f3daac8****",
    "ProductKey": "a19mzPZ****",
    "Type": 0,
    "UtcModified": "2019-12-28T02:42:41.000Z",
    "SignMethod": "MD5",
    "UtcCreate": "2019-12-28T02:42:22.000Z",
    "FirmwareSize": 924,
    "Status": 2,
    "FirmwareId": "UfuxnwygsuSkVE0VCN****0100",
    "FirmwareDesc": "modified-WiFi-module",
    "FirmwareUrl": "https://ota-***.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948****/5E962CF83DB1495E8337E9C8A4D1****.bin?Expires=1577587360&OSSAccessKeyId=cS8uRRy54Rsz****&Signature=farzC8%2FVMN4HYdEtXvdiC2OevH****",
    "DestVersion": "4.0.0",
    "ProductName": "MyProduct",
    "FirmwareName": "t3q5rkNm",
    "ModuleName": "WifiConfigModify",
    "Udi":"{\"ota_notice\":\" Upgrade the underlying camera driver to solve the problem of blurred video images. \"}",
    "VerifyProgress": 0
  },
  "Success": true
}

Codes d'erreur

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