調用該接口通知網關設備增加拓撲關系。

使用說明

返回的成功結果只表示添加拓撲關系的指令成功下發給網關，并不表示網關成功添加拓撲關系。

開發網關設備端時，需訂閱通知添加拓撲關系消息的Topic。具體Topic和消息格式，請參見管理拓撲關系。

QPS限制

單個阿里云賬號調用該接口的每秒請求數（QPS）最大限制為500。

說明 RAM用戶共享阿里云賬號配額。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 NotifyAddThingTopo

系統規定參數。取值：NotifyAddThingTopo。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

實例ID。您可在物聯網平臺控制臺的實例概覽頁面，查看當前實例的ID。

注意
  • 若有ID值，必須傳入該ID值，否則調用會失敗。
  • 若無ID值，則無需傳入。

實例的更多信息，請參見實例概述。

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，設備的唯一標識符。

說明 如果傳入該參數，則無需傳入ProductKey和DeviceName。IotId作為設備唯一標識符，和ProductKey與DeviceName組合是一一對應的關系。如果您同時傳入IotId和ProductKey與DeviceName組合，則以IotId為準。
GwProductKey String 否 a1T27vz****

網關設備所隸屬的產品ProductKey。

說明 如果傳入該參數，需同時傳入DeviceName。
GwDeviceName String 否 gateway

網關設備名稱。

說明 如果傳入該參數，需同時傳入ProductKey。

調用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

表示是否調用成功。

  • true：調用成功。
  • false：調用失敗。

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=NotifyAddThingTopo
&GwProductKey=aldnfald7a
&GwDeviceName=gateway
&DeviceListStr=[{"productKey":"alabcabcab","deviceName":"device1"},{"IotId":"edAjkIeBSsdfadjjllja***"}]
&<公共請求參數>

正常返回示例

XML格式 

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

JSON格式 

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