CancelOTATaskByJob - IoT Platform - Centre de documentation Alibaba Cloud

Notes d'utilisation

Spécifiez au moins l'un des paramètres suivants : CancelScheduledTask, CancelQueuedTask, CancelInProgressTask, CancelNotifiedTask ou CancelUnconfirmedTask. À défaut, la requête échoue.

Limites QPS

Chaque compte Alibaba Cloud peut appeler cette opération jusqu'à cinq fois 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. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	CancelOTATaskByJob	Opération à effectuer. Définissez la valeur sur CancelOTATaskByJob.
JobId	String	Yes	7glPHmaDYLAYMD1HHutT02****	ID du lot de mise à jour. Utilisez la valeur JobId renvoyée par l'opération CreateOTAStaticUpgradeJob ou CreateOTADynamicUpgradeJob. Vous pouvez également obtenir l'ID du lot sur la page Firmware Details de la console IoT Platform.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID de l'instance. Vous pouvez afficher l'ID sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez spécifier ce paramètre. À défaut, l'appel échouera. Si la page Overview ou un ID d'instance n'est pas affiché dans la console IoT Platform, ignorez ce paramètre. Pour plus d'informations, consultez Overview.
CancelScheduledTask	Boolean	No	false	Indique s'il faut annuler les tâches de mise à jour d'un lot de mise à jour planifié. Si vous spécifiez le paramètre ScheduleTime lors de l'appel de l'opération CreateOTAStaticUpgradeJob, un lot de mise à jour planifié est créé. Valeur par défaut : false. Valeurs valides : true : annule les tâches de mise à jour d'un lot de mise à jour planifié. false : n'annule pas les tâches de mise à jour d'un lot de mise à jour planifié.
CancelQueuedTask	Boolean	No	false	Indique s'il faut annuler les tâches de mise à jour dans l'état QUEUED d'un lot de mise à jour. Valeur par défaut : false. Valeurs valides : true : annule les tâches de mise à jour dans l'état NOTIFIED. false : n'annule pas les tâches de mise à jour dans l'état NOTIFIED. Important Si vous définissez ce paramètre sur true et spécifiez le paramètre CancelUnconfirmedTask, seules les tâches de mise à jour dans l'état QUEUED sont annulées. Si vous ne spécifiez pas le paramètre CancelUnconfirmedTask, les tâches de mise à jour dans l'état QUEUED ou CONFIRM sont annulées.
CancelInProgressTask	Boolean	No	false	Indique s'il faut annuler les tâches de mise à jour dans l'état IN_PROGRESS d'un lot de mise à jour. Valeur par défaut : false. Valeurs valides : true : annule les tâches de mise à jour dans l'état IN_PROGRESS. false : n'annule pas les tâches de mise à jour dans l'état IN_PROGRESS.
CancelNotifiedTask	Boolean	No	false	Indique s'il faut annuler les tâches de mise à jour dans l'état NOTIFIED d'un lot de mise à jour. Valeur par défaut : false. Valeurs valides : true : annule les tâches de mise à jour dans l'état NOTIFIED. false : n'annule pas les tâches de mise à jour dans l'état NOTIFIED.
CancelUnconfirmedTask	Boolean	No	false	Indique s'il faut annuler les tâches de mise à jour dans l'état CONFIRM d'un lot de mise à jour. Valeur par défaut : false. Valeurs valides : true : annule les tâches de mise à jour dans l'état CONFIRM. false : n'annule pas les tâches de mise à jour dans l'état CONFIRM. Ce paramètre est vide par défaut. Important Si vous ne spécifiez pas ce paramètre et définissez le paramètre CancelQueuedTask sur true, les tâches de mise à jour dans l'état CONFIRM sont annulées. Si vous définissez le paramètre CancelQueuedTask sur false, les tâches de mise à jour dans l'état CONFIRM ne sont pas annulées.

En plus des paramètres de requête spécifiques à l'opération, vous devez spécifier les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations, consultez 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 Codes d'erreur.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	291438BA-6E10-4C4C-B761-243B9A0D324F	ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. true false

Exemples

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=CancelOTATaskByJob
&JobId=7glPHmaDYLAYMD1HHutT02****
&CancelScheduledTask=false
&CancelQueuedTask=true
&CancelNotifiedTask=false
&CancelInProgressTask=false
&<Common request parameters>

Exemples de réponses réussies

XML format

<CancelOTATaskByJobResponse>
    <RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
    <Success>true</Success>
</CancelOTATaskByJobResponse>

JSON format

{
  "RequestId": "291438BA-6E10-4C4C-B761-243B9A0D324F",
  "Success": true
}

Codes d'erreur

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