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

Consulta los lotes de actualización de un paquete de actualización.

Límites

Cada cuenta de Alibaba Cloud admite un máximo de 10 consultas por segundo (QPS).

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, se recomienda llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListOTAJobByFirmware	La operación que desea ejecutar. Establezca el valor en ListOTAJobByFirmware.
CurrentPage	Integer	Sí	1	El número de página que se devolverá. Las páginas comienzan from la página 1.
FirmwareId	String	Sí	FJFx8JzpnhpIsKftRjjm03****	El ID del paquete de actualización. Se devuelve un ID de paquete de actualización cuando llama a la operación CreateOTAFirmware para crear el paquete de actualización. Llame a la operación ListOTAFirmware y consulte el ID del paquete de actualización en la respuesta.
PageSize	Integer	Sí	10	El número de entradas que se devolverán en cada página. Valor máximo: 200.
IotInstanceId	String	No	iot-cn-0pp1n8t****	El ID 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 ID, configure este parámetro. Si no establece este parámetro, la llamada fallará. Si su instancia no tiene página Overview o ID, no necesita establecer este parámetro. Para obtener más información, consulte Descripción general.

Además de los parámetros de solicitud específicos de la operación anteriores, especifique 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 devuelto 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	Array of SimpleOTAJobInfo		La información del lote de actualización devuelta si la llamada es exitosa. Para obtener más información, consulte SimpleOTATaskInfo.
SimpleOTAJobInfo
FirmwareId	String	UfuxnwygsuSkVE0VCN****0100	El ID del paquete de actualización.
JobId	String	HvKuBpuk3rdk6E92CP****0200	El ID del lote de actualización.
JobStatus	String	IN_PROGRESS	El estado del lote de actualización. PLANNED: El lote de actualización está en planificación. El lote se creó, pero la hora programada aún no ha llegado. Este parámetro se devuelve solo si realiza una actualización estática. IN_PROGRESS: El lote de actualización se está ejecutando. COMPLETE: El lote de actualización se completó. CANCELED: El lote de actualización se canceló.
JobType	String	UPGRADE_FIRMWARE	El tipo de lote. Valores válidos: VERFIY_FIRMWARE: verificación de paquete de actualización. UPGRADE_FIRMWARE: actualización por lotes.
ProductKey	String	a19mzPZ****	La ProductKey del producto al que pertenece el paquete de actualización.
SelectionType	String	STATIC	La política de actualización del lote de actualización. Valores válidos: DYNAMIC: actualización dinámica. Este valor se devuelve si llama a la operación de API CreateOTADynamicUpgradeJob para crear un lote de actualización. STATIC: actualización estática. Este valor se devuelve si llama a la operación de API CreateOTAStaticUpgradeJob para crear un lote de actualización.
Tags	Array of OtaTagDTO		Las etiquetas del lote de actualización.
OtaTagDTO
Key	String	key1	La clave de cada etiqueta.
Value	String	value1	El valor de la etiqueta.
TargetSelection	String	SPECIFIC	El alcance del lote de actualización. Valores válidos: ALL: actualiza todos los dispositivos. SPECIFIC: actualiza dispositivos específicos. GRAY: realiza una actualización gradual. Nota El valor ALL se devuelve si llama a la operación de API CreateOTADynamicUpgradeJob para crear un lote de actualización.
UtcCreate	String	2019-12-28T02:43:10.000Z	La hora en que se creó el lote de actualización. La hora se muestra en formato UTC.
UtcEndTime	String	2019-12-29T02:43:10.000Z	La hora de finalización del lote de actualización. La hora se muestra en formato UTC. Este parámetro se devuelve solo después de que se completa el lote de actualización.
UtcModified	String	2019-12-28T02:43:10.000Z	La hora en que se modificó por última vez el lote de actualización. La hora se muestra en formato UTC.
UtcStartTime	String	2019-12-28T02:43:10.000Z	La hora de inicio del lote 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.
PageCount	Integer	1	El número total de páginas.
PageSize	Integer	10	El número de entradas devueltas por página.
RequestId	String	5D58AC86-D5BF-4B39-834E-913E7F2C985D	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.
Total	Integer	1	El número total de trabajos de actualización devueltos.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAJobByFirmware
&FirmwareId=FJFx8JzpnhpIsKftRjjm03****
&PageSize=10
&CurrentPage=1
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<ListOTAJobByFirmwareResponse>
    <PageCount>1</PageCount>
    <Data>
        <SimpleOTAJobInfo>
            <SelectionType>STATIC</SelectionType>
            <TargetSelection>SPECIFIC</TargetSelection>
            <JobType>UPGRADE_FIRMWARE</JobType>
            <FirmwareId>yLYuCqfqQNQ1JOqkDa****0100</FirmwareId>
            <UtcStartTime>2019-12-28T02:43:10.000Z</UtcStartTime>
            <UtcEndTime>2019-12-29T02:43:10.000Z</UtcEndTime>
            <ProductKey>a19mzPZ****</ProductKey>
            <JobId>HvKuBpuk3rdk6E92CP****0200</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>
</ListOTAJobByFirmwareResponse>

Formato JSON

{
  "PageCount": 1,
  "Data": {
    "SimpleOTAJobInfo": [{
      "SelectionType": "STATIC",
      "TargetSelection": "SPECIFIC",
      "JobType": "UPGRADE_FIRMWARE",
      "FirmwareId": "UfuxnwygsuSkVE0VCN****0100",
      "UtcStartTime": "2019-12-28T02:43:10.000Z",
      "UtcEndTime": "2019-12-29T02:43:10.000Z",
      "ProductKey": "a19mzPZ****",
      "JobId": "HvKuBpuk3rdk6E92CP****0200",
      "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 obtener una lista de códigos de error, visite el Centro de errores de API.