調用該介面查詢指定裝置的詳細資料。
QPS限制
單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為50。
說明 RAM使用者共用阿里雲帳號配額。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
| 名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
| Action | String | 是 | QueryDeviceDetail | 系統規定參數。取值:QueryDeviceDetail。 |
| IotInstanceId | String | 否 | iot-v64*** | 執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID。 重要
執行個體的更多資訊,請參見執行個體概述。 |
| ProductKey | String | 否 | a1BwAGV**** | 要查詢的裝置所隸屬的產品Key。 說明 如果傳入該參數,需同時傳入DeviceName。 |
| DeviceName | String | 否 | light | 指定要查詢的裝置的名稱。 說明 如果傳入該參數,需同時傳入ProductKey。 |
| IotId | String | 否 | Q7uOhVRdZRRlDnTLv****00100 | 要查詢的裝置ID。 說明 如果傳入該參數,則無需傳入ProductKey和DeviceName。IotId作為裝置唯一識別碼,和ProductKey與DeviceName組合是一一對應的關係。如果您同時傳入IotId和ProductKey與DeviceName組合,則以IotId為準。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公用請求參數。公用請求參數說明,請參見公用參數文檔。
返回資料
| 名稱 | 類型 | 樣本值 | 描述 |
| Code | String | iot.system.SystemException | 調用失敗時,返回的錯誤碼。更多資訊,請參見錯誤碼。 |
| Data | Struct | 調用成功時,返回裝置的詳細資料。 |
|
| DeviceName | String | light | 裝置名稱。 |
| DeviceSecret | String | mz2Canp4GB7qRVf1OYPNtRqB2anu**** | 裝置密鑰。 |
| FirmwareVersion | String | V1.0.0.0 | 裝置預設(default)OTA模組的版本號碼。 如果需要查詢裝置上報過的其他OTA模組版本資訊,請參見ListOTAModuleVersionsByDevice。 |
| GmtActive | String | 2018-08-06 10:48:41 | 裝置的啟用時間,GMT格式。 |
| GmtCreate | String | 2018-08-06 10:47:50 | 裝置的建立時間,GMT格式。 |
| GmtOnline | String | 2018-08-06 13:43:12 | 裝置最近一次上線的時間,GMT格式。 |
| IotId | String | Q7uOhVRdZRRlDnTLv****00100 | 物聯網平台為該裝置頒發的ID,作為該裝置的唯一識別碼。 |
| IpAddress | String | 10.0.0.1 | 裝置的IP地址。 |
| Nickname | String | detectors_in_beijing | 裝置的備忘名稱。 |
| NodeType | Integer | 0 | 節點類型,取值:
|
| Owner | Boolean | true | API調用者是否是該裝置的擁有者。 |
| ProductKey | String | a1rYuVF**** | 裝置所屬產品的ProductKey。 |
| ProductName | String | test | 裝置所屬產品的名稱。 |
| Region | String | cn-shanghai | 裝置所在地區(與控制台上的物聯網地平台服務地區對應)。 |
| Status | String | ONLINE | 裝置狀態。取值:
|
| UtcActive | String | 2018-08-06T02:48:41.000Z | 裝置的啟用時間,UTC格式。 |
| UtcCreate | String | 2018-08-06T02:47:50.000Z | 裝置的建立時間,UTC格式。 |
| UtcOnline | String | 2018-08-06T05:43:12.000Z | 裝置最近一次上線的時間,UTC格式。 |
| ErrorMessage | String | 系統異常 | 調用失敗時,返回的出錯資訊。 |
| RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 阿里雲為該請求產生的唯一識別碼。 |
| Success | Boolean | true | 表示是否調用成功。
|
樣本
請求樣本
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceDetail
&ProductKey=a1rYuVF****
&DeviceName=device1
&<公用請求參數>
正常返回樣本
XML格式
<QueryDeviceDetailResponse>
<Data>
<Owner>true</Owner>
<GmtActive>2020-01-16 13:33:37</GmtActive>
<DeviceName>Humidity</DeviceName>
<ProductKey>a1ttsqu****</ProductKey>
<DeviceSecret>sLefbFmN9SYfnWLJTePG893XNuRV****</DeviceSecret>
<IpAddress>42.120.75.144</IpAddress>
<GmtCreate>2020-01-08 14:47:08</GmtCreate>
<UtcCreate>2020-01-08T06:47:08.000Z</UtcCreate>
<IotId>dwnS41bhNxjslDAIF****00100</IotId>
<Status>OFFLINE</Status>
<UtcOnline>2020-01-17T08:19:11.091Z</UtcOnline>
<Region>cn-shanghai</Region>
<UtcActive>2020-01-16T05:33:37.830Z</UtcActive>
<Nickname>溫濕度</Nickname>
<NodeType>0</NodeType>
<GmtOnline>2020-01-17 16:19:11</GmtOnline>
<ProductName>光照溫濕度感應器</ProductName>
</Data>
<RequestId>D2D2DE90-DD0F-44EA-9F56-63F07A59F65B</RequestId>
<Success>true</Success>
</QueryDeviceDetailResponse>
JSON格式
{
"Data": {
"Owner": true,
"GmtActive": "2020-01-16 13:33:37",
"DeviceName": "Humidity",
"ProductKey": "a1ttsqu****",
"DeviceSecret": "sLefbFmN9SYfnWLJTePG893XNuRV****",
"IpAddress": "42.120.75.144",
"GmtCreate": "2020-01-08 14:47:08",
"UtcCreate": "2020-01-08T06:47:08.000Z",
"IotId": "dwnS41bhNxjslDAIF****00100",
"Status": "OFFLINE",
"UtcOnline": "2020-01-17T08:19:11.091Z",
"Region": "cn-shanghai",
"UtcActive": "2020-01-16T05:33:37.830Z",
"Nickname": "溫濕度",
"NodeType": 0,
"GmtOnline": "2020-01-17 16:19:11",
"ProductName": "光照溫濕度感應器"
},
"RequestId": "D2D2DE90-DD0F-44EA-9F56-63F07A59F65B",
"Success": true
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。