QueryDeviceStatistics - IoT Platform

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryDeviceStatistics	系統規定參數。取值：QueryDeviceStatistics。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
ProductKey	String	否	a1BwAGV****	要查詢裝置所屬的產品ProductKey。傳入此參數，返回該產品下的裝置統計資料。如果同時傳入GroupId，返回指定分組下該產品的裝置統計資料。不傳入此參數和GroupId，則返回當前帳號下所有裝置統計資料。
GroupId	String	否	W16X8Tvdosec****	要查詢裝置所屬的分組ID。傳入此參數，返回該分組下的裝置統計資料。如果同時傳入ProductKey，返回該分組下指定產品的裝置統計資料。不傳入此參數和ProductKey，返回當前帳號下所有裝置統計資料。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Struct		調用成功時，返回的裝置統計資訊。
activeCount	Long	10	已啟用的裝置數量。
deviceCount	Long	100	裝置總數。
onlineCount	Long	10	線上的裝置數量。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceStatistics
&ProductKey=a1BwAGV****
&<公用請求參數>

正常返回樣本

XML格式

<QueryDeviceStatisticsResponse>
  <Data>
        <deviceCount>2</deviceCount>
        <activeCount>2</activeCount>
        <onlineCount>0</onlineCount>
  </Data>
  <RequestId>8AC026D2-6F16-4719-A396-969D63DCA138</RequestId>
  <Success>true</Success>
</QueryDeviceStatisticsResponse>

JSON格式

{
	"Data": {
		"deviceCount": 2,
		"activeCount": 2,
		"onlineCount": 0
	},
	"RequestId": "8AC026D2-6F16-4719-A396-969D63DCA138",
	"Success": true
}

錯誤碼

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