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

Consulta los lotes de actualización OTA de un dispositivo según el paquete de actualización.

Límites

Cada cuenta de Alibaba Cloud admite hasta 10 QPS.

Nota

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

Depuración

OpenAPI Explorer calcula las firmas y genera ejemplos de código del SDK. Ejecute esta operación en OpenAPI Explorer.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListOTAJobByDevice	Operación que se va a ejecutar. Establezca el valor en ListOTAJobByDevice.
CurrentPage	Integer	Sí	1	Número de página que se devuelve. La numeración comienza en 1.
DeviceName	String	Sí	light1	El DeviceName del dispositivo.
FirmwareId	String	Sí	FJFx8JzpnhpIsKftRjjm03****	Identificador único del paquete de actualización. Obtenga este identificador en la respuesta de CreateOTAFirmware o al llamar a ListOTAFirmware.
PageSize	Integer	Sí	10	Cantidad de entradas por página. Valor máximo: 100.
ProductKey	String	Sí	a19mzPZ****	El ProductKey del producto al que pertenece el dispositivo.
IotInstanceId	String	No	iot-cn-0pp1n8t****	Identificador de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un identificador, este parámetro es obligatorio. De lo contrario, la llamada falla. Si su instancia no tiene una página Overview ni un identificador, este parámetro no es necesario. Descripción general.

Además de los parámetros anteriores, especifique los parámetros de solicitud comunes al llamar a esta operación.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	MissingFirmwareId	Código de error devuelto si la llamada falla. Consulte Códigos de error.
CurrentPage	Integer	1	Número de página devuelto.
Data	Array of SimpleOTAJobInfo		Información del lote de actualización devuelta cuando la operación es exitosa. Consulte el parámetro SimpleOTAJobInfo más abajo.
SimpleOTAJobInfo
FirmwareId	String	FJFx8JzpnhpIsKftRjjm03****	Identificador del paquete de actualización.
JobId	String	HvKuBpuk3rdk6E92CP****	Identificador del lote de actualización.
JobStatus	String	COMPLETED	Estado del lote de actualización. Valores válidos: IN_PROGRESS: el lote de actualización se está ejecutando. COMPLETE: el lote de actualización finalizó. CANCELED: el lote de actualización se canceló.
JobType	String	UPGRADE_FIRMWARE	Tipo de tarea. Valores válidos: VERFIY_FIRMWARE: verificación del paquete de actualización. UPGRADE_FIRMWARE: actualización por lotes.
ProductKey	String	a19mzPZ****	El ProductKey del producto al que pertenece el paquete de actualización.
SelectionType	String	STATIC	Política de actualización. Valores válidos: DYNAMIC: actualización dinámica. Se devuelve cuando el lote se crea mediante CreateOTADynamicUpgradeJob. STATIC: actualización estática. Se devuelve cuando el lote se crea mediante CreateOTAStaticUpgradeJob.
Tags	Array of OtaTagDTO		Etiquetas del lote de actualización.
OtaTagDTO
Key	String	key1	Clave de cada etiqueta.
Value	String	value1	Valor de la etiqueta.
TargetSelection	String	ALL	Alcance de la actualización. Valores válidos: ALL: actualiza todos los dispositivos. SPECIFIC: actualiza los dispositivos especificados. GRAY: aplica una actualización gradual. Nota Se devuelve ALL cuando el lote se crea mediante CreateOTADynamicUpgradeJob.
UtcCreate	String	2019-12-28T02:43:10.000Z	Hora de creación del lote de actualización, en formato UTC.
UtcEndTime	String	2019-12-29T02:43:10.000Z	Hora de finalización del lote de actualización, en formato UTC. Nota Se devuelve solo después de que el lote de actualización termina.
UtcModified	String	2019-12-29T02:43:10.000Z	Hora de la última modificación de la tarea, en formato UTC.
UtcStartTime	String	2019-12-29T02:43:10.000Z	Hora de inicio del lote de actualización, en formato UTC.
ErrorMessage	String	FirmwareId is mandatory for this action	Mensaje de error devuelto si la llamada falla.
PageCount	Integer	1	Número total de páginas.
PageSize	Integer	10	Cantidad de entradas devueltas por página.
RequestId	String	A01829CE-75A1-4920-B775-921146A1AB79	Identificador de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: la llamada fue exitosa. false: la llamada terminó con errores.
Total	Integer	1	Número total de paquetes de actualización devueltos.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAJobByDevice
&FirmwareId=FJFx8JzpnhpIsKftRjjm03****
&ProductKey=a19mzPZ****
&DeviceName=light
&PageSize=10
&CurrentPage=1
&Common request parameter

Respuestas exitosas de ejemplo

Formato XML

<ListOTAJobByDeviceResponse>
  <PageCount>1</PageCount>
  <Data>
        <SimpleOTAJobInfo>
              <SelectionType>STATIC</SelectionType>
              <TargetSelection>SPECIFIC</TargetSelection>
              <JobType>UPGRADE_FIRMWARE</JobType>
              <FirmwareId>FJFx8JzpnhpIsKftRjjm03****</FirmwareId>
              <UtcStartTime>2019-12-28T02:43:10.000Z</UtcStartTime>
              <ProductKey>a19mzPZ****</ProductKey>
              <JobId>HvKuBpuk3rdk6E92CPQN02****</JobId>
              <UtcModified>2019-12-28T02:43:10.000Z</UtcModified>
              <JobStatus>IN_PROGRESS</JobStatus>
              <UtcCreate>2019-12-28T02:43:10.000Z</UtcCreate>
        </SimpleOTAJobInfo>
  </Data>
  <PageSize>10</PageSize>
  <RequestId>5D58AC86-D5BF-4B39-834E-913E7F2C985D</RequestId>
  <CurrentPage>1</CurrentPage>
  <Success>true</Success>
  <Total>1</Total>
</ListOTAJobByDeviceResponse>

Formato JSON

{
  "PageCount": 1,
  "Data": {
    "SimpleOTAJobInfo": [{
      "SelectionType": "STATIC",
      "TargetSelection": "SPECIFIC",
      "JobType": "UPGRADE_FIRMWARE",
      "FirmwareId": "FJFx8JzpnhpIsKftRjjm03****",
      "UtcStartTime": "2019-12-28T02:43:10.000Z",
      "ProductKey": "a19mzPZ****",
      "JobId": "HvKuBpuk3rdk6E92CPQN02****",
      "UtcModified": "2019-12-28T02:43:10.000Z",
      "JobStatus": "IN_PROGRESS",
      "UtcCreate": "2019-12-28T02:43:10.000Z"
    }]
  },
  "PageSize": 10,
  "RequestId": "5D58AC86-D5BF-4B39-834E-913E7F2C985D",
  "CurrentPage": 1,
  "Success": true,
  "Total": 1
}

Códigos de error

Para consultar los códigos de error, visite el centro de errores de API.