調(diào)用該接口查詢指定設(shè)備的詳細(xì)信息。
QPS限制
單個阿里云賬號調(diào)用該接口的每秒請求數(shù)（QPS）最大限制為50。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | QueryDeviceDetail |
系統(tǒng)規(guī)定參數(shù)。取值：QueryDeviceDetail。 |
| IotInstanceId | String | 否 | iot-v64*** |
實例ID。您可在物聯(lián)網(wǎng)平臺控制臺的實例概覽頁面，查看當(dāng)前實例的ID。 注意
實例的更多信息，請參見實例概述。 |
| ProductKey | String | 否 | a1BwAGV**** |
要查詢的設(shè)備所隸屬的產(chǎn)品Key。 說明 如果傳入該參數(shù)，需同時傳入DeviceName。
|
| DeviceName | String | 否 | light |
指定要查詢的設(shè)備的名稱。 說明 如果傳入該參數(shù)，需同時傳入ProductKey。
|
| IotId | String | 否 | Q7uOhVRdZRRlDnTLv****00100 |
要查詢的設(shè)備ID。 說明 如果傳入該參數(shù)，則無需傳入ProductKey和DeviceName。IotId作為設(shè)備唯一標(biāo)識符，和ProductKey與DeviceName組合是一一對應(yīng)的關(guān)系。如果您同時傳入IotId和ProductKey與DeviceName組合，則以IotId為準(zhǔn)。
|
調(diào)用API時，除了本文介紹的該API的特有請求參數(shù)，還需傳入公共請求參數(shù)。公共請求參數(shù)說明，請參見公共參數(shù)文檔。
返回數(shù)據(jù)
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | iot.system.SystemException |
調(diào)用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。 |
| Data | Struct |
調(diào)用成功時，返回設(shè)備的詳細(xì)信息。 |
|
| DeviceName | String | light |
設(shè)備名稱。 |
| DeviceSecret | String | mz2Canp4GB7qRVf1OYPNtRqB2anu**** |
設(shè)備密鑰。 |
| FirmwareVersion | String | V1.0.0.0 |
設(shè)備默認(rèn)（default）OTA模塊的版本號。 如果需要查詢設(shè)備上報過的其他OTA模塊版本信息，請參見ListOTAModuleVersionsByDevice。 |
| GmtActive | String | 2018-08-06 10:48:41 |
設(shè)備的激活時間，GMT格式。 |
| GmtCreate | String | 2018-08-06 10:47:50 |
設(shè)備的創(chuàng)建時間，GMT格式。 |
| GmtOnline | String | 2018-08-06 13:43:12 |
設(shè)備最近一次上線的時間，GMT格式。 |
| IotId | String | Q7uOhVRdZRRlDnTLv****00100 |
物聯(lián)網(wǎng)平臺為該設(shè)備頒發(fā)的ID，作為該設(shè)備的唯一標(biāo)識符。 |
| IpAddress | String | 10.0.0.1 |
設(shè)備的IP地址。 |
| Nickname | String | detectors_in_beijing |
設(shè)備的備注名稱。 |
| NodeType | Integer | 0 |
節(jié)點類型，取值：
|
| Owner | Boolean | true |
API調(diào)用者是否是該設(shè)備的擁有者。 |
| ProductKey | String | a1rYuVF**** |
設(shè)備所屬產(chǎn)品的ProductKey。 |
| ProductName | String | test |
設(shè)備所屬產(chǎn)品的名稱。 |
| Region | String | cn-shanghai |
設(shè)備所在地區(qū)（與控制臺上的物聯(lián)網(wǎng)地平臺服務(wù)地域?qū)?yīng)）。 |
| Status | String | ONLINE |
設(shè)備狀態(tài)。取值：
|
| UtcActive | String | 2018-08-06T02:48:41.000Z |
設(shè)備的激活時間，UTC格式。 |
| UtcCreate | String | 2018-08-06T02:47:50.000Z |
設(shè)備的創(chuàng)建時間，UTC格式。 |
| UtcOnline | String | 2018-08-06T05:43:12.000Z |
設(shè)備最近一次上線的時間，UTC格式。 |
| ErrorMessage | String | 系統(tǒng)異常 |
調(diào)用失敗時，返回的出錯信息。 |
| RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 |
阿里云為該請求生成的唯一標(biāo)識符。 |
| Success | Boolean | true |
表示是否調(diào)用成功。
|
示例
請求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceDetail
&ProductKey=a1rYuVF****
&DeviceName=device1
&<公共請求參數(shù)>正常返回示例
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
}