QueryOTAJob - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les détails d’un lot de mise à jour.

Notes d'utilisation

Lorsque vous appelez l’opération API CreateOTAVerifyJob, CreateOTAStaticUpgradeJob ou CreateOTADynamicUpgradeJob pour créer un lot de mise à jour, le paramètre JobId est renvoyé. Utilisez ce paramètre pour interroger les détails du lot de mise à jour.

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 du compte.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de 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

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QueryOTAJob	Opération à effectuer. Définissez la valeur sur QueryOTAJob.
JobId	String	Oui	wahVIzGkCMuAUE2gDERM02****	ID du lot de mise à jour. Après avoir appelé l’opération API CreateOTAVerifyJob, CreateOTAStaticUpgradeJob ou CreateOTADynamicUpgradeJob pour créer le lot de mise à jour, récupérez le paramètre JobId. Vous pouvez également afficher l’ID du lot sur la page Update Package Details de la console IoT Platform.
IotInstanceId	String	Non	iot-cn-0pp1n8t****	ID de l’instance. Affichez l’ID de l’instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, définissez ce paramètre. Sinon, l’appel échoue. Si votre instance ne possède pas de page Overview ou d’ID, ne définissez pas ce paramètre. Pour plus d’informations, consultez Overview.

Outre les paramètres de requête spécifiques à l’opération ci-dessus, spécifiez des paramètres de requête communs lorsque vous appelez cette opération. Pour plus d’informations, consultez Common request parameters.

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 Error codes.
Data	Struct		Informations sur le lot de mise à jour renvoyées en cas de réussite de l’appel. Pour plus d’informations, consultez les paramètres suivants.
DestVersion	String	1.0.1	Version cible du micrologiciel pour la mise à jour.
DownloadProtocol	String	HTTPS	Protocole de téléchargement du package de mise à jour.
DynamicMode	Integer	1	Mode de mise à jour dynamique. Valeurs possibles : 1 : met constamment à jour les appareils qui remplissent les conditions. 2 : met uniquement à jour les appareils qui soumettent ultérieurement les dernières versions du micrologiciel. Ce paramètre est renvoyé uniquement si vous effectuez une mise à jour dynamique.
FirmwareId	String	UfuxnwygsuSkVE0VCN****0100	ID du package de mise à jour.
GrayPercent	String	50.00	Ratio de phase de la mise à jour progressive. Ce paramètre est renvoyé uniquement si vous effectuez une mise à jour progressive.
GroupId	String	CtjzCkNuOxUR***	ID du groupe d’appareils à mettre à jour.
GroupName	String	test	Nom du groupe d’appareils à mettre à jour.
JobDesc	String	batch upgrade	Description du lot de mise à jour.
JobId	String	HvKuBpuk3rdk6E92CP****0200	ID du lot de mise à jour.
JobStatus	String	IN_PROGRESS	Statut du lot de mise à jour. PLANNED : Le lot de mise à jour est en cours de planification. Le lot est créé, mais l’heure planifiée n’est pas encore arrivée. Ce paramètre est renvoyé uniquement si vous effectuez une mise à jour statique. IN_PROGRESS : Le lot de mise à jour est en cours d’exécution. COMPLETED : Le lot de mise à jour est terminé. CANCELED : Le lot de mise à jour est annulé.
JobType	String	UPGRADE_FIRMWARE	Type du lot. Valeurs possibles : VERFIY_FIRMWARE : vérification du package de mise à jour. UPGRADE_FIRMWARE : mise à jour par lot.
MaximumPerMinute	Integer	1000	Nombre maximal d’appareils auxquels l’URL de téléchargement du package de mise à jour est envoyée par minute.
MultiModuleMode	Boolean	false	Indique si l’appareil prend en charge les mises à jour simultanées de plusieurs modules. false (par défaut) : non. true : oui. Pour plus d’informations, consultez Overview.
Name	String	Firmware2	Nom du package de mise à jour.
NeedConfirm	Boolean	false	Indique si la confirmation de la mise à jour doit être effectuée via votre application mobile.
NeedPush	Boolean	true	Indique s’il faut envoyer automatiquement les tâches de mise à jour depuis IoT Platform vers les appareils.
OverwriteMode	Integer	1	Indique s’il faut écraser la tâche de mise à jour précédente. Valeurs possibles : 1 : La tâche de mise à jour précédente n’est pas écrasée. Si un appareil possède déjà une tâche de mise à jour, la tâche précédente est exécutée. 2 : La tâche de mise à jour précédente est écrasée. Seule la tâche de mise à jour actuelle est exécutée. La tâche de mise à jour en cours d’exécution n’est pas écrasée.
ProductKey	String	a19mzPZ****	ProductKey du produit auquel appartient le package de mise à jour.
RetryCount	Integer	1	Nombre de nouvelles tentatives automatiques après l’échec de la mise à jour d’un appareil. Ce paramètre est renvoyé si une politique de nouvelle tentative est définie lors de la création du lot de mise à jour.
RetryInterval	Integer	60	Intervalle de nouvelle tentative automatique après l’échec de la mise à jour d’un appareil. Unité : minutes. Ce paramètre est renvoyé si une politique de nouvelle tentative est définie lors de la création du lot de mise à jour.
SelectionType	String	STATIC	Politique de mise à jour du lot de mise à jour. Valeurs possibles : DYNAMIC : mise à jour dynamique. Cette valeur est renvoyée si vous appelez l’opération API CreateOTADynamicUpgradeJob pour créer un lot de mise à jour. STATIC : mise à jour statique. Cette valeur est renvoyée si vous appelez l’opération API CreateOTAStaticUpgradeJob pour créer un lot de mise à jour.
SrcVersions	List	null	Liste des versions du micrologiciel à mettre à jour.
Tags	Array of OtaTagDTO		Tags du lot de mise à jour.
OtaTagDTO
Key	String	key1	Clé de chaque tag.
Value	String	value1	Valeur du tag.
TargetSelection	String	SPECIFIC	Portée du lot de mise à jour. Valeurs possibles : ALL : met à jour tous les appareils. SPECIFIC : met à jour des appareils spécifiques. GRAY : effectue une mise à jour progressive. Remarque La valeur ALL est renvoyée si vous appelez l’opération API CreateOTADynamicUpgradeJob pour créer un lot de mise à jour.
TimeoutInMinutes	Integer	5	Délai d’expiration de la mise à jour de l’appareil. Unité : minutes. Ce paramètre est renvoyé si le délai d’expiration est défini lors de la création du lot de mise à jour.
UtcCreate	String	2019-12-28T02:43:10.000Z	Heure de création du lot de mise à jour. L’heure est affichée au format UTC.
UtcEndTime	String	2019-12-29T02:43:10.000Z	Heure de fin du lot de mise à jour. L’heure est affichée au format UTC. Ce paramètre est renvoyé uniquement après la fin du lot de mise à jour.
UtcModified	String	2019-12-28T02:43:10.000Z	Heure de la dernière modification du lot de mise à jour. L’heure est affichée au format UTC.
UtcScheduleFinishTime	String	2019-12-30T02:43:10.000Z	Heure de fin du lot de mise à jour planifié. Ce paramètre est renvoyé uniquement si le lot de mise à jour est planifié et si l’heure de fin du lot de mise à jour planifié est spécifiée.
UtcScheduleTime	String	2019-12-29T02:43:10.000Z	Heure de début du lot de mise à jour planifié. Ce paramètre est renvoyé uniquement pour les lots de mise à jour planifiés.
UtcStartTime	String	2019-12-28T02:43:10.000Z	Heure de début du lot de mise à jour. L’heure est affichée au format UTC.
ErrorMessage	String	A system exception occurred.	Message d’erreur renvoyé en cas d’échec de l’appel.
RequestId	String	30F1BB8D-EDBF-44FD-BBC0-BE97DEA73991	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êtes

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryOTAJob
&JobId=wahVIzGkCMuAUE2gDERM02****
&<Common request parameters>

Exemple de réponses réussies

Format XML

<QueryOTAJobResponse>
  <Data>
        <TimeoutInMinutes>5</TimeoutInMinutes>
        <JobDesc>batch upgrade</JobDesc>
        <DownloadProtocol>HTTPS</DownloadProtocol>
        <UtcStartTime>2019-12-28T02:43:10.000Z</UtcStartTime>
        <UtcEndTime>2019-12-29T02:43:10.000Z</UtcEndTime>
        <ProductKey>a19mzPZ****</ProductKey>
        <UtcModified>2019-12-28T02:43:10.000Z</UtcModified>
        <JobStatus>IN_PROGRESS</JobStatus>
        <UtcCreate>2019-12-28T02:43:10.000Z</UtcCreate>
        <SelectionType>STATIC</SelectionType>
        <TargetSelection>SPECIFIC</TargetSelection>
        <JobType>UPGRADE_FIRMWARE</JobType>
        <GroupId></GroupId>
        <GroupName></GroupName>
        <RetryInterval>60</RetryInterval>
        <RetryCount>1</RetryCount>
        <OverwriteMode>1</OverwriteMode>
        <MultiModuleMode>true</MultiModuleMode>
        <MaximumPerMinute>1000</MaximumPerMinute>
        <SrcVersions>
              <SrcVersion>1.0.0</SrcVersion>
        </SrcVersions>
        <Name>firmware2</Name>
        <NeedConfirm>true</NeedConfirm>
        <NeedPush>false</NeedPush>
        <FirmwareId>UfuxnwygsuSkVE0VCN****0100</FirmwareId>
        <JobId>HvKuBpuk3rdk6E92CP****0200</JobId>
        <DestVersion>1.0.1</DestVersion>
  </Data>
  <RequestId>30F1BB8D-EDBF-44FD-BBC0-BE97DEA73991</RequestId>
  <Success>true</Success>
</QueryOTAJobResponse>

Format JSON

{
  "Data": {
    "TimeoutInMinutes": 5,
    "JobDesc": "batch upgrade",
    "DownloadProtocol":"HTTPS",
    "UtcStartTime": "2019-12-28T02:43:10.000Z",
    "UtcEndTime": "2019-12-29T02:43:10.000Z",
    "ProductKey": "a19mzPZ****",
    "UtcModified": "2019-12-28T02:43:10.000Z",
    "JobStatus": "IN_PROGRESS",
    "UtcCreate": "2019-12-28T02:43:10.000Z",
    "SelectionType": "STATIC",
    "TargetSelection": "SPECIFIC",
    "JobType": "UPGRADE_FIRMWARE",
    "GroupId":"",
    "GroupName":"",
    "RetryInterval":60,
    "RetryCount":1,
    "OverwriteMode":1,
    "MultiModuleMode":true,
    "MaximumPerMinute":1000,
    "SrcVersions": {
      "SrcVersion": ["1.0.0"]
    },
    "Name":"firmware2",
    "NeedConfirm":true,
    "NeedPush":false,
    "FirmwareId": "UfuxnwygsuSkVE0VCN****0100",
    "JobId": "HvKuBpuk3rdk6E92CP****0200",
    "DestVersion": "1.0.1"
  },
  "RequestId": "30F1BB8D-EDBF-44FD-BBC0-BE97DEA73991",
  "Success": true
}

Codes d’erreur

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