CancelOTATaskByJob - IoT Platform - Centro de documentación de Alibaba Cloud

Cancele las tareas de actualización de dispositivos en un lote de actualización OTA específico.

Notas de uso

Debe especificar como mínimo uno de los siguientes parámetros: CancelScheduledTask, CancelQueuedTask, CancelInProgressTask, CancelNotifiedTask o CancelUnconfirmedTask. De lo contrario, la solicitud falla.

Límites de QPS

Cada cuenta de Alibaba Cloud puede invocar esta operación hasta cinco veces por segundo (QPS).

Nota

Los usuarios de RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, se recomienda invocar esta operación desde OpenAPI Explorer. Esta herramienta genera de forma dinámica el código de ejemplo de la operación para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	CancelOTATaskByJob	La operación que desea ejecutar. Establezca el valor en CancelOTATaskByJob.
JobId	String	Sí	7glPHmaDYLAYMD1HHutT02****	El ID del lote de actualización. Utilice el valor de JobId que devuelve la operación CreateOTAStaticUpgradeJob o CreateOTADynamicUpgradeJob. También puede obtener el ID del lote en la página Firmware Details de la consola de IoT Platform.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Consulte el ID en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificar este parámetro. De lo contrario, la llamada falla. Si la consola de IoT Platform no muestra la página Overview ni un ID de instancia, omita este parámetro. Para más información, consulte Descripción general.
CancelScheduledTask	Boolean	No	false	Indica si se cancelan las tareas de actualización de un lote programado. Se crea un lote de actualización programado cuando se especifica el parámetro ScheduleTime al invocar la operación CreateOTAStaticUpgradeJob. Valor predeterminado: false. Valores válidos: true: cancele las tareas de actualización de un lote programado. false: no cancele las tareas de actualización de un lote programado.
CancelQueuedTask	Boolean	No	false	Indica si se cancelan las tareas de actualización con estado QUEUED dentro de un lote de actualización. Valor predeterminado: false. Valores válidos: true: cancele las tareas de actualización con estado NOTIFIED. false: no cancele las tareas de actualización con estado NOTIFIED. Importante Si establece este parámetro en true y especifica el parámetro CancelUnconfirmedTask, solo se cancelan las tareas de actualización con estado QUEUED. Si no especifica el parámetro CancelUnconfirmedTask, se cancelan las tareas de actualización con estado QUEUED o CONFIRM.
CancelInProgressTask	Boolean	No	false	Indica si se cancelan las tareas de actualización con estado IN_PROGRESS dentro de un lote de actualización. Valor predeterminado: false. Valores válidos: true: cancele las tareas de actualización con estado IN_PROGRESS. false: no cancele las tareas de actualización con estado IN_PROGRESS.
CancelNotifiedTask	Boolean	No	false	Indica si se cancelan las tareas de actualización con estado NOTIFIED dentro de un lote de actualización. Valor predeterminado: false. Valores válidos: true: cancele las tareas de actualización con estado NOTIFIED. false: no cancele las tareas de actualización con estado NOTIFIED.
CancelUnconfirmedTask	Boolean	No	false	Indica si se cancelan las tareas de actualización con estado CONFIRM dentro de un lote de actualización. Valor predeterminado: false. Valores válidos: true: cancele las tareas de actualización con estado CONFIRM. false: no cancele las tareas de actualización con estado CONFIRM. Este parámetro está vacío de forma predeterminada. Importante Si no especifica este parámetro y establece el parámetro CancelQueuedTask en true, se cancelan las tareas de actualización con estado CONFIRM. Si establece el parámetro CancelQueuedTask en false, no se cancelan las tareas de actualización con estado CONFIRM.

Además de los parámetros de solicitud específicos de esta operación, debe especificar los parámetros de solicitud comunes al invocarla. Para más información, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error que se devuelve si la llamada falla. Para más información, consulte Códigos de error.
ErrorMessage	String	A system exception occurred.	El mensaje de error que se devuelve si la llamada falla.
RequestId	String	291438BA-6E10-4C4C-B761-243B9A0D324F	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true false

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

Formato XML

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

Formato JSON

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

Códigos de error

Para consultar la lista de códigos de error, consulte Códigos de error del servicio.