调用该接口查询设备统计数据，包括在线设备数、已激活设备数和已创建的设备总数。

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
}