Queries the statistics of devices.

Limits

Each Alibaba Cloud account can run a maximum of 50 queries per second (QPS).

Note Resource Access Management (RAM) users of an Alibaba Cloud account share the quota of the account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes QueryDeviceStatistics

The operation that you want to perform. Set the value to QueryDeviceStatistics.
IotInstanceId String No iot_instc_pu****_c*-v64********

The instance ID. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased.

ProductKey String No a1BwAGV****

The key of the product to which the devices belong.

  • If you specify a product key, the operation returns the device statistics of the product.
  • If you do not specify this parameter, the operation returns the device statistics of the account.

In addition to the preceding exclusive request parameters, you must specify common request parameters when calling this API operation. For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code returned if the call fails. For more information, see Error codes.

Data Struct

The device statistics returned if the call succeeds.
activeCount Long 10

The number of activated devices.
deviceCount Long 100

The total number of devices.
onlineCount Long 10

The number of online devices.
ErrorMessage String A system exception occurred.

The error message returned if the call fails.
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

The ID of the request.
Success Boolean true

Indicates whether the call succeeds.

  • true: The call succeeded.
  • false: The call failed.

Examples

Sample requests

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceStatistics
&ProductKey=a1BwAGV****
&<Common request parameters>

Sample success responses

XML format 

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

JSON format 

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

Error codes

For a list of error codes, visit the API Error Center.