BatchQueryDeviceDetail - IoT Platform

使用說明

單次調用最多能查詢100個裝置。
只能批量查詢當前阿里雲帳號下的裝置詳情。如果傳入的裝置資訊中，有裝置不屬於當前帳號，則直接返回失敗結果。
若傳入的裝置資訊中，包含不存在的裝置，則只返回存在的裝置詳情。

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	BatchQueryDeviceDetail	系統規定參數。取值：BatchQueryDeviceDetail。
DeviceName.N	RepeatList	是	light	要查詢的裝置名稱列表。最多可包含100個裝置名稱。說明查詢的裝置必須在同一產品下。
ProductKey	String	是	a1BwAGV****	DeviceName.N中裝置所屬產品的ProductKey。
IotInstanceId	String	否	iot-v64***	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Array of Data		調用成功時，返回裝置的詳細資料。
Data
DeviceName	String	light	裝置名稱。
DeviceSecret	String	mz2Canp4GB7qRVf1OYPNtRqB2anu****	裝置密鑰。
FirmwareVersion	String	V1.0.0.0	裝置預設（default）OTA模組的版本號碼。如果需要查詢裝置上報過的其他OTA模組版本資訊，請參見ListOTAModuleVersionsByDevice。
GmtActive	String	2019-06-21 20:33:00	裝置的啟用時間，GMT格式。
GmtCreate	String	2019-06-21 20:31:42	裝置的建立時間，GMT格式。
IotId	String	Q7uOhVRdZRRlDnTLv****00100	物聯網平台為該裝置頒發的ID，裝置的唯一識別碼。
Nickname	String	智能路燈	裝置的備忘名稱。
NodeType	Integer	0	節點類型，取值： 0：裝置。裝置不能掛載子裝置。可以直連物聯網平台，也可以作為網關的子裝置串連物聯網平台。 1：網關。網關可以掛載子裝置，具有子裝置管理模組，維持子裝置的拓撲關係，和將拓撲關係同步到物聯網平台。
ProductKey	String	a1BwAGV****	裝置所屬產品的ProductKey。
ProductName	String	路燈產品	裝置所屬產品的名稱。
Region	String	cn-shanghai	裝置所在地區（與控制台上物聯網平台服務地區對應）。
Status	String	ONLINE	裝置狀態。取值： ONLINE：裝置線上。 OFFLINE：裝置離線。 UNACTIVE：裝置未啟用。 DISABLE：裝置已禁用。
UtcActive	String	2019-06-21T12:31:42.000Z	裝置的啟用時間，UTC格式。
UtcCreate	String	2019-06-21T12:31:42.000Z	裝置的建立時間，UTC格式。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=BatchQueryDeviceDetail
&ProductKey=a1fce6J****
&DeviceName.1=firstDeviceName
&DeviceName.2=secondDeviceName
&<公用請求參數>

正常返回樣本

XML格式

<BatchQueryDeviceDetailResponse>
  <Data>
        <Data>
              <DeviceName>Humidity</DeviceName>
              <GmtActive>2020-01-16 13:33:37</GmtActive>
              <ProductKey>a1ttsqu****</ProductKey>
              <DeviceSecret>sLefbFmN9SYfnWLJTePG893XNuRV****</DeviceSecret>
              <GmtCreate>2020-01-08 14:47:08</GmtCreate>
              <UtcCreate>2020-01-08T06:47:08.000Z</UtcCreate>
              <IotId>dwnS41bhNxjslDAIF****00100</IotId>
              <Status>OFFLINE</Status>
              <UtcActive>2020-01-08T06:47:08.000Z</UtcActive>
              <Region>cn-shanghai</Region>
              <Nickname>溫濕度</Nickname>
              <NodeType>0</NodeType>
              <ProductName>光照溫濕度感應器</ProductName>
        </Data>
        <Data>
              <Status>OFFLINE</Status>
              <GmtActive>2020-01-17 16:23:15</GmtActive>
              <DeviceName>TH_sensor</DeviceName>
              <Region>cn-shanghai</Region>
              <UtcActive>2020-01-17T03:39:14.000Z</UtcActive>
              <ProductKey>a1ttsqu****</ProductKey>
              <NodeType>0</NodeType>
              <DeviceSecret>dCYdTU3gw5Z77bsHjPk6lPHPVnBT****</DeviceSecret>
              <ProductName>光照溫濕度感應器</ProductName>
              <GmtCreate>2020-01-17 11:39:14</GmtCreate>
              <UtcCreate>2020-01-17T03:39:14.000Z</UtcCreate>
              <IotId>RKYkCRstfGBh5SZXL****00100</IotId>
        </Data>
  </Data>
  <RequestId>D4C12DD8-4390-4877-B1DC-4049CF4868BC</RequestId>
  <Success>true</Success>
</BatchQueryDeviceDetailResponse>

JSON格式

{
	"Data": {
		"Data": [
			{
				"DeviceName": "Humidity",
				"GmtActive": "2020-01-16 13:33:37",
				"ProductKey": "a1ttsqu****",
				"DeviceSecret": "sLefbFmN9SYfnWLJTePG893XNuRV****",
				"GmtCreate": "2020-01-08 14:47:08",
				"UtcCreate": "2020-01-08T06:47:08.000Z",
				"IotId": "dwnS41bhNxjslDAIF****00100",
				"Status": "OFFLINE",
				"UtcActive": "2020-01-08T06:47:08.000Z",
				"Region": "cn-shanghai",
				"Nickname": "溫濕度",
				"NodeType": 0,
				"ProductName": "光照溫濕度感應器"
			},
			{
				"Status": "OFFLINE",
				"GmtActive": "2020-01-17 16:23:15",
				"DeviceName": "TH_sensor",
				"Region": "cn-shanghai",
				"UtcActive": "2020-01-17T03:39:14.000Z",
				"ProductKey": "a1ttsqu****",
				"NodeType": 0,
				"DeviceSecret": "dCYdTU3gw5Z77bsHjPk6lPHPVnBT****",
				"ProductName": "光照溫濕度感應器",
				"GmtCreate": "2020-01-17 11:39:14",
				"UtcCreate": "2020-01-17T03:39:14.000Z",
				"IotId": "RKYkCRstfGBh5SZXL****00100"
			}
		]
	},
	"RequestId": "D4C12DD8-4390-4877-B1DC-4049CF4868BC",
	"Success": true
}

錯誤碼

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