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

Consulta dispositivos distribuidos.

Notas de uso

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

Nota
Los usuarios RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.
Varias cuentas de Alibaba Cloud pueden ejecutar un máximo de 200 QPS simultáneamente.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, se recomienda llamar a esta operación desde OpenAPI Explorer. Esta herramienta 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í	ListDistributedDevice	La operación que desea ejecutar. Establezca el valor en ListDistributedDevice.
CurrentPage	Integer	Sí	1	Número de página a devolver. Valor predeterminado: 1.
PageSize	Integer	Sí	5	Número de entradas a devolver por página. Valor máximo: 200.
ProductKey	String	No	a1BwAGV****	El ProductKey del producto al que pertenece el dispositivo.
DeviceName	String	No	mydevice	El DeviceName del dispositivo.
TargetUid	String	No	198***	ID de la cuenta de Alibaba Cloud. Para obtener su ID de cuenta, inicie sesión en la consola de IoT Platform, haga clic en su foto de perfil y consulte el Account ID en la página Security Settings.
SourceInstanceId	String	No	iot-060***	ID de la instancia de origen a la que pertenece el dispositivo. ID de las instancias públicas en diferentes regiones: China (Shanghai): iotx-oxssharez200. Japan (Tokyo): iotx-oxssharez300. Singapore (Singapore): iotx-oxssharez400. US (Silicon Valley): iotx-oxssharez500. US (Virginia): iotx-oxssharez600. Germany (Frankfurt): iotx-oxssharez700. ID de las instancias Enterprise Edition: 1. Inicie sesión en la consola de IoT Platform. Seleccione una región en la lista desplegable de la esquina superior izquierda de la barra de navegación superior. 2. En la página Overview, haga clic en el nombre de la instancia. En la página Instance Details, consulte el ID de la instancia en la sección Basic Information.

También 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	Código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
Data	Struct		Productos devueltos si la llamada es exitosa. Para obtener más información, consulte Info.
Info	Array of items		Información del dispositivo.
items
DeviceName	String	mydevice	DeviceName del dispositivo.
GmtCreate	Long	1581595942000	Hora de creación de la tarea de distribución.
GmtModified	Long	1581595942222	Hora de modificación de la tarea de distribución.
ProductKey	String	a1BwAGV***	El ProductKey del producto al que pertenece el dispositivo.
SourceInstanceId	String	iot-cn-6ja***	ID de la instancia de origen.
SourceInstanceName	String	myproInstance	Nombre de la instancia de origen.
SourceRegion	String	cn-shanghai	Región de origen donde reside el dispositivo.
SourceUid	String	198***	ID de la cuenta de Alibaba Cloud que distribuye el dispositivo. La distribución de dispositivos solo se admite dentro de la misma cuenta de Alibaba Cloud entre regiones e instancias. El valor de este parámetro es igual al del parámetro TargetUid.
TargetAliyunId	String	io****@example.com	Cuenta de Alibaba Cloud a la que se distribuye el dispositivo.
TargetInstanceId	String	iot-cn-09k***	ID de la instancia de destino.
TargetInstanceName	String	newinstance	Nombre de la instancia de destino.
TargetRegion	String	cn-shenzhen	Región de destino a la que se distribuye el dispositivo.
TargetUid	String	198***	Cuenta de Alibaba Cloud a la que se distribuye el dispositivo. La distribución de dispositivos solo se admite dentro de la misma cuenta de Alibaba Cloud entre regiones e instancias. El valor de este parámetro es igual al del parámetro TargetUid.
Total	Integer	10	Número total de dispositivos devueltos.
ErrorMessage	String	A system exception occurred.	Mensaje de error devuelto si la llamada falla.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	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

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

Respuestas exitosas de ejemplo

Formato XML

<ListDistributedDeviceResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Total>10</Total>
        <Info>
              <items>
                    <TargetRegion>cn-shenzhen</TargetRegion>
                    <SourceInstanceName>myproInstance</SourceInstanceName>
                    <TargetAliyunId>io****@example.com</TargetAliyunId>
                    <SourceUid>198***</SourceUid>
                    <GmtModified>1581595942222</GmtModified>
                    <TargetInstanceId>iot-cn-09k***</TargetInstanceId>
                    <TargetUid>198***</TargetUid>
                    <SourceRegion>cn-shanghai</SourceRegion>
                    <SourceInstanceId>iot-cn-6ja***</SourceInstanceId>
                    <GmtCreate>1581595942000</GmtCreate>
                    <TargetInstanceName>newinstance</TargetInstanceName>
                    <ProductKey>a1BwAGV***</ProductKey>
                    <DeviceName>mydevice</DeviceName>
              </items>
        </Info>
  </Data>
  <Success>true</Success>
</ListDistributedDeviceResponse>

Formato JSON

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Total": 10,
        "Info": {
            "items": [{
                "TargetRegion": "cn-shenzhen",
                "SourceInstanceName": "myproInstance",
                "TargetAliyunId": "io****@example.com",
                "SourceUid": "198***",
                "GmtModified": 1581595942222,
                "TargetInstanceId": "iot-cn-09k***",
                "TargetUid": "198***",
                "SourceRegion": "cn-shanghai",
                "SourceInstanceId": "iot-cn-6ja***",
                "GmtCreate": 1581595942000,
                "TargetInstanceName": "newinstance",
                "ProductKey": "a1BwAGV***",
                "DeviceName": "mydevice"
            }]
        }
    },
    "Success": true
}

Códigos de error

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