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

Notifica a una puerta de enlace que agregue relaciones topológicas.

Notas de uso

Una respuesta exitosa indica que el comando para agregar relaciones topológicas se envió a la puerta de enlace, pero no confirma que dichas relaciones ya se hayan agregado.

Al desarrollar la puerta de enlace, suscríbase al tema que se utiliza para enviar notificaciones al agregar relaciones topológicas. Para obtener más información sobre el tema y el formato del mensaje, consulte Gestionar relaciones topológicas.

Límites

Cada cuenta de Alibaba Cloud puede ejecutar 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

Alibaba Cloud proporciona OpenAPI Explorer para simplificar el uso de la API. Esta herramienta calcula automáticamente el valor de la firma y genera dinámicamente código de ejemplo para distintos SDK. Le recomendamos llamar a esta operación directamente en OpenAPI Explorer.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	NotifyAddThingTopo	La operación que desea ejecutar. Establezca el valor en NotifyAddThingTopo.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, configure este parámetro; de lo contrario, la llamada fallará. Si su instancia no tiene página Overview o ID, omita este parámetro. Para obtener más información, consulte Descripción general.
DeviceListStr	String	No	[{"productKey":"a1BwAGV**","deviceName":"device1"},{"IotId":"Q7uOhVRdZRRlDnTLv**00100"}]	Arreglo JSON con la información de identidad del subdispositivo. Use una combinación de ProductKey y DeviceName, o solo IotId para especificar un dispositivo; por ejemplo: [{"productKey":"a1BwAGxxx","deviceName":"device1"},{"IotId":"Q7uOhxxx"}].
GwIotId	String	No	vWxNur6BUApsqjv****4000100	ID del dispositivo de puerta de enlace. Es un identificador único emitido por IoT Platform para el dispositivo. Nota Si especifica este parámetro, omita ProductKey y DeviceName. El parámetro IotId corresponde a un identificador único global (GUID) del dispositivo, equivalente a la combinación de ProductKey y DeviceName. Si especifica tanto IotId como la combinación de ProductKey y DeviceName, prevalecerá IotId.
GwProductKey	String	No	a1T27vz****	ProductKey del producto al que pertenece la puerta de enlace. Nota Si especifica este parámetro, también debe especificar DeviceName.
GwDeviceName	String	No	gateway	DeviceName de la puerta de enlace. Nota Si especifica este parámetro, también debe especificar ProductKey.

Además de los parámetros específicos mencionados anteriormente, especifique 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		Datos devueltos si la llamada es exitosa.
MessageId	String	5443123	ID del mensaje que IoT Platform envía a la puerta de enlace para notificar la adición de una topología.
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

https://iot.cn-shanghai.aliyuncs.com/?Action=NotifyAddThingTopo
&GwProductKey=aldnfald7a
&GwDeviceName=gateway
&DeviceListStr=[{"productKey":"alabcabcab","deviceName":"device1"},{"IotId":"edAjkIeBSsdfadjjllja***"}]
&<Common request parameters>

Respuestas exitosas de ejemplo

XML formato

<NotifyAddThingTopoResponse>
  <RequestId>419A3FC1-B517-4958-9414-5546765FA51F</RequestId>
  <Success>true</Success>
  <Data>
        <MessageId>2345123</MessageId>
  </Data>
</NotifyAddThingTopoResponse>

JSON formato

{
  "RequestId":"419A3FC1-B517-4958-9414-5546765FA51F",
  "Success": true,
  "Data": {
     "MessageId": "2345123"
  }
}

Códigos de error

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