ListOTATaskByJob - IoT Platform - Centre de documentation Alibaba Cloud

Limites de QPS

Chaque compte Alibaba Cloud peut exécuter jusqu'à 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. 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

Parameter	Type	Required	Example	Description
Action	String	Yes	ListOTATaskByJob	L'opération à effectuer. Définissez la valeur sur ListOTATaskByJob.
JobId	String	Yes	7glPHmaDYLAYMD1HHutT02****	L'ID du lot de mise à jour. Cet ID identifie le lot de manière unique. Vous pouvez l'obtenir via la valeur du paramètre JobId renvoyée après un appel aux opérations CreateOTAVerifyJob, CreateOTAStaticUpgradeJob ou CreateOTADynamicUpgradeJob. Vous pouvez également consulter l'ID du lot sur la page Firmware Details de la console IoT Platform.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	L'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 le spécifier pour ce paramètre, sans quoi l'appel échouera. Si aucune page Overview ni aucun ID n'a été généré pour votre instance, ne configurez pas ce paramètre. Pour plus d'informations, consultez Overview.
PageSize	Integer	No	10	Le nombre d'entrées à renvoyer par page. Valeur maximale : 100. Important Le produit des valeurs des paramètres CurrentPage et PageSize doit être inférieur ou égal à 100 000.
TaskStatus	String	No	FAILED	Si vous spécifiez une valeur pour ce paramètre, seules les tâches de mise à jour correspondant à l'état indiqué sont interrogées. Valeurs valides : CONFIRM : La tâche de mise à jour est en attente de confirmation. QUEUED : La notification de mise à jour est en file d'attente pour envoi. NOTIFIED : La notification de mise à jour a été envoyée à l'appareil. IN_PROGRESS : La tâche de mise à jour est en cours. SUCCEEDED : La mise à jour a réussi. FAILED : La mise à jour a échoué. CANCELED : Le lot de mise à jour est annulé. Si vous ne spécifiez pas de valeur pour ce paramètre, toutes les tâches de mise à jour du lot spécifié sont interrogées.
CurrentPage	Integer	No	1	Le numéro de la page à renvoyer. La pagination commence à 1. Important Le produit des valeurs des paramètres CurrentPage et PageSize doit être inférieur ou égal à 100 000.
DeviceNames.N	RepeatList	No	device1	Les noms des appareils à interroger. Remarque Vous pouvez spécifier jusqu'à 50 noms d'appareils. Si vous spécifiez une valeur pour ce paramètre, il n'est pas nécessaire de configurer les paramètres PageSize ou CurrentPage. Si vous spécifiez simultanément des valeurs pour les paramètres DeviceNames.N, PageSize et CurrentPage, seule la valeur du paramètre DeviceNames.N est prise en compte.

Outre les paramètres de requête spécifiques à l'opération ci-dessus, vous devez configurer 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

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Le code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez Codes d'erreur.
CurrentPage	Integer	1	Le numéro de la page renvoyée.
Data	Array of SimpleOTATaskInfo		Les 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	La version du package de mise à jour OTA (Over-The-Air) cible.
DeviceName	String	testDevice2	Le nom de l'appareil.
FirmwareId	String	q3j9OYBjUAZMv1hlMgdo03****	L'ID du package de mise à jour.
IotId	String	nadRdeffljdEndlfadgadfse****	L'ID de l'appareil.
JobId	String	7glPHmaDYLAYMD1HHutT02****	L'ID du lot de mise à jour.
ProductKey	String	a1GUfrM****	Le ProductKey du produit auquel appartient l'appareil.
ProductName	String	MyProduct	Le nom du produit auquel appartient l'appareil.
Progress	String	0.00	La progression actuelle de la mise à jour.
SrcVersion	String	1.0.0	La version du firmware avant la mise à jour.
TaskDesc	String	report version is not conform	La description de la tâche de mise à jour. Ce paramètre affiche un message d'erreur si la mise à jour de l'appareil expire ou si la tâche est annulée.
TaskId	String	y3tOmCDNgpR8F9jnVEzC01****	L'ID de la tâche de mise à jour.
TaskStatus	String	FAILED	L'état de la mise à jour de l'appareil. CONFIRM : La tâche de mise à jour est en attente de confirmation. QUEUED : La notification de mise à jour est en file d'attente pour envoi. NOTIFIED : La notification de mise à jour a été envoyée à l'appareil. IN_PROGRESS : La tâche de mise à jour est en cours. SUCCEEDED : La mise à jour a réussi. FAILED : La mise à jour a échoué. CANCELED : Le lot de mise à jour est annulé.
Timeout	String	1440	Le délai d'expiration de la mise à jour de l'appareil. Unité : minutes. Remarque Si aucun délai d'expiration n'est spécifié pour le lot de mise à jour, la valeur de retour est nulle.
UtcCreate	String	2019-11-04T03:38:22.000Z	L'heure de création de la tâche de mise à jour, au format UTC.
UtcModified	String	2019-11-04T03:38:22.000Z	L'heure de la dernière modification de la tâche de mise à jour, au format UTC.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de l'appel.
PageCount	Integer	1	Le nombre total de pages renvoyées.
PageSize	Integer	10	Le nombre d'entrées renvoyées par page.
RequestId	String	A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B	L'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	2	Le nombre total de tâches de mise à jour.

Exemples

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTATaskByJob
&JobId=7glPHmaDYLAYMD1HHutT02****
&PageSize=10
&CurrentPage=1
&<Common request parameters>

Exemple de réponse réussie

Format XML

<ListOTATaskByJobResponse>
  <PageCount>1</PageCount>
  <Data>
        <SimpleOTATaskInfo>
              <SrcVersion>1.0.0</SrcVersion>
              <DeviceName>testDevice1</DeviceName>
              <FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
              <IotId>SR8FiTu1R9tlUR2V1bmi00105****</IotId>
              <ProductKey>a1GUfrM****</ProductKey>
              <JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
              <TaskDesc>report version is not conform</TaskDesc>
              <DestVersion>1.0.1</DestVersion>
              <Timeout>1440</Timeout>
              <UtcCreate>2019-11-04T03:38:15.000Z</UtcCreate>
              <UtcModified>2019-11-04T03:38:15.000Z</UtcModified>
              <TaskStatus>FAILED</TaskStatus>
              <ProductName>MyProduct</ProductName>
              <TaskId>y3tOmCDNgpR8F9jnVEzC01****</TaskId>
              <Progress>0.00</Progress>
        </SimpleOTATaskInfo>
        <SimpleOTATaskInfo>
              <SrcVersion>1.0.0</SrcVersion>
              <DeviceName>testDevice2</DeviceName>
              <FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
              <IotId>nadRdeffljdEndlfadgadfse****</IotId>
              <ProductKey>a1GUfrM****</ProductKey>
              <JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
              <TaskDesc></TaskDesc>
              <DestVersion>1.0.1</DestVersion>
              <Timeout>1000</Timeout>
              <UtcCreate>2019-11-04T03:38:22.000Z</UtcCreate>
              <UtcModified>2019-11-04T03:38:22.000Z</UtcModified>
              <TaskStatus>SUCCEEDED</TaskStatus>
              <ProductName>MyProduct</ProductName>
              <TaskId>ZS9sNBb1ahsu6khqr9II01****</TaskId>
              <Progress>100.00</Progress>
        </SimpleOTATaskInfo>
  </Data>
  <PageSize>10</PageSize>
  <RequestId>A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B</RequestId>
  <CurrentPage>1</CurrentPage>
  <Success>true</Success>
  <Total>2</Total>
</ListOTATaskByJobResponse>

Format JSON

{
  "PageCount": 1,
  "Data": {
    "SimpleOTATaskInfo": [{
      "SrcVersion": "1.0.0",
      "DeviceName": "testDevice1",
      "FirmwareId": "q3j9OYBjUAZMv1hlMgdo03****",
      "IotId": "SR8FiTu1R9tlUR2V1bmi00105****",
      "ProductKey": "a1GUfrM****",
      "JobId": "7glPHmaDYLAYMD1HHutT02****",
      "TaskDesc": "report version is not conform",
      "DestVersion": "1.0.1",
      "Timeout":"1440",
      "UtcCreate": "2019-11-04T03:38:15.000Z",
      "UtcModified": "2019-11-04T03:38:15.000Z",
      "TaskStatus": "FAILED",
      "ProductName": "MyProduct",
      "TaskId": "y3tOmCDNgpR8F9jnVEzC01****",
      "Progress": "0.00"
    }, {
      "SrcVersion": "1.0.0",
      "DeviceName": "testDevice2",
      "FirmwareId": "q3j9OYBjUAZMv1hlMgdo03****",
      "IotId": "nadRdeffljdEndlfadgadfse****",
      "ProductKey": "a1GUfrM****",
      "JobId": "7glPHmaDYLAYMD1HHutT02****",
      "TaskDesc": "",
      "DestVersion": "1.0.1",
      "Timeout":"1000",
      "UtcCreate": "2019-11-04T03:38:22.000Z",
      "UtcModified": "2019-11-04T03:38:22.000Z",
      "TaskStatus": "SUCCEEDED",
      "ProductName": "MyProduct",
      "TaskId": "ZS9sNBb1ahsu6khqr9II01****",
      "Progress": "100.00"
    }]
  },
  "PageSize": 10,
  "RequestId": "A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B",
  "CurrentPage": 1,
  "Success": true,
  "Total": 2
}

Codes d'erreur

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