NotifyAddThingTopo - IoT Platform

使用說明

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

開發網關裝置端時，需訂閱通知添加拓撲關係訊息的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"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。