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

Consulta los detalles de un lote de actualizaciones.

Notas de uso

Después de llamar a la operación API CreateOTAVerifyJob, CreateOTAStaticUpgradeJob o CreateOTADynamicUpgradeJob para crear un lote de actualizaciones, se devuelve el parámetro JobId. Utilice este parámetro para consultar los detalles del lote de actualizaciones.

Límites

Cada cuenta de Alibaba Cloud puede ejecutar 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, le recomendamos que llame 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í	QueryOTAJob	La operación que desea ejecutar. Establezca el valor en QueryOTAJob.
JobId	String	Sí	wahVIzGkCMuAUE2gDERM02****	El ID del lote de actualizaciones. Después de llamar a la operación API CreateOTAVerifyJob, CreateOTAStaticUpgradeJob o CreateOTADynamicUpgradeJob para crear el lote de actualizaciones, puede obtener el parámetro JobId. También puede consultar el ID del lote en la página Update Package Details de la consola de IoT Platform.
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, debe configurar este parámetro. Si no establece este parámetro, la llamada fallará. Si su instancia no tiene página de Overview ni 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, debe especificar 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.
Data	Struct		La información del lote de actualizaciones devuelta si la llamada es exitosa. Para obtener más información, consulte los siguientes parámetros.
DestVersion	String	1.0.1	La versión de firmware de destino de la actualización.
DownloadProtocol	String	HTTPS	El protocolo de descarga del paquete de actualización.
DynamicMode	Integer	1	El modo de actualización dinámica. Valores válidos: 1: actualiza constantemente los dispositivos que cumplen las condiciones. 2: actualiza solo los dispositivos que posteriormente envían las versiones de firmware más recientes. Este parámetro se devuelve solo si realiza una actualización dinámica.
FirmwareId	String	UfuxnwygsuSkVE0VCN****0100	El ID del paquete de actualización.
GrayPercent	String	50.00	La proporción de fase de la actualización gradual. Este parámetro se devuelve solo si realiza una actualización gradual.
GroupId	String	CtjzCkNuOxUR***	El ID del grupo de dispositivos que se actualizará.
GroupName	String	test	El nombre del grupo de dispositivos que se actualizará.
JobDesc	String	batch upgrade	La descripción del lote de actualizaciones.
JobId	String	HvKuBpuk3rdk6E92CP****0200	El ID del lote de actualizaciones.
JobStatus	String	IN_PROGRESS	El estado del lote de actualizaciones. PLANNED: El lote de actualizaciones 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 actualizaciones se está ejecutando. COMPLETED: El lote de actualizaciones se completó. CANCELED: El lote de actualizaciones 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.
MaximumPerMinute	Integer	1000	El número máximo de dispositivos a los que se envía la URL de descarga del paquete de actualización por minuto.
MultiModuleMode	Boolean	false	Indica si el dispositivo admite actualizaciones simultáneas de varios módulos. false (predeterminado): no. true: sí. Para obtener más información, consulte Descripción general.
Name	String	Firmware2	El nombre del paquete de actualización.
NeedConfirm	Boolean	false	Indica si se debe confirmar la actualización mediante su aplicación móvil.
NeedPush	Boolean	true	Indica si se deben enviar automáticamente las tareas de actualización de IoT Platform a los dispositivos.
OverwriteMode	Integer	1	Indica si se debe sobrescribir la tarea de actualización anterior. Valores válidos: 1: La tarea de actualización anterior no se sobrescribe. Si un dispositivo ya tiene una tarea de actualización, se ejecuta la tarea anterior. 2: La tarea de actualización anterior se sobrescribe. Solo se ejecuta la tarea de actualización actual. La tarea de actualización en curso no se sobrescribe.
ProductKey	String	a19mzPZ****	La ProductKey del producto al que pertenece el paquete de actualización.
RetryCount	Integer	1	El número de reintentos automáticos después de que falla la actualización de un dispositivo. Este parámetro se devuelve si se estableció una directiva de reintento al crear el lote de actualizaciones.
RetryInterval	Integer	60	El intervalo de reintento automático después de que falla la actualización de un dispositivo. Unidad: minutos. Este parámetro se devuelve si se estableció una directiva de reintento al crear el lote de actualizaciones.
SelectionType	String	STATIC	La directiva de actualización del lote de actualizaciones. Valores válidos: DYNAMIC: actualización dinámica. Este valor se devuelve si llama a la operación API CreateOTADynamicUpgradeJob para crear un lote de actualizaciones. STATIC: actualización estática. Este valor se devuelve si llama a la operación API CreateOTAStaticUpgradeJob para crear un lote de actualizaciones.
SrcVersions	List	null	La lista de versiones de firmware que se actualizarán.
Tags	Array of OtaTagDTO		Las etiquetas del lote de actualizaciones.
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 actualizaciones. 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 API CreateOTADynamicUpgradeJob para crear un lote de actualizaciones.
TimeoutInMinutes	Integer	5	El tiempo de espera de la actualización del dispositivo. Unidad: minutos. Este parámetro se devuelve si se estableció el tiempo de espera al crear el lote de actualizaciones.
UtcCreate	String	2019-12-28T02:43:10.000Z	La hora en que se creó el lote de actualizaciones. La hora se muestra en formato UTC.
UtcEndTime	String	2019-12-29T02:43:10.000Z	La hora de finalización del lote de actualizaciones. La hora se muestra en formato UTC. Este parámetro se devuelve solo después de que se completa el lote de actualizaciones.
UtcModified	String	2019-12-28T02:43:10.000Z	La hora en que se modificó por última vez el lote de actualizaciones. La hora se muestra en formato UTC.
UtcScheduleFinishTime	String	2019-12-30T02:43:10.000Z	La hora de finalización del lote de actualizaciones programado. Este parámetro se devuelve solo si el lote de actualizaciones está programado y se especificó la hora de finalización.
UtcScheduleTime	String	2019-12-29T02:43:10.000Z	La hora de inicio del lote de actualizaciones programado. Este parámetro se devuelve solo para lotes de actualizaciones programados.
UtcStartTime	String	2019-12-28T02:43:10.000Z	La hora de inicio del lote de actualizaciones. La hora se muestra en formato UTC.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	30F1BB8D-EDBF-44FD-BBC0-BE97DEA73991	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryOTAJob
&JobId=wahVIzGkCMuAUE2gDERM02****
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<QueryOTAJobResponse>
  <Data>
        <TimeoutInMinutes>5</TimeoutInMinutes>
        <JobDesc>batch upgrade</JobDesc>
        <DownloadProtocol>HTTPS</DownloadProtocol>
        <UtcStartTime>2019-12-28T02:43:10.000Z</UtcStartTime>
        <UtcEndTime>2019-12-29T02:43:10.000Z</UtcEndTime>
        <ProductKey>a19mzPZ****</ProductKey>
        <UtcModified>2019-12-28T02:43:10.000Z</UtcModified>
        <JobStatus>IN_PROGRESS</JobStatus>
        <UtcCreate>2019-12-28T02:43:10.000Z</UtcCreate>
        <SelectionType>STATIC</SelectionType>
        <TargetSelection>SPECIFIC</TargetSelection>
        <JobType>UPGRADE_FIRMWARE</JobType>
        <GroupId></GroupId>
        <GroupName></GroupName>
        <RetryInterval>60</RetryInterval>
        <RetryCount>1</RetryCount>
        <OverwriteMode>1</OverwriteMode>
        <MultiModuleMode>true</MultiModuleMode>
        <MaximumPerMinute>1000</MaximumPerMinute>
        <SrcVersions>
              <SrcVersion>1.0.0</SrcVersion>
        </SrcVersions>
        <Name>firmware2</Name>
        <NeedConfirm>true</NeedConfirm>
        <NeedPush>false</NeedPush>
        <FirmwareId>UfuxnwygsuSkVE0VCN****0100</FirmwareId>
        <JobId>HvKuBpuk3rdk6E92CP****0200</JobId>
        <DestVersion>1.0.1</DestVersion>
  </Data>
  <RequestId>30F1BB8D-EDBF-44FD-BBC0-BE97DEA73991</RequestId>
  <Success>true</Success>
</QueryOTAJobResponse>

Formato JSON

{
  "Data": {
    "TimeoutInMinutes": 5,
    "JobDesc": "batch upgrade",
    "DownloadProtocol":"HTTPS",
    "UtcStartTime": "2019-12-28T02:43:10.000Z",
    "UtcEndTime": "2019-12-29T02:43:10.000Z",
    "ProductKey": "a19mzPZ****",
    "UtcModified": "2019-12-28T02:43:10.000Z",
    "JobStatus": "IN_PROGRESS",
    "UtcCreate": "2019-12-28T02:43:10.000Z",
    "SelectionType": "STATIC",
    "TargetSelection": "SPECIFIC",
    "JobType": "UPGRADE_FIRMWARE",
    "GroupId":"",
    "GroupName":"",
    "RetryInterval":60,
    "RetryCount":1,
    "OverwriteMode":1,
    "MultiModuleMode":true,
    "MaximumPerMinute":1000,
    "SrcVersions": {
      "SrcVersion": ["1.0.0"]
    },
    "Name":"firmware2",
    "NeedConfirm":true,
    "NeedPush":false,
    "FirmwareId": "UfuxnwygsuSkVE0VCN****0100",
    "JobId": "HvKuBpuk3rdk6E92CP****0200",
    "DestVersion": "1.0.1"
  },
  "RequestId": "30F1BB8D-EDBF-44FD-BBC0-BE97DEA73991",
  "Success": true
}

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.