ListOTAUnfinishedTaskByDevice - IoT Platform - Centre de documentation Alibaba Cloud

Limites QPS

Vous pouvez appeler cette opération jusqu'à 10 fois par seconde par compte.

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 des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListOTAUnfinishedTaskByDevice	Opération à effectuer. Définissez la valeur sur ListOTAUnfinishedTaskByDevice.
IotInstanceId	String	No	iot-c3j***	ID de l'instance. Vous pouvez obtenir l'ID de l'instance dans l'onglet Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez le spécifier pour ce paramètre, sinon l'appel échouera. Si aucun onglet Overview ou ID n'est généré pour votre instance, vous n'avez pas besoin de configurer ce paramètre. Pour plus d'informations sur les instances, consultez Overview.
ModuleName	String	No	WifiConfigModify	Nom du module OTA (Over-The-Air). Si vous spécifiez ce paramètre, seules les tâches de mise à jour du module OTA indiqué sont répertoriées. Si vous ne spécifiez pas ce paramètre, les tâches de mise à jour de tous les modules OTA sont répertoriées.
TaskStatusList.N	RepeatList	No	QUEUED	Statut de la tâche de mise à jour à interroger. CONFIRM : La tâche de mise à jour est en attente de confirmation. QUEUED : La tâche de mise à jour est en file d'attente pour envoi. NOTIFIED : La tâche de mise à jour a été envoyée à l'appareil. IN_PROGRESS : La tâche de mise à jour est en cours. Remarque Lors de l'appel à l'opération ListOTAUnfinishedTaskByDevice, vous pouvez spécifier plusieurs statuts pour TaskStatusList.N. Vous devez configurer TaskStatusList.N ou TaskStatus.
ProductKey	String	No	a19mzPZ****	ProductKey du produit auquel appartient l'appareil. Important Si vous spécifiez une valeur pour ce paramètre, vous devez également configurer DeviceName.
DeviceName	String	No	light	DeviceName de l'appareil. Important Si vous configurez ce paramètre, vous devez spécifier une valeur pour ProductKey.
TaskStatus	String	No	CONFIRM	Statut de la tâche de mise à jour à interroger. CONFIRM : La tâche de mise à jour est en attente de confirmation. QUEUED : Le package de mise à jour est en file d'attente pour envoi. NOTIFIED : Le package de mise à jour a été envoyé à l'appareil. IN_PROGRESS : La tâche de mise à jour est en cours. Remarque Lors de l'appel à l'opération ListOTAUnfinishedTaskByDevice, vous ne pouvez spécifier qu'un seul statut pour TaskStatus. Vous devez configurer TaskStatusList ou TaskStatus.
IotId	String	No	TfmUAeJjQQhCPH84UVNn0010c6****	ID de l'appareil. Important Si vous spécifiez une valeur pour ce paramètre, vous n'avez pas besoin de configurer ProductKey ni DeviceName. Le paramètre IotId correspond à l'identifiant unique global (GUID) de l'appareil, qui équivaut à la combinaison des valeurs de ProductKey et de DeviceName. Si vous spécifiez des valeurs pour IotId, ProductKey et DeviceName, la valeur de IotId est prioritaire.

Outre les paramètres de requête spécifiques à l'opération mentionnés ci-dessus, vous devez configurer les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations sur les paramètres de requête communs, consultez Common parameters.

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. Pour plus d'informations, consultez Error codes.
Data	Array of SimpleOTATaskInfo		Informations sur la tâche de mise à jour renvoyées en cas de succès de l'appel. Pour plus d'informations, consultez SimpleOTATaskInfo.
SimpleOTATaskInfo
DestVersion	String	1.0.1	Numéro de version du firmware après la mise à jour.
DeviceName	String	light	DeviceName de l'appareil.
FirmwareId	String	q3j9OYBjUAZMv1hlMgdo03****	ID du package de mise à jour.
IotId	String	nadRdeffljdEndlfadgadfse****	ID unique de l'appareil attribué par IoT Platform.
JobId	String	7glPHmaDYLAYMD1HHutT02****	ID du lot de mise à jour.
ModuleName	String	WifiConfigModify	Nom du module OTA.
ProductKey	String	a1GUfrM****	ProductKey du produit auquel appartient l'appareil.
ProductName	String	MyProduct	Nom du produit auquel appartient l'appareil.
SrcVersion	String	1.0.0	Version du firmware avant la mise à jour.
TaskId	String	y3tOmCDNgpR8F9jnVEzC01****	ID de la tâche de mise à jour.
TaskStatus	String	CONFIRM	Statut de la tâche de mise à jour. CONFIRM : La tâche de mise à jour est en attente de confirmation. QUEUED : Le package de mise à jour est en file d'attente pour envoi. NOTIFIED : Le package de mise à jour a été envoyé à l'appareil. IN_PROGRESS : La tâche de mise à jour est en cours.
UtcCreate	String	2019-11-04T03:38:22.000Z	Date et heure de création de la tâche de mise à jour (format UTC).
UtcModified	String	2021-11-04T03:38:22.000Z	Date et heure de la dernière modification de la tâche de mise à jour (format UTC).
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B	ID de la requête.
Success	Boolean	true	Indique si la requête a abouti. Valeurs possibles : true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemple de requête

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAUnfinishedTaskByDevice
&ProductKey=a19mzPZ****
&DeviceName=light
&TaskStatus=CONFIRM
&<Common request parameters>

Exemple de réponse réussie

Format XML

<ListOTAUnfinishedTaskByDevice>
  <Data>
        <SimpleOTATaskInfo>
              <SrcVersion>1.0.0</SrcVersion>
              <DeviceName>testDevice1</DeviceName>
              <FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
              <IotId>SR8FiTu1R9tlUR2V1bmi00105****</IotId>
              <ProductKey>a1GUfrM****</ProductKey>
              <JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
              <DestVersion>1.0.1</DestVersion>
              <UtcCreate>2019-11-04T03:38:15.000Z</UtcCreate>
              <UtcModified>2019-11-04T03:38:15.000Z</UtcModified>
              <TaskStatus>QUEUED</TaskStatus>
              <ProductName>MyProduct</ProductName>
              <TaskId>y3tOmCDNgpR8F9jnVEzC01****</TaskId>
              <ModuleName>WifiConfigModify</ModuleName>
        </SimpleOTATaskInfo>
        <SimpleOTATaskInfo>
              <SrcVersion>1.0.0</SrcVersion>
              <DeviceName>testDevice2</DeviceName>
              <FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
              <IotId>nadRdeffljdEndlfadgadfse****</IotId>
              <ProductKey>a1GUfrM****</ProductKey>
              <JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
              <DestVersion>1.0.1</DestVersion>
              <UtcCreate>2019-11-04T03:38:22.000Z</UtcCreate>
              <UtcModified>2019-11-04T03:38:22.000Z</UtcModified>
              <TaskStatus>CONFIRM</TaskStatus>
              <ProductName>MyProduct</ProductName>
              <TaskId>ZS9sNBb1ahsu6khqr9II01****</TaskId>
              <ModuleName>ConfigModify</ModuleName>
        </SimpleOTATaskInfo>
  </Data>
  <RequestId>A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B</RequestId>
  <Success>true</Success>
</ListOTAUnfinishedTaskByDevice>

Format JSON

{
  "Data": {
    "SimpleOTATaskInfo": [{
      "SrcVersion": "1.0.0",
      "DeviceName": "testDevice1",
      "FirmwareId": "q3j9OYBjUAZMv1hlMgdo03****",
      "IotId": "SR8FiTu1R9tlUR2V1bmi00105****",
      "ProductKey": "a1GUfrM****",
      "JobId": "7glPHmaDYLAYMD1HHutT02****",
      "DestVersion": "1.0.1",
      "UtcCreate": "2019-11-04T03:38:15.000Z",
      "UtcModified": "2019-11-04T03:38:15.000Z",
      "TaskStatus": "QUEUED",
      "ProductName": "MyProduct",
      "TaskId": "y3tOmCDNgpR8F9jnVEzC01****",
      "ModuleName": "WifiConfigModify"
    }, {
      "SrcVersion": "1.0.0",
      "DeviceName": "testDevice2",
      "FirmwareId": "q3j9OYBjUAZMv1hlMgdo03****",
      "IotId": "nadRdeffljdEndlfadgadfse****",
      "ProductKey": "a1GUfrM****",
      "JobId": "7glPHmaDYLAYMD1HHutT02****",
      "DestVersion": "1.0.1",
      "UtcCreate": "2019-11-04T03:38:22.000Z",
      "UtcModified": "2019-11-04T03:38:22.000Z",
      "TaskStatus": "CONFIRM",
      "ProductName": "MyProduct",
      "TaskId": "ZS9sNBb1ahsu6khqr9II01****",
      "ModuleName": "ConfigModify"
    }]
  },
  "RequestId": "A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B",
  "Success": true
}

Codes d'erreur

HttpCode	Error Code	Error message	Description
400	iot.common.InvalidPageParams	The specified pagination size or pagination parameter is invalid.	La taille de page ou le numéro de page spécifié n'est pas valide.
400	iot.ota.NullOtaModuleName	the module name can not be empty.	Aucun nom n'est spécifié pour le module.
400	iot.ota.InvalidOtaModuleName	the format of module name is invalid.	Le nom du module n'est pas valide.
400	iot.firmware.InvalidTaskStatus	Invalid TaskStatus.	Le statut du lot n'est pas valide.
400	iot.device.InvalidFormattedDeviceNameInNameArray	The deviceName list contains an invalid device name.	La liste DeviceName contient un DeviceName non valide.
400	iot.firmware.ListOTATaskByDeviceFailed	Failed to list OTA tasks by device.	Échec de la récupération des tâches de mise à jour de l'appareil.
400	iot.prod.NotExistedProduct	The specified product does not exist.	Le produit spécifié n'existe pas.

Pour obtenir la liste des codes d'erreur, consultez Codes d'erreur de service.