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

Consulta los subdispositivos de un dispositivo de puerta de enlace especificado.

Límites

Cada cuenta de Alibaba Cloud puede realizar un máximo de 500 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 ejecute 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í	GetThingTopo	La operación que desea ejecutar. Establezca el valor en GetThingTopo.
PageNo	Integer	Sí	1	El número de página a devolver.
PageSize	Integer	Sí	10	El número de entradas a devolver en cada página. Valor máximo: 50.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia del servicio de Internet de las cosas (IoT). Este parámetro no es obligatorio para instancias públicas, pero sí para instancias de edición empresarial.
ProductKey	String	No	a1BwAGV****	La ProductKey del producto al que pertenece el dispositivo de puerta de enlace. Nota Si especifica este parámetro, también debe especificar el parámetro DeviceName.
DeviceName	String	No	light	El nombre del dispositivo de puerta de enlace. Nota Si especifica este parámetro, también debe especificar el parámetro ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	El ID del dispositivo de puerta de enlace. Es el identificador único que IoT Platform asigna al dispositivo. Nota Si especifica este parámetro, no necesita especificar los parámetros ProductKey ni DeviceName. El parámetro IotId especifica un identificador único para el dispositivo y corresponde a una combinación de los parámetros ProductKey y DeviceName. Si especifica simultáneamente el parámetro IotId y la combinación de ProductKey y DeviceName, prevalecerá el parámetro IotId.

Además de los parámetros específicos de la operación mencionados anteriormente, debe especificar los parámetros de solicitud comunes al llamar a esta API. 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		Los datos devueltos si la llamada se realiza correctamente. Para obtener más información, consulte los siguientes parámetros.
CurrentPage	Integer	1	El número de la página devuelta.
List	Array of deviceInfo		Los detalles del subdispositivo, incluidos en el parámetro deviceInfo.
deviceInfo
DeviceName	String	light	El DeviceName del subdispositivo.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	El ID del subdispositivo. Es el identificador único que IoT Platform asigna al subdispositivo.
ProductKey	String	a1BwAGV****	La ProductKey del producto al que pertenece el subdispositivo.
PageCount	Long	1	El número total de páginas devueltas.
PageSize	Integer	10	El número de entradas devueltas en cada página.
Total	Long	1	El número total de entradas devueltas.
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: La llamada se realizó correctamente. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=GetThingTopo
&ProductKey=a1BwAGV****
&DeviceName=device1
&PageSize=10
&PageNo=1
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<GetThingTopoResponse>
  <Data>
        <PageCount>1</PageCount>
        <PageSize>2</PageSize>
        <CurrentPage>1</CurrentPage>
        <List>
              <deviceInfo>
                    <DeviceName>APItest</DeviceName>
                    <ProductKey>a1T27vz****</ProductKey>
                    <IotId>vWxNur6BUApsqjv****000100</IotId>
              </deviceInfo>
        </List>
        <Total>1</Total>
  </Data>
  <RequestId>93F05C63-9FD1-4CC8-B0FF-6D6C1A6632D1</RequestId>
  <Success>true</Success>
</GetThingTopoResponse>

Formato JSON

{
	"Data": {
		"PageCount": 1,
		"PageSize": 2,
		"CurrentPage": 1,
		"List": {
			"deviceInfo": [
				{
					"DeviceName": "APItest",
					"ProductKey": "a1T27vz****",
					"IotId": "vWxNur6BUApsqjv****000100"
				}
			]
		},
		"Total": 1
	},
	"RequestId": "93F05C63-9FD1-4CC8-B0FF-6D6C1A6632D1",
	"Success": true
}

Códigos de error

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