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

Consulta los detalles de una tarea.

Límites de QPS

Puede invocar esta operación hasta cinco veces por segundo por cuenta.

Nota

Los usuarios de RAM 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 que invoque 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í	QueryJob	La operación que desea ejecutar. Establezca el valor en QueryJob.
JobId	String	Sí	450407b***	El ID de la tarea. Este ID es único globalmente.
IotInstanceId	String	No	iot-cn-0pp1n8t****	El ID de la instancia. Consulte el ID en la pestaña Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificarlo; de lo contrario, la llamada fallará. Si no se generó ninguna pestaña Overview ni ningún ID para su instancia, no es necesario especificar este parámetro. Para obtener más información sobre las instancias, consulte Descripción general.

Además de los parámetros de solicitud específicos de la operación mencionados a continuación, debe especificar los parámetros de solicitud comunes al invocar esta operación. Para obtener más información, consulte Parámetros 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		Los detalles de la tarea devueltos tras una llamada exitosa. Para obtener más información, consulte los siguientes parámetros.
Description	String	jobDescription	La descripción de la tarea.
JobDocument	String	{ "serviceIdentifier": "test_service", "params": { "key1": "value1", "key2": "value2" } }	El archivo de reglas que desea enviar a los dispositivos.
JobFile	Struct		La información de descarga del archivo.
FileUrl	String	https://iotx-*.oss-cn-shanghai.aliyuncs.com/job/7u.sh?Expires=16&OSSAccessKeyId=LTA&Signature=TTTejn*	La URL de descarga del archivo. Es válida durante 30 minutos.
Sign	String	TTTejn***	La firma. Para los archivos cargados mediante URL, la firma se genera según el método de firma.
SignMethod	String	SHA256	El método de firma. Valores válidos: MD5 y SHA256.
JobId	String	450407b***	El ID de la tarea. Este ID es único globalmente.
JobName	String	tes	El nombre de la tarea.
RolloutConfig	Struct		La tasa de envío de subtareas dentro de la tarea.
MaximumPerMinute	Integer	10	El número máximo de subtareas enviadas por minuto.
MessageQoS	String	Qos1	El nivel de calidad de servicio (QoS) de los mensajes. Este parámetro solo está disponible para tareas personalizadas y tareas de entrega masiva de mensajes. Valores válidos: QoS0: El sistema envía el mensaje una sola vez. QoS1: El sistema envía el mensaje como mínimo una vez. Si no se recibe una respuesta PUBACK después de enviar un mensaje QoS 1, el mensaje se vuelve a enviar al dispositivo cuando este se reconecta a IoT Platform.
ScheduledTime	Long	1557062301656	La hora en que se programó la tarea. Unidad: milisegundos.
Status	String	CANCELLED	El estado de la tarea. Valores válidos: INITIALIZING: La tarea se está inicializando. WAITING: La tarea está en espera de programación. IN_PROGRESS: La tarea está en curso. COMPLETE: La tarea ha finalizado. CANCELLING: La tarea se está cancelando. CANCELLED: La tarea está cancelada. REMOVING: La tarea se está eliminando. TIMED_OUT: La tarea ha excedido el tiempo de espera.
TargetConfig	Struct		Las configuraciones de dispositivos para la tarea.
TargetDevices	Array of targetDevices		Los dispositivos.
targetDevices
DeviceName	String	a1Ix***	El DeviceName del dispositivo.
ProductKey	String	nCwfSBzc***	El ProductKey del producto al que pertenece el dispositivo.
TargetGroup	String	1234	El ID del grupo de dispositivos al que pertenece el dispositivo.
TargetProduct	String	nCwfSBzc***	El ProductKey del producto al que pertenece el dispositivo.
TargetType	String	DEVICE_LIST	El tipo de configuración de dispositivos. Valores válidos: DEVICE_LIST: la lista de dispositivos GROUP_ID: el ID del grupo de dispositivos PRODUCT_KEY: el ProductKey del producto
TimeoutConfig	Struct		Las configuraciones de tiempo de espera de las subtareas en la tarea.
InProgressTimeoutInMinutes	Integer	5	El periodo de tiempo de espera de la subtarea. Unidad: minutos.
Type	String	SET_PROPERTY	El tipo de tarea. Valores válidos: INVOKE_SERVICE: tarea de invocación masiva de servicios. SET_PROPERTY: tarea de configuración masiva de propiedades. PUB: tarea de entrega masiva de mensajes. CUSTOM_JOB: tarea personalizada.
UtcCreate	String	2020-12-13T04:09:51.000Z	La hora en que se creó la tarea.
UtcModified	String	2020-12-13T04:10:00.000Z	La hora de la última modificación de la tarea.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	A6BEAB33-03E6-4CE0-A94F-9E24C5512BAD	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. Valores válidos: true: La llamada fue exitosa. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

Formato XML

<QueryJobResponse>
    <RequestId>A6BEAB33-03E6-4CE0-A94F-9E24C5512BAD</RequestId>
    <Data>
            <Status>CANCELLED</Status>
		    <ScheduledTime>1557062301656</ScheduledTime>
            <Type>SET_PROPERTY</Type>
            <TimeoutConfig>
                    <InProgressTimeoutInMinutes>5</InProgressTimeoutInMinutes>
            </TimeoutConfig>
            <Description>jobDescription</Description>
            <UtcCreate>2020-12-13T04:09:51.000Z</UtcCreate>
            <JobFile>
                    <FileUrl>https://iotx-***.oss-cn-shanghai.aliyuncs.com/job***/7u***.sh?Expires=16***&amp;OSSAccessKeyId=LTA***&amp;Signature=TTTejn***</FileUrl>
                    <Sign>1235</Sign>
                    <SignMethod>SHA256</SignMethod>
            </JobFile>
            <JobDocument>{}</JobDocument>
            <JobName>test</JobName>
            <UtcModified>2020-12-13T04:10:00.000Z</UtcModified>
            <JobId>450407b***</JobId>
            <TargetConfig>
                    <TargetDevices>
                            <targetDevices>
                                    <ProductKey>nCwf***</ProductKey>
                                    <DeviceName>a1IxS***</DeviceName>
                            </targetDevices>
                            <targetDevices>
                                    <ProductKey>24VI***</ProductKey>
                                    <DeviceName>a1***</DeviceName>
                            </targetDevices>
                            <targetDevices>
                                    <ProductKey>6NDWQ***</ProductKey>
                                    <DeviceName>a1I***</DeviceName>
                            </targetDevices>
                            <targetDevices>
                                    <ProductKey>EQtTJT***</ProductKey>
                                    <DeviceName>a1IxS***</DeviceName>
                            </targetDevices>
                            <targetDevices>
                                    <ProductKey>rUdc33Vr***</ProductKey>
                                    <DeviceName>a1IxS***</DeviceName>
                            </targetDevices>
                    </TargetDevices>
                    <TargetType>DEVICE_LIST</TargetType>
            </TargetConfig>
    </Data>
    <Success>true</Success>
</QueryJobResponse>

Formato JSON

{
    "RequestId": "A6BEAB33-03E6-4CE0-A94F-9E24C5512BAD",
    "Data": {
        "Status": "CANCELLED",
        "ScheduledTime": 1557062301656,
        "Type": "SET_PROPERTY",
        "TimeoutConfig": {
            "InProgressTimeoutInMinutes": 5
        },
        "Description": "jobDescription",
        "UtcCreate": "2020-12-13T04:09:51.000Z",
        "JobFile": {
            "FileUrl": "https://iotx-***.oss-cn-shanghai.aliyuncs.com/job***/7u***.sh?Expires=16***&amp;OSSAccessKeyId=LTA***&amp;Signature=TTTejn***",
            "Sign": "1235",
            "SignMethod": "SHA256"
        },
        "JobDocument": "{}",
        "JobName": "test",
        "UtcModified": "2020-12-13T04:10:00.000Z",
        "JobId": "450407b***",
        "TargetConfig": {
            "TargetDevices": {
                "targetDevices": [
                    {
                        "ProductKey": "nCwf***",
                        "DeviceName": "a1IxS***"
                    },
                    {
                        "ProductKey": "24VI***",
                        "DeviceName": "a1***"
                    },
                    {
                        "ProductKey": "6NDWQ***",
                        "DeviceName": "a1I***"
                    },
                    {
                        "ProductKey": "EQtTJT***",
                        "DeviceName": "a1IxS***"
                    },
                    {
                        "ProductKey": "rUdc33Vr***",
                        "DeviceName": "a1IxS***"
                    }
                ]
            },
            "TargetType": "DEVICE_LIST"
        }
    },
    "Success": true
}

Códigos de error

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