Queries the statistics of devices, including the number of online devices, the number of activated devices, and the total number of created devices.

Limits

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

Note RAM users of an Alibaba Cloud account share the quota of the account.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. 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 ID of the instance. You can view the instance ID on the Overview page in the IoT Platform console.

Notice
  • If your instance has an ID, you must configure this parameter. If you do not set this parameter, the call fails.
  • If your instance has no Overview page or ID, you do not need to set this parameter.

For more information, see Overview.

ProductKey String No a1BwAGV****

The ProductKey of the product to which the devices belong.

  • If you specify this parameter, the statistics of the devices under the product is returned. If you also specify GroupId, the statistics of the devices that are created under the product and added to the group is returned.
  • If you do not specify this parameter and GroupId, the statistics of all devices within the current account is returned.
GroupId String No W16X8Tvdosec****

The ID of the group to which the devices belong.

  • If you specify this parameter, the statistics of the devices that are added to the group is returned. If you also specify ProductKey, the statistics of the devices that are created under the product and added to the group is returned.
  • If you do not specify this parameter and ProductKey, the statistics of all devices within the current account is returned.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information, see Common request 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 is successful.

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 was successful.

  • true: The call was successful.
  • 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.