調用該介面,根據掛載的子裝置資訊,查詢對應的網關裝置資訊。
QPS限制
單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為50。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
| 名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
| Action | String | 是 | GetGatewayBySubDevice | 系統規定參數。取值:GetGatewayBySubDevice。 |
| IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的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 | 調用成功時,返回的網關裝置的詳細資料。 |
|
| DeviceName | String | gateway | 網關裝置名稱。 |
| DeviceSecret | String | dCYdTU3gw5Z77bsHjPk6lPHPVnBT**** | 網關裝置密鑰。 |
| FirmwareVersion | String | V1.0.1 | 網關裝置的韌體版本號碼。 |
| GmtActive | String | 2019-12-18 23:25:30 | 網關裝置的啟用時間,GMT格式,是使用者所在地的當地時間。 |
| GmtCreate | String | 2019-12-18 16:58:33 | 網關裝置的建立時間,GMT格式,是使用者所在地的當地時間。 |
| GmtOnline | String | 2020-01-20 17:41:04 | 網關裝置最近一次上線的時間,GMT格式,是使用者所在地的當地時間。 |
| IpAddress | String | 106.**.1**.** | 網關裝置的IP地址。 |
| NodeType | String | 1 | 節點類型,取值為1,表示該裝置為網關裝置。 |
| ProductKey | String | a1BwAGV**** | 網關裝置隸屬的產品ProductKey。 |
| ProductName | String | LinkIoT | 網關裝置隸屬的產品名稱。 |
| Status | String | online | 網關裝置狀態。取值:
|
| UtcActive | String | 2019-12-18T15:25:30.176Z | 網關裝置的啟用時間,UTC格式,世界標準時間。使用者所在地實際時間,可根據當地時差計算。 |
| UtcCreate | String | 2019-12-18T08:58:33.000Z | 網關裝置的建立時間,UTC格式,世界標準時間。使用者所在地實際時間,可根據當地時差計算。 |
| UtcOnline | String | 2020-01-20T09:41:04.879Z | 網關裝置最近一次上線的時間,UTC格式,世界標準時間。使用者所在地實際時間,可根據當地時差計算。 |
| iotId | String | WuyjPSDQE1L22z1d****000100 | 物聯網平台為該網關裝置頒發的ID,作為該裝置的唯一識別碼。 |
| region | String | cn-shanghai | 網關裝置所在地區(與控制台上的地區對應)。 |
| ErrorMessage | String | 系統異常 | 調用失敗時,返回的出錯資訊。 |
| RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 阿里雲為該請求產生的唯一識別碼。 |
| Success | Boolean | true | 表示是否調用成功。
|
樣本
請求樣本
https://iot.cn-shanghai.aliyuncs.com/?Action=GetGatewayBySubDevice
&ProductKey=a1BwAGV****
&DeviceName=XTzosqEOgxFXKPRgd8zl
&<公用請求參數>
正常返回樣本
XML格式
<GetGatewayBySubDeviceResponse>
<Data>
<region>cn-shanghai</region>
<DeviceName>gateway_04</DeviceName>
<GmtActive>2019-12-18 23:25:30</GmtActive>
<ProductKey>a1vL7cp****</ProductKey>
<IpAddress>106.**.1**.**</IpAddress>
<GmtCreate>2019-12-18 16:58:33</GmtCreate>
<UtcCreate>2019-12-18T08:58:33.000Z</UtcCreate>
<UtcOnline>2020-01-20T09:41:04.879Z</UtcOnline>
<UtcActive>2019-12-18T15:25:30.176Z</UtcActive>
<Status>online</Status>
<NodeType>1</NodeType>
<GmtOnline>2020-01-20 17:41:04</GmtOnline>
<ProductName>LinkIoTEdge_Gateway</ProductName>
<iotId>WuyjPSDQE1L22z1****000100</iotId>
</Data>
<RequestId>0377D5A9-BDE1-48C2-96C9-BDC048899186</RequestId>
<Success>true</Success>
</GetGatewayBySubDeviceResponse>
JSON格式
{
"Data": {
"region": "cn-shanghai",
"DeviceName": "gateway_04",
"GmtActive": "2019-12-18 23:25:30",
"ProductKey": "a1vL7cp****",
"IpAddress": "106.**.1**.**",
"GmtCreate": "2019-12-18 16:58:33",
"UtcCreate": "2019-12-18T08:58:33.000Z",
"UtcOnline": "2020-01-20T09:41:04.879Z",
"UtcActive": "2019-12-18T15:25:30.176Z",
"Status": "online",
"NodeType": 1,
"GmtOnline": "2020-01-20 17:41:04",
"ProductName": "LinkIoTEdge_Gateway",
"iotId": "WuyjPSDQE1L22z1****000100"
},
"RequestId": "0377D5A9-BDE1-48C2-96C9-BDC048899186",
"Success": true
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。