ListOTAJobByFirmware - IoT Platform - Centre de documentation Alibaba Cloud

Répertorie les lots de mise à jour d'un micrologiciel.

Limites

Chaque compte Alibaba Cloud peut effectuer jusqu'à 10 requêtes par seconde (QPS).

Remarque

Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota de ce 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

Parameter	Type	Required	Example	Description
Action	String	Yes	ListOTAJobByFirmware	L'opération à effectuer. Définissez la valeur sur ListOTAJobByFirmware.
CurrentPage	Integer	Yes	1	Le numéro de la page à renvoyer. La numérotation commence à 1.
FirmwareId	String	Yes	FJFx8JzpnhpIsKftRjjm03****	L'ID du micrologiciel. Cet ID est renvoyé lorsque vous appelez l'opération CreateOTAFirmware pour créer le micrologiciel. Vous pouvez également consulter l'ID du micrologiciel dans la réponse de l'opération ListOTAFirmware.
PageSize	Integer	Yes	10	Le nombre d'entrées par page. Valeur maximale : 200.
IotInstanceId	String	No	iot-cn-0pp1n8t****	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 renseigner ce paramètre, sinon l'appel échoue. Si votre instance ne possède pas de page Overview ou d'ID, il n'est pas nécessaire de définir ce paramètre. Pour plus d'informations, consultez Overview.

Outre les paramètres spécifiques à l'opération, vous devez inclure les paramètres de requête communs lors de l'appel. 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 SimpleOTAJobInfo		Les informations sur le lot de mise à jour renvoyées en cas de succès. Pour plus d'informations, consultez SimpleOTATaskInfo.
SimpleOTAJobInfo
FirmwareId	String	UfuxnwygsuSkVE0VCN****0100	L'ID du micrologiciel.
JobId	String	HvKuBpuk3rdk6E92CP****0200	L'ID du lot de mise à jour.
JobStatus	String	IN_PROGRESS	Le statut du lot de mise à jour. PLANNED : Le lot est planifié. Il a été créé, mais l'heure programmée n'est pas encore atteinte. Ce statut n'apparaît que pour les mises à jour statiques. IN_PROGRESS : Le lot est en cours d'exécution. COMPLETE : Le lot est terminé. CANCELED : Le lot est annulé.
JobType	String	UPGRADE_FIRMWARE	Le type de lot. Valeurs possibles : VERFIY_FIRMWARE : vérification du micrologiciel. UPGRADE_FIRMWARE : mise à jour par lot.
ProductKey	String	a19mzPZ****	Le ProductKey du produit associé au micrologiciel.
SelectionType	String	STATIC	La stratégie de sélection des appareils pour le lot. Valeurs possibles : DYNAMIC : mise à jour dynamique. Cette valeur est renvoyée si vous avez créé le lot via l'opération API CreateOTADynamicUpgradeJob. STATIC : mise à jour statique. Cette valeur est renvoyée si vous avez créé le lot via l'opération API CreateOTAStaticUpgradeJob.
Tags	Array of OtaTagDTO		Les tags associés au lot de mise à jour.
OtaTagDTO
Key	String	key1	La clé du tag.
Value	String	value1	La valeur du tag.
TargetSelection	String	SPECIFIC	La cible de la mise à jour. Valeurs possibles : ALL : tous les appareils. SPECIFIC : appareils spécifiques. GRAY : mise à jour progressive (canary). Remarque La valeur ALL est renvoyée si vous avez créé le lot via l'opération API CreateOTADynamicUpgradeJob.
UtcCreate	String	2019-12-28T02:43:10.000Z	L'heure de création du lot, au format UTC.
UtcEndTime	String	2019-12-29T02:43:10.000Z	L'heure de fin du lot, au format UTC. Ce paramètre n'est renvoyé qu'une fois le lot terminé.
UtcModified	String	2019-12-28T02:43:10.000Z	L'heure de la dernière modification du lot, au format UTC.
UtcStartTime	String	2019-12-28T02:43:10.000Z	L'heure de début du lot, 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.
PageSize	Integer	10	Le nombre d'entrées par page.
RequestId	String	5D58AC86-D5BF-4B39-834E-913E7F2C985D	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	1	Le nombre total de lots de mise à jour renvoyés.

Exemples

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAJobByFirmware
&FirmwareId=FJFx8JzpnhpIsKftRjjm03****
&PageSize=10
&CurrentPage=1
&<Common request parameters>

Exemple de réponse réussie

Format XML

<ListOTAJobByFirmwareResponse>
    <PageCount>1</PageCount>
    <Data>
        <SimpleOTAJobInfo>
            <SelectionType>STATIC</SelectionType>
            <TargetSelection>SPECIFIC</TargetSelection>
            <JobType>UPGRADE_FIRMWARE</JobType>
            <FirmwareId>yLYuCqfqQNQ1JOqkDa****0100</FirmwareId>
            <UtcStartTime>2019-12-28T02:43:10.000Z</UtcStartTime>
            <UtcEndTime>2019-12-29T02:43:10.000Z</UtcEndTime>
            <ProductKey>a19mzPZ****</ProductKey>
            <JobId>HvKuBpuk3rdk6E92CP****0200</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>
</ListOTAJobByFirmwareResponse>

Format JSON

{
  "PageCount": 1,
  "Data": {
    "SimpleOTAJobInfo": [{
      "SelectionType": "STATIC",
      "TargetSelection": "SPECIFIC",
      "JobType": "UPGRADE_FIRMWARE",
      "FirmwareId": "UfuxnwygsuSkVE0VCN****0100",
      "UtcStartTime": "2019-12-28T02:43:10.000Z",
      "UtcEndTime": "2019-12-29T02:43:10.000Z",
      "ProductKey": "a19mzPZ****",
      "JobId": "HvKuBpuk3rdk6E92CP****0200",
      "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 obtenir la liste des codes d'erreur, consultez le Centre d'erreurs API.