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

Consulta las tareas de actualización pendientes de un dispositivo.

Límites de QPS

Puede llamar a esta operación hasta 10 veces por segundo por cuenta.

Nota

Los usuarios 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 su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListOTAUnfinishedTaskByDevice	La operación que desea ejecutar. Establezca el valor en ListOTAUnfinishedTaskByDevice.
IotInstanceId	String	No	iot-c3j***	El ID de la instancia. Puede obtener el ID de la instancia en la pestaña Descripción general de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificar el ID del parámetro. De lo contrario, la llamada fallará. Si no se genera ninguna pestaña Descripción general o ID para su instancia, no es necesario configurar este parámetro. Para obtener más información sobre las instancias, consulte Descripción general.
ModuleName	String	No	WifiConfigModify	El nombre del módulo de actualización OTA (over-the-air). Si especifica este parámetro, se consultan las tareas de actualización del módulo OTA indicado. Si no especifica este parámetro, se consultan las tareas de actualización de todos los módulos OTA.
TaskStatusList.N	RepeatList	No	QUEUED	El estado de la tarea de actualización que desea consultar. CONFIRM: La tarea de actualización está pendiente de confirmación. QUEUED: La tarea de actualización está en espera de envío. NOTIFIED: La tarea de actualización se envió al dispositivo. IN_PROGRESS: La tarea de actualización está en curso. Nota Puede especificar varios estados para TaskStatusList.N cuando llama a la operación ListOTAUnfinishedTaskByDevice. Debe configurar TaskStatusList.N o TaskStatus.
ProductKey	String	No	a19mzPZ****	La ProductKey del producto al que pertenece el dispositivo. Importante Si especifica un valor para este parámetro, debe configurar DeviceName.
DeviceName	String	No	light	El DeviceName del dispositivo. Importante Si configura este parámetro, debe especificar un valor para ProductKey.
TaskStatus	String	No	CONFIRM	El estado de la tarea de actualización que desea consultar. CONFIRM: La tarea de actualización está pendiente de confirmación. QUEUED: El paquete de actualización está en espera de envío. NOTIFIED: El paquete de actualización se envió al dispositivo. IN_PROGRESS: La tarea de actualización está en curso. Nota Solo puede especificar un estado para TaskStatus cuando llama a la operación ListOTAUnfinishedTaskByDevice. Debe configurar TaskStatusList o TaskStatus.
IotId	String	No	TfmUAeJjQQhCPH84UVNn0010c6****	El ID del dispositivo. Importante Si especifica un valor para este parámetro, no es necesario configurar ProductKey ni DeviceName. El parámetro IotId especifica un identificador único global (GUID) del dispositivo, que corresponde a una combinación de los valores de ProductKey y DeviceName. Si especifica valores para IotId, ProductKey y DeviceName, el valor de IotId tiene prioridad.

Además de los parámetros de solicitud específicos de la operación anteriores, debe configurar los parámetros de solicitud comunes al llamar a esta operación. Para obtener más información sobre los parámetros de solicitud comunes, consulte Common parameters.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la llamada falla. Para obtener más información, consulte Error codes.
Data	Array of SimpleOTATaskInfo		La información sobre la tarea de actualización devuelta si la llamada es exitosa. Para obtener más información, consulte SimpleOTATaskInfo.
SimpleOTATaskInfo
DestVersion	String	1.0.1	El número de versión del firmware después de la actualización.
DeviceName	String	light	El DeviceName del dispositivo.
FirmwareId	String	q3j9OYBjUAZMv1hlMgdo03****	El ID del paquete de actualización.
IotId	String	nadRdeffljdEndlfadgadfse****	El ID único del dispositivo asignado por IoT Platform. Es el identificador exclusivo que IoT Platform otorga al dispositivo.
JobId	String	7glPHmaDYLAYMD1HHutT02****	El ID del lote de actualización.
ModuleName	String	WifiConfigModify	El nombre del módulo OTA.
ProductKey	String	a1GUfrM****	La ProductKey del producto al que pertenece el dispositivo.
ProductName	String	MyProduct	El nombre del producto al que pertenece el dispositivo.
SrcVersion	String	1.0.0	La versión del firmware antes de la actualización.
TaskId	String	y3tOmCDNgpR8F9jnVEzC01****	El ID de la tarea de actualización.
TaskStatus	String	CONFIRM	El estado de la tarea de actualización. CONFIRM: La tarea de actualización está pendiente de confirmación. QUEUED: El paquete de actualización está en espera de envío. NOTIFIED: El paquete de actualización se envió al dispositivo. IN_PROGRESS: La tarea de actualización está en curso.
UtcCreate	String	2019-11-04T03:38:22.000Z	La hora en que se creó la tarea de actualización. La hora se muestra en formato UTC.
UtcModified	String	2021-11-04T03:38:22.000Z	La hora de la última modificación de la tarea de actualización. La hora se muestra en formato UTC.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B	El ID de la solicitud.
Success	Boolean	true	Indica si la solicitud fue exitosa. Valores válidos: true: La llamada fue exitosa. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAUnfinishedTaskByDevice
&ProductKey=a19mzPZ****
&DeviceName=light
&TaskStatus=CONFIRM
&<Common request parameters>

Respuestas exitosas de ejemplo

XML format

<ListOTAUnfinishedTaskByDevice>
  <Data>
        <SimpleOTATaskInfo>
              <SrcVersion>1.0.0</SrcVersion>
              <DeviceName>testDevice1</DeviceName>
              <FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
              <IotId>SR8FiTu1R9tlUR2V1bmi00105****</IotId>
              <ProductKey>a1GUfrM****</ProductKey>
              <JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
              <DestVersion>1.0.1</DestVersion>
              <UtcCreate>2019-11-04T03:38:15.000Z</UtcCreate>
              <UtcModified>2019-11-04T03:38:15.000Z</UtcModified>
              <TaskStatus>QUEUED</TaskStatus>
              <ProductName>MyProduct</ProductName>
              <TaskId>y3tOmCDNgpR8F9jnVEzC01****</TaskId>
              <ModuleName>WifiConfigModify</ModuleName>
        </SimpleOTATaskInfo>
        <SimpleOTATaskInfo>
              <SrcVersion>1.0.0</SrcVersion>
              <DeviceName>testDevice2</DeviceName>
              <FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
              <IotId>nadRdeffljdEndlfadgadfse****</IotId>
              <ProductKey>a1GUfrM****</ProductKey>
              <JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
              <DestVersion>1.0.1</DestVersion>
              <UtcCreate>2019-11-04T03:38:22.000Z</UtcCreate>
              <UtcModified>2019-11-04T03:38:22.000Z</UtcModified>
              <TaskStatus>CONFIRM</TaskStatus>
              <ProductName>MyProduct</ProductName>
              <TaskId>ZS9sNBb1ahsu6khqr9II01****</TaskId>
              <ModuleName>ConfigModify</ModuleName>
        </SimpleOTATaskInfo>
  </Data>
  <RequestId>A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B</RequestId>
  <Success>true</Success>
</ListOTAUnfinishedTaskByDevice>

JSON format

{
  "Data": {
    "SimpleOTATaskInfo": [{
      "SrcVersion": "1.0.0",
      "DeviceName": "testDevice1",
      "FirmwareId": "q3j9OYBjUAZMv1hlMgdo03****",
      "IotId": "SR8FiTu1R9tlUR2V1bmi00105****",
      "ProductKey": "a1GUfrM****",
      "JobId": "7glPHmaDYLAYMD1HHutT02****",
      "DestVersion": "1.0.1",
      "UtcCreate": "2019-11-04T03:38:15.000Z",
      "UtcModified": "2019-11-04T03:38:15.000Z",
      "TaskStatus": "QUEUED",
      "ProductName": "MyProduct",
      "TaskId": "y3tOmCDNgpR8F9jnVEzC01****",
      "ModuleName": "WifiConfigModify"
    }, {
      "SrcVersion": "1.0.0",
      "DeviceName": "testDevice2",
      "FirmwareId": "q3j9OYBjUAZMv1hlMgdo03****",
      "IotId": "nadRdeffljdEndlfadgadfse****",
      "ProductKey": "a1GUfrM****",
      "JobId": "7glPHmaDYLAYMD1HHutT02****",
      "DestVersion": "1.0.1",
      "UtcCreate": "2019-11-04T03:38:22.000Z",
      "UtcModified": "2019-11-04T03:38:22.000Z",
      "TaskStatus": "CONFIRM",
      "ProductName": "MyProduct",
      "TaskId": "ZS9sNBb1ahsu6khqr9II01****",
      "ModuleName": "ConfigModify"
    }]
  },
  "RequestId": "A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B",
  "Success": true
}

Códigos de error

HttpCode	Código de error	Mensaje de error	Descripción
400	iot.common.InvalidPageParams	The specified pagination size or pagination parameter is invalid.	El tamaño de página o el parámetro de paginación especificado no es válido.
400	iot.ota.NullOtaModuleName	the module name can not be empty.	No se especificó ningún nombre para el módulo.
400	iot.ota.InvalidOtaModuleName	the format of module name is invalid.	El nombre del módulo no es válido.
400	iot.firmware.InvalidTaskStatus	Invalid TaskStatus.	El estado del lote no es válido.
400	iot.device.InvalidFormattedDeviceNameInNameArray	The deviceName list contains an invalid device name.	Existe un DeviceName no válido en la lista de DeviceName.
400	iot.firmware.ListOTATaskByDeviceFailed	Failed to list OTA tasks by device.	El sistema no pudo obtener las tareas de actualización del dispositivo.
400	iot.prod.NotExistedProduct	The specified product does not exist.	El producto especificado no existe.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.