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

Consulta las tareas de actualización de un dispositivo por lote de actualización.

Límites de QPS

Cada cuenta de Alibaba Cloud puede ejecutar hasta 10 consultas por segundo (QPS).

Nota

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

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente 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í	ListOTATaskByJob	La operación que desea ejecutar. Establezca el valor en ListOTATaskByJob.
JobId	String	Sí	7glPHmaDYLAYMD1HHutT02****	El ID del lote de actualización. Este ID identifica de forma única el lote de actualización. Puede obtener este ID del valor del parámetro JobId que se devuelve después de llamar a la operación CreateOTAVerifyJob, CreateOTAStaticUpgradeJob o CreateOTADynamicUpgradeJob. También puede consultar 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. Puede consultar el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificarlo para este parámetro. De lo contrario, la llamada falla. Si no se genera la página Overview ni un ID para su instancia, no necesita configurar este parámetro. Para obtener más información, consulte Descripción general.
PageSize	Integer	No	10	El número de entradas que se devolverán en cada página. Valor máximo: 100. Importante El resultado de multiplicar el valor del parámetro CurrentPage por el valor del parámetro PageSize debe ser menor o igual que 100,000.
TaskStatus	String	No	FAILED	Si especifica un valor para este parámetro, solo se consultan las tareas de actualización que están en el estado especificado. Valores válidos: CONFIRM: La tarea de actualización está pendiente de confirmación. QUEUED: La notificación de actualización está en cola para su envío. NOTIFIED: La notificación de actualización se envió al dispositivo. IN_PROGRESS: La tarea de actualización está en curso. SUCCEEDED: La actualización se completó correctamente. FAILED: La actualización finalizó con errores. CANCELED: El lote de actualización se canceló. Si no especifica un valor para este parámetro, se consultan todas las tareas de actualización del lote especificado.
CurrentPage	Integer	No	1	El número de la página que se devolverá. Las páginas comienzan en la página 1. Importante El resultado de multiplicar el valor del parámetro CurrentPage por el valor del parámetro PageSize debe ser menor o igual que 100,000.
DeviceNames.N	RepeatList	No	device1	Los nombres de los dispositivos que desea consultar. Nota Puede especificar hasta 50 nombres de dispositivos. Si especifica un valor para este parámetro, no necesita configurar el parámetro PageSize ni el parámetro CurrentPage. Si especifica valores para los parámetros DeviceNames. N, PageSize y CurrentPage al mismo tiempo, se usa el valor del parámetro DeviceNames.N.

Además de los parámetros de solicitud específicos de la operación descritos anteriormente, debe configurar los parámetros de solicitud comunes al llamar a esta operación. Para obtener más información, consulte Parámetros de solicitud 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 obtener más información, consulte Códigos de error.
CurrentPage	Integer	1	El número de la página devuelta.
Data	Matriz de SimpleOTATaskInfo		La información de las tareas de actualización que se devuelve si la llamada se completa correctamente. Para obtener más información, consulte SimpleOTATaskInfo.
SimpleOTATaskInfo
DestVersion	String	1.0.1	La versión del paquete de actualización OTA (over-the-air) de destino.
DeviceName	String	testDevice2	El nombre del dispositivo.
FirmwareId	String	q3j9OYBjUAZMv1hlMgdo03****	El ID del paquete de actualización.
IotId	String	nadRdeffljdEndlfadgadfse****	El ID del dispositivo.
JobId	String	7glPHmaDYLAYMD1HHutT02****	El ID del lote de actualización.
ProductKey	String	a1GUfrM****	El ProductKey del producto al que pertenece el dispositivo.
ProductName	String	MyProduct	El nombre del producto al que pertenece el dispositivo.
Progress	String	0.00	El progreso actual de la actualización.
SrcVersion	String	1.0.0	La versión de firmware antes de la actualización.
TaskDesc	String	report version is not conform	La descripción de la tarea de actualización. Este parámetro muestra un mensaje de error si se agota el tiempo de espera de la actualización del dispositivo o si se cancela la tarea de actualización.
TaskId	String	y3tOmCDNgpR8F9jnVEzC01****	El ID de la tarea de actualización.
TaskStatus	String	FAILED	El estado de actualización del dispositivo. CONFIRM: La tarea de actualización está pendiente de confirmación. QUEUED: La notificación de actualización está en cola para su envío. NOTIFIED: La notificación de actualización se envió al dispositivo. IN_PROGRESS: La tarea de actualización está en curso. SUCCEEDED: La actualización se completó correctamente. FAILED: La actualización finalizó con errores. CANCELED: El lote de actualización se canceló.
Timeout	String	1440	El tiempo de espera de la actualización del dispositivo. Unidad: minutos. Nota Si no se especifica un tiempo de espera para el lote de actualización, el valor devuelto es null.
UtcCreate	String	2019-11-04T03:38:22.000Z	La hora en la que se creó la tarea de actualización. La hora se muestra en UTC.
UtcModified	String	2019-11-04T03:38:22.000Z	La hora en la que se modificó por última vez la tarea de actualización. La hora se muestra en UTC.
ErrorMessage	String	A system exception occurred.	El mensaje de error que se devuelve si la llamada falla.
PageCount	Integer	1	El número total de páginas devueltas.
PageSize	Integer	10	El número de entradas devueltas por página.
RequestId	String	A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada se completó correctamente. true: La llamada se completó correctamente. false: La llamada finalizó con errores.
Total	Integer	2	El número total de tareas de actualización.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTATaskByJob
&JobId=7glPHmaDYLAYMD1HHutT02****
&PageSize=10
&CurrentPage=1
&<Common request parameters>

Respuestas de ejemplo correctas

Formato XML

<ListOTATaskByJobResponse>
  <PageCount>1</PageCount>
  <Data>
        <SimpleOTATaskInfo>
              <SrcVersion>1.0.0</SrcVersion>
              <DeviceName>testDevice1</DeviceName>
              <FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
              <IotId>SR8FiTu1R9tlUR2V1bmi00105****</IotId>
              <ProductKey>a1GUfrM****</ProductKey>
              <JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
              <TaskDesc>report version is not conform</TaskDesc>
              <DestVersion>1.0.1</DestVersion>
              <Timeout>1440</Timeout>
              <UtcCreate>2019-11-04T03:38:15.000Z</UtcCreate>
              <UtcModified>2019-11-04T03:38:15.000Z</UtcModified>
              <TaskStatus>FAILED</TaskStatus>
              <ProductName>MyProduct</ProductName>
              <TaskId>y3tOmCDNgpR8F9jnVEzC01****</TaskId>
              <Progress>0.00</Progress>
        </SimpleOTATaskInfo>
        <SimpleOTATaskInfo>
              <SrcVersion>1.0.0</SrcVersion>
              <DeviceName>testDevice2</DeviceName>
              <FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
              <IotId>nadRdeffljdEndlfadgadfse****</IotId>
              <ProductKey>a1GUfrM****</ProductKey>
              <JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
              <TaskDesc></TaskDesc>
              <DestVersion>1.0.1</DestVersion>
              <Timeout>1000</Timeout>
              <UtcCreate>2019-11-04T03:38:22.000Z</UtcCreate>
              <UtcModified>2019-11-04T03:38:22.000Z</UtcModified>
              <TaskStatus>SUCCEEDED</TaskStatus>
              <ProductName>MyProduct</ProductName>
              <TaskId>ZS9sNBb1ahsu6khqr9II01****</TaskId>
              <Progress>100.00</Progress>
        </SimpleOTATaskInfo>
  </Data>
  <PageSize>10</PageSize>
  <RequestId>A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B</RequestId>
  <CurrentPage>1</CurrentPage>
  <Success>true</Success>
  <Total>2</Total>
</ListOTATaskByJobResponse>

Formato JSON

{
  "PageCount": 1,
  "Data": {
    "SimpleOTATaskInfo": [{
      "SrcVersion": "1.0.0",
      "DeviceName": "testDevice1",
      "FirmwareId": "q3j9OYBjUAZMv1hlMgdo03****",
      "IotId": "SR8FiTu1R9tlUR2V1bmi00105****",
      "ProductKey": "a1GUfrM****",
      "JobId": "7glPHmaDYLAYMD1HHutT02****",
      "TaskDesc": "report version is not conform",
      "DestVersion": "1.0.1",
      "Timeout":"1440",
      "UtcCreate": "2019-11-04T03:38:15.000Z",
      "UtcModified": "2019-11-04T03:38:15.000Z",
      "TaskStatus": "FAILED",
      "ProductName": "MyProduct",
      "TaskId": "y3tOmCDNgpR8F9jnVEzC01****",
      "Progress": "0.00"
    }, {
      "SrcVersion": "1.0.0",
      "DeviceName": "testDevice2",
      "FirmwareId": "q3j9OYBjUAZMv1hlMgdo03****",
      "IotId": "nadRdeffljdEndlfadgadfse****",
      "ProductKey": "a1GUfrM****",
      "JobId": "7glPHmaDYLAYMD1HHutT02****",
      "TaskDesc": "",
      "DestVersion": "1.0.1",
      "Timeout":"1000",
      "UtcCreate": "2019-11-04T03:38:22.000Z",
      "UtcModified": "2019-11-04T03:38:22.000Z",
      "TaskStatus": "SUCCEEDED",
      "ProductName": "MyProduct",
      "TaskId": "ZS9sNBb1ahsu6khqr9II01****",
      "Progress": "100.00"
    }]
  },
  "PageSize": 10,
  "RequestId": "A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B",
  "CurrentPage": 1,
  "Success": true,
  "Total": 2
}

Códigos de error

Para obtener una lista de códigos de error, visite el API Error Center.