BatchGetDeviceState - IoT Platform

使用說明

調用本介面時：

請求參數同時傳入ProductKey和多個DeviceName：查詢同一產品多個裝置的運行狀態。
請求參數傳入多個IotId：可傳入不同產品下裝置的IotId，查詢不同產品下裝置的運行狀態。

重要單次調用本介面最多可查詢50個裝置的運行狀態。

QPS限制

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

說明單個阿里雲帳號下的所有RAM使用者共用該阿里雲帳號的配額。

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	BatchGetDeviceState	系統規定參數。取值：BatchGetDeviceState。
DeviceName.N	RepeatList	否	light	要查看運行狀態的裝置的名稱列表。重要如果傳入該參數，需同時傳入ProductKey。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
ProductKey	String	否	a1BwAGV****	要查看運行狀態的裝置所屬的產品ProductKey。重要如果傳入該參數，需同時傳入DeviceName。
IotId.N	RepeatList	否	Q7uOhVRdZRRlDnTLv****00100	要查看運行狀態的裝置ID列表。重要 IotId作為裝置唯一識別碼，和ProductKey與DeviceName組合是一一對應的關係。如果傳入該參數，則無需傳入ProductKey和DeviceName。如果您同時傳入IotId和ProductKey與DeviceName組合，則以IotId為準。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
DeviceStatusList	Array of DeviceStatus		調用成功時，返回裝置狀態資訊列表，請參見DeviceStatus下的參數。
DeviceStatus
AsAddress	String	192.0.2.1	裝置IP地址。
DeviceId	String	dwnS41bhNxjslDAI****	裝置ID（舊版參數）。說明該參數是舊版本遺留參數，已無實際作用，不能用來標識裝置。目前，有效裝置標識符為IotId和ProductKey與DeviceName組合。
DeviceName	String	light	裝置名稱。
IotId	String	dwnS41bhNxjslDAI****000100	裝置ID，物聯網平台為裝置頒發的唯一標識。
LastOnlineTime	String	2020-01-17 16:19:11	裝置最後一次上線的時間。
Status	String	OFFLINE	裝置狀態。取值： ONLINE：裝置線上。 OFFLINE：裝置離線。 UNACTIVE：裝置未啟用。 DISABLE：裝置已禁用。
Timestamp	Long	1557062301656	裝置狀態變更時間。單位為毫秒。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=BatchGetDeviceState
&productKey=a1BwAGV****
&DeviceName.1=device1
&DeviceName.2=device2
&<公用請求參數>

正常返回樣本

XML格式

<BatchGetDeviceStateResponse>
  <DeviceStatusList>
        <DeviceStatus>
              <Status>OFFLINE</Status>
              <DeviceId>dwnS41bhNxjslDAI****</DeviceId>
              <DeviceName>Humidity</DeviceName>
              <AsAddress>192.0.2.1</AsAddress>
              <LastOnlineTime>2020-01-17 16:19:11</LastOnlineTime>
              <Timestamp>1557062301656</Timestamp>
              <IotId>dwnS41bhNxjslDAI****000100</IotId>
        </DeviceStatus>
  </DeviceStatusList>
  <RequestId>3258D872-EDC5-4039-B564-C27ED7176741</RequestId>
  <Success>true</Success>
</BatchGetDeviceStateResponse>

JSON格式

{
	"DeviceStatusList": {
		"DeviceStatus": [
			{
				"Status": "OFFLINE",
				"DeviceId": "dwnS41bhNxjslDAI****",
				"DeviceName": "Humidity",
				"AsAddress": "192.0.2.1",
				"LastOnlineTime": "2020-01-17 16:19:11",
                "Timestamp":1557062301656,
				"IotId": "dwnS41bhNxjslDAI****000100"
			}
		]
	},
	"RequestId": "3258D872-EDC5-4039-B564-C27ED7176741",
	"Success": true
}

錯誤碼

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