CreateOTAVerifyJob - IoT Platform - Centre de documentation Alibaba Cloud

Notes d'utilisation

Avant de déployer un package de mise à jour sur des appareils dans le cadre d'une mise à jour par lots, vous devez le vérifier. Seuls les packages vérifiés peuvent être utilisés pour les mises à jour par lots. Appelez l'opération QueryOTAFirmware pour consulter le statut de vérification.
Vous ne pouvez pas lancer une tâche de vérification pour un package en cours de vérification ou déjà vérifié avec succès.
Spécifiez jusqu'à 10 appareils pour une tâche de vérification.

Limites QPS

Chaque compte peut appeler cette opération jusqu'à 10 fois par seconde.

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 via 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	CreateOTAVerifyJob	Opération à effectuer. Définissez la valeur sur CreateOTAVerifyJob.
FirmwareId	String	Yes	nx3xxVvFdwvn6dim50PY03****	ID du package de mise à jour. Le paramètre FirmwareId est renvoyé lors de l'appel à l'opération CreateOTAFirmware pour créer un package de mise à jour OTA. Appelez également l'opération ListOTAFirmware pour obtenir l'ID du package.
ProductKey	String	Yes	a1VJwBw****	ProductKey du produit auquel appartient le package de mise à jour OTA.
Tag.N.Key	String	Yes	key1	Clé du tag du lot de mise à jour. La clé doit comporter entre 1 et 30 caractères et peut contenir des lettres, des chiffres et des points (.). Vous pouvez ajouter jusqu'à 10 tags à un lot de mise à jour. IoT Platform envoie les tags d'un lot de mise à jour aux appareils lors de la transmission des notifications de mise à jour. Remarque Les tags de lot de mise à jour sont facultatifs. Si vous souhaitez spécifier un tag, configurez les paramètres Tag.N.Value et Tag.N.Key par paire.
Tag.N.Value	String	Yes	value1	Valeur du tag du lot de mise à jour. La valeur doit comporter entre 1 et 1 024 caractères. Vous pouvez ajouter jusqu'à 10 tags pour chaque lot de mise à jour. La longueur totale des clés et des valeurs des tags de tous les lots de mise à jour ne peut pas dépasser 4 096 caractères. Remarque Les tags de lot de mise à jour sont facultatifs. Si vous souhaitez spécifier un tag, configurez les paramètres Tag.N.Value et Tag.N.Key par paire.
TargetDeviceName.N	RepeatList	Yes	testdevice	Appareil à spécifier dans la tâche de vérification. Remarque Les appareils doivent appartenir au même produit que le package de mise à jour. Chaque DeviceName doit être unique. Spécifiez jusqu'à 10 DeviceNames.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID de l'instance IoT. Affichez l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, spécifiez-le pour ce paramètre. Sinon, l'appel échoue. Si aucune page Overview ni aucun ID n'est généré pour votre instance, ne configurez pas ce paramètre. Pour plus d'informations, consultez la rubrique Overview.
TimeoutInMinutes	Integer	No.	1440	Délai d'expiration de la mise à jour du firmware par un appareil. Unité : minutes. Valeurs valides : 1 à 1440.
NeedPush	Boolean	No	true	Indique s'il faut pousser automatiquement les tâches de mise à jour vers les appareils. Valeurs valides : true (par défaut) : Après la création d'un lot de mise à jour, IoT Platform pousse automatiquement les tâches de mise à jour vers les appareils en ligne spécifiés. Dans ce cas, un appareil peut toujours initier une requête pour obtenir des informations sur la tâche de mise à jour OTA depuis IoT Platform. false : Un appareil doit initier une requête pour obtenir des informations sur la tâche de mise à jour OTA depuis IoT Platform.
NeedConfirm	Boolean	No	false	Indique si la mise à jour nécessite une confirmation via une application mobile. Développez l'application mobile selon vos besoins métier. Valeurs valides : false (par défaut) : Un appareil obtient des informations sur la tâche de mise à jour OTA en fonction de la valeur du paramètre NeedPush. true : Pour effectuer une mise à jour OTA sur un appareil, confirmez la mise à jour via votre application mobile. L'appareil peut ensuite obtenir des informations sur la tâche de mise à jour OTA en fonction de la valeur du paramètre NeedPush.
DownloadProtocol	String	No	HTTPS	Protocole utilisé par les appareils pour télécharger le package de mise à jour. Valeurs valides : HTTPS et MQTT. Valeur par défaut : HTTPS. Important Si vous téléchargez le package de mise à jour via HTTPS, la taille maximale du fichier de package est de 1 000 Mo. Formats de fichier pris en charge : `.bin`, `.dav`, `.tar`, `.gz`, `.zip`, `.gzip`, `.apk`, `.tar.gz`, `.tar.xz` ou `.pack`. Pour plus d'informations sur les limites, consultez la rubrique OTA update overview. Si vous souhaitez télécharger le package de mise à jour via MQTT, tenez compte des éléments suivants : Régions prises en charge : Chine (Shanghai), Chine (Pékin) et Chine (Shenzhen). Le package de mise à jour OTA ne peut contenir qu'un seul fichier dont la taille ne dépasse pas 16 Mo. Utilisez la dernière version du Link SDK for C pour développer les fonctionnalités de l'appareil afin d'effectuer des mises à jour OTA et de télécharger des fichiers via MQTT. Pour plus d'informations, consultez la rubrique Sample code of downloading an OTA update package that contains a single file over MQTT.

En plus des paramètres de requête spécifiques à l'opération, spécifiez les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations, consultez la rubrique Paramètres communs .

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 la rubrique Codes d'erreur.
Data	Struct		Informations sur la tâche renvoyées en cas de succès de l'appel. Consultez les paramètres suivants.
JobId	String	wahVIzGkCMuAUE2gDERM02****	ID de la tâche de vérification.
UtcCreate	String	2019-11-04T06:22:19.566Z	Heure de création de la tâche de vérification. 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	29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1	ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. Valeurs valides : true false

Exemples

Exemple de requête

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateOTAVerifyJob
&FirmwareId=nx3xxVvFdwvn6dim50PY03****
&ProductKey=a1VJwBw****
&Tag.1.Key=key1
&Tag.1.Value=value1
&TargetDeviceName.1=testdevice
&TimeoutInMinutes=1440
&<Common request parameters>

Exemple de réponse réussie

Format XML

<CreateOTAVerifyJobResponse>
   <Data>
       <JobId>wahVIzGkCMuAUE2gDERM02****</JobId>
       <UtcCreate>2019-11-04T06:22:19.566Z</UtcCreate>
   </Data>
   <RequestId>29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1</RequestId>
   <Success>true</Success>
</CreateOTAVerifyJobResponse>

Format JSON

{
  "Data": {
    "JobId": "wahVIzGkCMuAUE2gDERM02****",
    "UtcCreate": "2019-11-04T06:22:19.566Z"
  },
  "RequestId": "29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1",
  "Success": true
}

Codes d'erreur

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