GetThingTopo - IoT Platform

限制說明

單阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為500。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	GetThingTopo	系統規定參數。取值：GetThingTopo。
PageNo	Integer	是	1	從返回結果中的第幾頁開始顯示。
PageSize	Integer	是	10	返回結果中每頁顯示的記錄數量。最大值不超過50。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。公用執行個體不傳此參數，企業版執行個體需傳入。
ProductKey	String	否	a1BwAGV****	網關裝置所屬的產品ProductKey。說明如果傳入該參數，需同時傳入DeviceName。
DeviceName	String	否	light	網關裝置的名稱。說明如果傳入該參數，需同時傳入ProductKey。
IotId	String	否	Q7uOhVRdZRRlDnTLv****00100	網關裝置ID。物聯網平台為該網關裝置頒發的ID，裝置的唯一識別碼。說明如果傳入該參數，則無需傳入ProductKey和DeviceName。IotId作為裝置唯一識別碼，和ProductKey與DeviceName組合是一一對應的關係。如果您同時傳入IotId和ProductKey與DeviceName組合，則以IotId為準。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Struct		調用成功時，返回的資料。詳情請參見以下參數。
CurrentPage	Integer	1	當前頁碼。
List	Array of deviceInfo		子裝置資訊集合（deviceInfo）。
deviceInfo
DeviceName	String	light	子裝置名稱。
IotId	String	Q7uOhVRdZRRlDnTLv****00100	子裝置ID。物聯網平台為該裝置頒發的ID，裝置的唯一識別碼。
ProductKey	String	a1BwAGV****	子裝置所屬的產品ProductKey。
PageCount	Long	1	總頁數。
PageSize	Integer	10	每頁顯示的記錄數。
Total	Long	1	總記錄數。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=GetThingTopo
&ProductKey=a1BwAGV****
&DeviceName=device1
&PageSize=10
&PageNo=1
&<公用請求參數>

正常返回樣本

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>

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
}

錯誤碼

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