NotifyAddThingTopo
NotifyAddThingTopo
调用该接口通知网关设备增加拓扑关系。
使用说明
返回的成功结果只表示添加拓扑关系的指令成功下发给网关，并不表示网关成功添加拓扑关系。
开发网关设备端时，需订阅通知添加拓扑关系消息的Topic。具体Topic和消息格式，
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | NotifyAddThingTopo | 系统规定参数。取值：NotifyAddThingTopo。 |
DeviceListStr | String | 否 | [{"productKey":"a1BwAGV****","deviceName":"device1"},{"IotId":"Q7uOhVRdZRRlDnTLv****00100"}] | 要挂载在目标网关设备上的子设备数组，为JSON字符串形式的子设备标识信息，可使用ProductKey和DeviceName或IotId指代设备，例如[{"productKey":"a1BwAGxxx","deviceName":"device1"},{"IotId":"Q7uOhxxx"}]。 |
GwIotId | String | 否 | vWxNur6BUApsqjv****4000100 | 网关设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符 |
GwProductKey | String | 否 | a1T27vz**** | 网关设备所隶属的产品ProductKey。 |
GwDeviceName | String | 否 | gateway | 网关设备名称。 |
‼️ 注意：调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数。
返回数据
名称 | 类型 | 示例值 | 描述 |
Code | String | iot.system.SystemException | 调用失败时，返回的错误码。更多信息，请参见错误码。 |
Data | Struct | 调用成功时，返回的数据。 | |
MessageId | String | 5443123 | 云端向网关设备下发增加拓扑关系的消息ID。 |
ErrorMessage | String | 系统异常 | 调用失败时，返回的出错信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 为该请求生成的唯一标识符。 |
Success | Boolean | true | 表示是否调用成功。
|
示例
请求示例
curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?DeviceListStr=%5B%7B%22productKey%22%3A%22k1ymv5ZxdaN%22%2C%22deviceName%22%3A%22subDevice%22%7D%5D&Action=NotifyAddThingTopo&GwProductKey=k1ymv1DuLfE&GwDeviceName=myTestDevice&SignatureNonce=386bc0bc01144b5f812225853fc3eaf3&AccessKeyId=xMr9wgwXQLhv5AUa65o03mcD&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T09%3A09%3A02Z&Signature=Fu6Us9dOcTr0aaG8mema7VKiemw%3D'正常返回示例
{
"RequestId":"419A3FC1-B517-4958-9414-5546765FA51F",
"Success": true,
"Data": {
"MessageId": "2345123"
}
}