調(diào)用該接口查詢?cè)O(shè)備統(tǒng)計(jì)數(shù)據(jù)，包括在線設(shè)備數(shù)、已激活設(shè)備數(shù)和已創(chuàng)建的設(shè)備總數(shù)。

QPS限制

單個(gè)阿里云賬號(hào)調(diào)用該接口的每秒請(qǐng)求數(shù)（QPS）最大限制為50。

說明 RAM用戶共享阿里云賬號(hào)配額。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 QueryDeviceStatistics

系統(tǒng)規(guī)定參數(shù)。取值：QueryDeviceStatistics。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

實(shí)例ID。您可在物聯(lián)網(wǎng)平臺(tái)控制臺(tái)的實(shí)例概覽頁面，查看當(dāng)前實(shí)例的ID。

注意
  • 若有ID值，必須傳入該ID值，否則調(diào)用會(huì)失敗。
  • 若無ID值，則無需傳入。

實(shí)例的更多信息，請(qǐng)參見實(shí)例概述。

ProductKey String 否 a1BwAGV****

要查詢?cè)O(shè)備所屬的產(chǎn)品ProductKey。

  • 傳入此參數(shù)，返回該產(chǎn)品下的設(shè)備統(tǒng)計(jì)數(shù)據(jù)。如果同時(shí)傳入GroupId，返回指定分組下該產(chǎn)品的設(shè)備統(tǒng)計(jì)數(shù)據(jù)。
  • 不傳入此參數(shù)和GroupId，則返回當(dāng)前賬號(hào)下所有設(shè)備統(tǒng)計(jì)數(shù)據(jù)。
GroupId String 否 W16X8Tvdosec****

要查詢?cè)O(shè)備所屬的分組ID。

  • 傳入此參數(shù)，返回該分組下的設(shè)備統(tǒng)計(jì)數(shù)據(jù)。如果同時(shí)傳入ProductKey，返回該分組下指定產(chǎn)品的設(shè)備統(tǒng)計(jì)數(shù)據(jù)。
  • 不傳入此參數(shù)和ProductKey，返回當(dāng)前賬號(hào)下所有設(shè)備統(tǒng)計(jì)數(shù)據(jù)。

調(diào)用API時(shí)，除了本文介紹的該API的特有請(qǐng)求參數(shù)，還需傳入公共請(qǐng)求參數(shù)。公共請(qǐng)求參數(shù)說明，請(qǐng)參見 公共參數(shù)文檔。

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
Code String iot.system.SystemException

調(diào)用失敗時(shí)，返回的錯(cuò)誤碼。更多信息，請(qǐng)參見錯(cuò)誤碼。

Data Struct

調(diào)用成功時(shí)，返回的設(shè)備統(tǒng)計(jì)信息。
activeCount Long 10

已激活的設(shè)備數(shù)量。
deviceCount Long 100

設(shè)備總數(shù)。
onlineCount Long 10

在線的設(shè)備數(shù)量。
ErrorMessage String 系統(tǒng)異常

調(diào)用失敗時(shí)，返回的出錯(cuò)信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云為該請(qǐng)求生成的唯一標(biāo)識(shí)符。
Success Boolean true

表示是否調(diào)用成功。

  • true：調(diào)用成功。
  • false：調(diào)用失敗。

示例

請(qǐng)求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceStatistics
&ProductKey=a1BwAGV****
&<公共請(qǐng)求參數(shù)>

正常返回示例

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
}