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

Consulta las tareas de distribución de dispositivos.

Notas de uso

Si usa una instancia de Enterprise Edition, especifique el parámetro IotInstanceId al llamar a esta operación. De lo contrario, la llamada finaliza con errores.

Límites de QPS

Puede llamar a esta operación de API hasta cinco veces por segundo por cuenta.

Nota

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

Depuración

OpenAPI Explorer calcula el valor de la firma automáticamente. Para su comodidad, se recomienda llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera el código de ejemplo de la operación dinámicamente para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListDeviceDistributeJob	La operación que se ejecutará. Establezca el valor en ListDeviceDistributeJob.
PageSize	Integer	Sí	10	La cantidad de entradas que se devolverán en cada página. Valores válidos: de 1 a 200.
TargetUid	String	No	198***	El ID de la cuenta de Alibaba Cloud a la que se distribuyen los dispositivos.
CurrentPage	Integer	No	1	El número de la página que se devolverá. Valor predeterminado: 1. El parámetro NextToken o CurrentPage indica una condición para mostrar los resultados. Especifique uno de los dos parámetros. En caso de que especifique ambos parámetros al mismo tiempo, se usa el parámetro NextToken. Para obtener información sobre el parámetro NextToken, consulte la descripción del parámetro NextToken.
Status	Integer	No	1	El estado de la tarea de distribución de dispositivos. 0: La tarea se está inicializando. 1: La tarea está en ejecución. 2: La tarea está completada. Este estado indica que la tarea de distribución finalizó, pero no indica que se hayan distribuido todos los productos y dispositivos. Para obtener los resultados de la distribución, llame a la operación QueryDeviceDistributeDetail. 3: La tarea se interrumpió inesperadamente.
JobId	String	No	UbmsMHmkqv0PiAG****010001	El ID de la tarea de distribución. El ID es único globalmente.
NextToken	String	No	TGlzdFJlc291***	El token que se usa para recuperar las páginas posteriores de los resultados de la consulta. La primera vez que realiza una operación de consulta, no es necesario que especifique este parámetro. El parámetro NextToken o CurrentPage indica una condición para mostrar los resultados. Especifique uno de los dos parámetros. En caso de que especifique ambos parámetros al mismo tiempo, se usa el parámetro NextToken. Importante El desplazamiento en el número de resultados se obtiene con la fórmula a continuación: PageSize × (CurrentPage - 1). Si el desplazamiento es mayor que 10,000, debe usar el token devuelto en la consulta anterior como valor del parámetro NextToken para obtener el valor del parámetro Data. De lo contrario, la solicitud actual finaliza y no se puede devolver el valor del parámetro Data.
ProductKey	String	No	aw3zse****	El ProductKey del producto al que pertenece el dispositivo.

Además de los parámetros de solicitud específicos de la operación mencionados anteriormente, especifique los parámetros de solicitud comunes al llamar a esta operación. Para obtener más información sobre los parámetros de solicitud comunes, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error que se devuelve si la llamada finaliza con errores. Para obtener más información, consulte Códigos de error.
Data	Struct		Las tareas de distribución que se devuelven cuando la llamada se realiza correctamente. Para obtener más información, consulte el parámetro JobInfo.
JobInfo	Array of items		La información de la tarea.
items
GmtCreate	Long	1581595942000	La hora de creación de la tarea.
JobId	String	UbmsMHmkqv0PiAG****010001	El ID de la tarea.
ProductKey	String	a1BwAGV****	El ProductKey del producto al que pertenece el dispositivo.
SourceInstanceId	String	iot-cn-6ja***	El ID de la instancia de origen.
SourceInstanceName	String	Instance Debug 1	El nombre de la instancia de origen.
SourceRegion	String	cn-shanghai	La región donde reside la instancia de origen.
SourceUid	String	198***	El ID de la cuenta de Alibaba Cloud de origen.
Status	Integer	1	El estado de la tarea. 0: La tarea se está inicializando. 1: La tarea está en ejecución. 2: La tarea está completada. Este estado indica que la tarea de distribución finalizó, pero no indica que se hayan distribuido todos los productos y dispositivos. Para obtener los resultados de la distribución, llame a la operación QueryDeviceDistributeDetail. 3: La tarea se interrumpió inesperadamente.
Strategy	Integer	0	La política de distribución. 0: distribuye los dispositivos a las instancias indicadas en una región indicada. Este es el valor predeterminado. 1: configura los ID de instancia en varias regiones y distribuye los dispositivos a las regiones más cercanas según las direcciones IP de los dispositivos.
TargetInstanceConfigs	Array of targetInstanceConfigs		Los ID de las instancias de destino. Si el valor del parámetro Strategy es 1, existen varios ID de instancia. Si el valor del parámetro Strategy es 0, solo existe un ID de instancia.
targetInstanceConfigs
TargetInstanceId	String	iot-cn-6ja***	El ID de la instancia de destino.
TargetInstanceName	String	Instance Debug 2	El nombre de la instancia de destino.
TargetRegion	String	cn-shanghai	La región donde reside la instancia de destino.
TargetUid	String	198***	El ID de la cuenta de Alibaba Cloud de destino.
Total	Integer	5	El número total de dispositivos de la tarea de distribución.
NextToken	String	TGlzdFJlc291***	El token que se usa para recuperar las páginas posteriores de los resultados de la consulta. El valor de este parámetro puede usarse en la siguiente consulta para obtener las páginas posteriores de resultados. Si el valor devuelto está vacío, no hay páginas posteriores.
Total	Integer	10	El número total de tareas de distribución de dispositivos.
ErrorMessage	String	A system exception occurred.	El mensaje de error que se devuelve si la llamada finaliza con errores.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada se realizó correctamente. Valores válidos: true: La llamada se realizó correctamente. false: La llamada finalizó con errores.

Ejemplos

Solicitudes de ejemplo

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListDeviceDistributeJob
&CurrentPage=1
&PageSize=10
&TargetUid=198***
&<Common request parameters>

Respuestas de ejemplo exitosas

XML formato

<ListDeviceDistributeJobResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <NextToken>TGlzdFJlc291***</NextToken>
        <Total>10</Total>
        <JobInfo>
              <items>
                    <Status>1</Status>
                    <SourceInstanceName> Instance Debug 1</SourceInstanceName>
                    <GmtCreate>1581595942000</GmtCreate>
                    <SourceUid>198***</SourceUid>
                    <Total>5</Total>
                    <Strategy>0</Strategy>
                    <TargetUid>198***</TargetUid>
                    <SourceRegion>cn-shanghai</SourceRegion>
                    <SourceInstanceId>iot-cn-6ja***</SourceInstanceId>
                    <ProductKey>a1BwAGV****</ProductKey>
                    <JobId>UbmsMHmkqv0PiAG****010001</JobId>
                    <TargetInstanceConfigs>
                          <targetInstanceConfigs>
                                <TargetRegion>cn-shanghai</TargetRegion>
                                <TargetInstanceName> Instance Debug 2</TargetInstanceName>
                                <TargetInstanceId>iot-cn-6ja***</TargetInstanceId>
                          </targetInstanceConfigs>
                    </TargetInstanceConfigs>
              </items>
        </JobInfo>
  </Data>
  <Success>true</Success>
</ListDeviceDistributeJobResponse>

JSON formato

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "NextToken":"TGlzdFJlc291***",
        "Total": 10,
        "JobInfo": {
            "items": {
                "Status": 1,
                "SourceInstanceName": "Instance Debug 1",
                "GmtCreate": 1581595942000,
                "SourceUid": "198***",
                "Total": 5,
                "Strategy": 0,
                "TargetUid": "198***",
                "SourceRegion": "cn-shanghai",
                "SourceInstanceId": "iot-cn-6ja***",
                "ProductKey": "a1BwAGV****",
                "JobId": "UbmsMHmkqv0PiAG****010001",
                "TargetInstanceConfigs": {
                    "targetInstanceConfigs": {
                        "TargetRegion": "cn-shanghai",
                        "TargetInstanceName": "Instance Debug 2",
                        "TargetInstanceId": "iot-cn-6ja***"
                    }
                }
            }
        }
    },
    "Success": true
}

Códigos de error

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