ListOTAJobByDevice - Query OTA update batches by device - IoT Platform

Limites

Chaque compte Alibaba Cloud prend en charge jusqu'à 10 QPS.

Remarque

Les utilisateurs RAM partagent le quota du compte Alibaba Cloud.

Débogage

OpenAPI Explorer calcule les signatures et génère des exemples de code SDK. Appelez cette opération dans OpenAPI Explorer.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListOTAJobByDevice	Opération à effectuer. Définissez la valeur sur ListOTAJobByDevice.
CurrentPage	Integer	Yes	1	Numéro de page à renvoyer. La numérotation commence à 1.
DeviceName	String	Yes	light1	DeviceName de l'appareil.
FirmwareId	String	Yes	FJFx8JzpnhpIsKftRjjm03****	ID unique du package de mise à jour. Récupérez l'ID depuis la réponse de l'opération CreateOTAFirmware ou en appelant l'opération ListOTAFirmware.
PageSize	Integer	Yes	10	Nombre d'entrées par page. Valeur maximale : 100.
ProductKey	String	Yes	a19mzPZ****	ProductKey du produit auquel appartient l'appareil.
IotInstanceId	String	No	iot-cn-0pp1n8t****	ID de l'instance. Consultez l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, ce paramètre est obligatoire. À défaut, l'appel échoue. Si votre instance ne possède pas de page Overview ou d'ID, ce paramètre n'est pas requis. Overview.

En plus des paramètres précédents, spécifiez les paramètres de requête communs lors de l'appel de cette opération.

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	MissingFirmwareId	Code d'erreur renvoyé en cas d'échec de l'appel. Voir les Codes d'erreur.
CurrentPage	Integer	1	Numéro de page renvoyé.
Data	Array of SimpleOTAJobInfo		Informations sur le lot de mise à jour renvoyées en cas de succès. Voir le paramètre SimpleOTAJobInfo ci-dessous.
SimpleOTAJobInfo
FirmwareId	String	FJFx8JzpnhpIsKftRjjm03****	ID du package de mise à jour.
JobId	String	HvKuBpuk3rdk6E92CP****	ID du lot de mise à jour.
JobStatus	String	COMPLETED	Statut du lot de mise à jour. Valeurs possibles : IN_PROGRESS : Le lot de mise à jour est en cours. COMPLETE : Le lot de mise à jour est terminé. CANCELED : Le lot de mise à jour est annulé.
JobType	String	UPGRADE_FIRMWARE	Type de tâche. Valeurs possibles : VERFIY_FIRMWARE : vérification du package de mise à jour. UPGRADE_FIRMWARE : mise à jour par lot.
ProductKey	String	a19mzPZ****	ProductKey du produit auquel appartient le package de mise à jour.
SelectionType	String	STATIC	Politique de mise à jour. Valeurs possibles : DYNAMIC : mise à jour dynamique. Valeur renvoyée lorsque le lot est créé via l'opération CreateOTADynamicUpgradeJob. STATIC : mise à jour statique. Valeur renvoyée lorsque le lot est créé via l'opération CreateOTAStaticUpgradeJob.
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	ALL	Étendue de la mise à jour. Valeurs possibles : ALL : met à jour tous les appareils. SPECIFIC : met à jour les appareils spécifiés. GRAY : effectue une mise à jour progressive. Remarque La valeur ALL est renvoyée lorsque le lot est créé via l'opération CreateOTADynamicUpgradeJob.
UtcCreate	String	2019-12-28T02:43:10.000Z	Heure de création du lot de mise à jour, au format UTC.
UtcEndTime	String	2019-12-29T02:43:10.000Z	Heure de fin du lot de mise à jour, au format UTC. Remarque Renvoyé uniquement après la fin du lot de mise à jour.
UtcModified	String	2019-12-29T02:43:10.000Z	Heure de la dernière modification de la tâche, au format UTC.
UtcStartTime	String	2019-12-29T02:43:10.000Z	Heure de début du lot de mise à jour, au format UTC.
ErrorMessage	String	FirmwareId is mandatory for this action	Message d'erreur renvoyé en cas d'échec de l'appel.
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 réussi. true : L'appel a réussi. false : L'appel a échoué.
Total	Integer	1	Nombre total de packages de mise à jour renvoyés.

Exemples

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAJobByDevice
&FirmwareId=FJFx8JzpnhpIsKftRjjm03****
&ProductKey=a19mzPZ****
&DeviceName=light
&PageSize=10
&CurrentPage=1
&Common request parameter

Exemple de réponse réussie

Format XML

<ListOTAJobByDeviceResponse>
  <PageCount>1</PageCount>
  <Data>
        <SimpleOTAJobInfo>
              <SelectionType>STATIC</SelectionType>
              <TargetSelection>SPECIFIC</TargetSelection>
              <JobType>UPGRADE_FIRMWARE</JobType>
              <FirmwareId>FJFx8JzpnhpIsKftRjjm03****</FirmwareId>
              <UtcStartTime>2019-12-28T02:43:10.000Z</UtcStartTime>
              <ProductKey>a19mzPZ****</ProductKey>
              <JobId>HvKuBpuk3rdk6E92CPQN02****</JobId>
              <UtcModified>2019-12-28T02:43:10.000Z</UtcModified>
              <JobStatus>IN_PROGRESS</JobStatus>
              <UtcCreate>2019-12-28T02:43:10.000Z</UtcCreate>
        </SimpleOTAJobInfo>
  </Data>
  <PageSize>10</PageSize>
  <RequestId>5D58AC86-D5BF-4B39-834E-913E7F2C985D</RequestId>
  <CurrentPage>1</CurrentPage>
  <Success>true</Success>
  <Total>1</Total>
</ListOTAJobByDeviceResponse>

Format JSON

{
  "PageCount": 1,
  "Data": {
    "SimpleOTAJobInfo": [{
      "SelectionType": "STATIC",
      "TargetSelection": "SPECIFIC",
      "JobType": "UPGRADE_FIRMWARE",
      "FirmwareId": "FJFx8JzpnhpIsKftRjjm03****",
      "UtcStartTime": "2019-12-28T02:43:10.000Z",
      "ProductKey": "a19mzPZ****",
      "JobId": "HvKuBpuk3rdk6E92CPQN02****",
      "UtcModified": "2019-12-28T02:43:10.000Z",
      "JobStatus": "IN_PROGRESS",
      "UtcCreate": "2019-12-28T02:43:10.000Z"
    }]
  },
  "PageSize": 10,
  "RequestId": "5D58AC86-D5BF-4B39-834E-913E7F2C985D",
  "CurrentPage": 1,
  "Success": true,
  "Total": 1
}

Codes d'erreur

Pour consulter les codes d'erreur, rendez-vous sur le Centre d'erreurs API.