QueryDeviceStatistics - IoT Platform - Centro de documentación de Alibaba Cloud

Consulta las estadísticas de los dispositivos, como la cantidad de dispositivos en línea, la cantidad de dispositivos activados y el total de dispositivos creados.

Límites

Cada cuenta de Alibaba Cloud admite un máximo de 50 consultas por segundo (QPS).

Nota

Los usuarios RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

Alibaba Cloud proporciona OpenAPI Explorer para simplificar el uso de la API. OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	QueryDeviceStatistics	La operación que desea ejecutar. Establezca el valor en QueryDeviceStatistics.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, configure este parámetro. De lo contrario, la llamada fallará. Si su instancia no tiene página Overview ni ID, omita este parámetro. Para obtener más información, consulte Descripción general.
ProductKey	String	No	a1BwAGV****	La ProductKey del producto al que pertenecen los dispositivos. Si especifica este parámetro, se devuelven las estadísticas de los dispositivos de ese producto. Si también especifica GroupId, se devuelven las estadísticas de los dispositivos creados bajo el producto y agregados al grupo. Si no especifica este parámetro ni GroupId, se devuelven las estadísticas de todos los dispositivos de la cuenta actual.
GroupId	String	No	W16X8Tvdosec****	El ID del grupo al que pertenecen los dispositivos. Si especifica este parámetro, se devuelven las estadísticas de los dispositivos agregados al grupo. Si también especifica ProductKey, se devuelven las estadísticas de los dispositivos creados bajo el producto y agregados al grupo. Si no especifica este parámetro ni ProductKey, se devuelven las estadísticas de todos los dispositivos de la cuenta actual.

Además de los parámetros de solicitud específicos de la operación, debe especificar los parámetros de solicitud comunes al llamar a esta operación. Para obtener más información, consulte Parámetros de solicitud comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
Data	Struct		Las estadísticas del dispositivo devueltas si la llamada es exitosa.
activeCount	Long	10	La cantidad de dispositivos activados.
deviceCount	Long	100	La cantidad total de dispositivos.
onlineCount	Long	10	La cantidad de dispositivos en línea.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

Formato XML

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

Formato JSON

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

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.