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

Consulta los detalles de una tarea de distribución de dispositivos.

Notas de uso

Esta operación solo se puede invocar mediante el siguiente endpoint: iot.cn-shanghai.aliyuncs.com.
Cada cuenta de Alibaba Cloud admite un máximo de 10 consultas por segundo (QPS).

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. Se recomienda invocar esta operación en OpenAPI Explorer, ya que genera dinámicamente código de ejemplo para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	QueryDeviceDistributeJob	La operación a ejecutar. Establezca el valor en QueryDeviceDistributeJob.
JobId	String	Sí	UbmsMHmkqv0PiAG****010001	El ID único global de la tarea de distribución.

Esta operación también requiere 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. Códigos de error.
Data	Struct		La información de la tarea devuelta en caso de éxito.
GmtCreate	Long	1581595942000	La hora en que se creó la tarea.
JobId	String	UbmsMHmkqv0PiAG****010001	El ID de la tarea de distribución.
ProductKey	String	a1BwAGV****	El ProductKey del producto al que pertenece el dispositivo.
SourceInstanceId	String	iot-cn-6ja***	El ID de la instancia de origen.
SourceUid	String	198***	El ID de la cuenta de Alibaba Cloud.
Status	Integer	1	El estado de la tarea de distribución. 0: Inicializando. 1: En progreso. 2: Completado. Esto no garantiza que todos los productos y dispositivos se hayan distribuido. Para comprobar los resultados de la distribución, invoque la operación QueryDeviceDistributeDetail. 3: Interrumpido inesperadamente.
Strategy	Integer	0	La directiva de distribución. 0: Distribuye dispositivos a instancias en una región especificada. 1: Configura IDs de instancia en varias regiones y distribuye los dispositivos a las regiones más cercanas según sus direcciones IP.
TargetInstanceConfigs	Array of targetInstanceConfigs		Los IDs de las instancias de destino. Cuando el parámetro Strategy es 1, se devuelven varios IDs de instancia. Cuando el parámetro Strategy es 0, solo se devuelve un ID de instancia.
targetInstanceConfigs
TargetInstanceId	String	iot-cn-6ja***	El ID de la instancia de destino.
TargetUid	String	198***	El ID de la cuenta de Alibaba Cloud.
Total	Integer	5	El número total de dispositivos en la tarea.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada se realizó correctamente. true: Correcto. false: Con errores.

Ejemplos

Solicitudes de ejemplo

http(s)://iot.cn-shanghai.aliyuncs.com/? Action=QueryDeviceDistributeJob
&JobId=UbmsMHmkqv0PiAG****010001
&<Common request parameters>

Respuestas de éxito de ejemplo

Formato XML

<QueryDeviceDistributeJobResponse>
  <RequestId> E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Status>1</Status>
        <GmtCreate>1581595942000</GmtCreate>
        <SourceUid>198***</SourceUid>
        <Total>5</Total>
        <Strategy>0</Strategy>
        <TargetUid>198***</TargetUid>
        <SourceInstanceId>iot-cn-6ja***</SourceInstanceId>
        <TargetInstanceConfigs>
              <targetInstanceConfigs>
                    <TargetInstanceId>iot-cn-6ja***</TargetInstanceId>
              </targetInstanceConfigs>
        </TargetInstanceConfigs>
        <ProductKey>a1BwAGV****</ProductKey>
        <JobId>UbmsMHmkqv0PiAG****010001</JobId>
  </Data>
  <Success>true</Success>
</QueryDeviceDistributeJobResponse>

Formato JSON

{
    "RequestId": " E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Status": "1",
        "GmtCreate": "1581595942000",
        "SourceUid": "198***",
        "Total": "5",
        "Strategy": "0",
        "TargetUid": "198***",
        "SourceInstanceId": "iot-cn-6ja***",
        "TargetInstanceConfigs": {
            "targetInstanceConfigs": [{
                "TargetInstanceId": "iot-cn-6ja***"
            }]
        },
        "ProductKey": "a1BwAGV****",
        "JobId": "UbmsMHmkqv0PiAG****010001"
    },
    "Success": "true"
}

Códigos de error

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