QueryDeviceStatistics - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les statistiques des appareils, notamment le nombre d'appareils en ligne, le nombre d'appareils activés et le nombre total d'appareils créés.

Limites

Chaque compte Alibaba Cloud peut exécuter un maximum de 50 requêtes par seconde (QPS).

Remarque

Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota de ce compte.

Débogage

Alibaba Cloud met à votre disposition OpenAPI Explorer pour simplifier l'utilisation des API. OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QueryDeviceStatistics	L'opération que vous souhaitez effectuer. Définissez la valeur sur QueryDeviceStatistics.
IotInstanceId	String	Non	iot_instc_pu***_c-v64********	ID de l'instance. Vous pouvez consulter l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez configurer ce paramètre. À défaut, l'appel échouera. Si votre instance ne dispose pas de page Overview ou d'ID, il n'est pas nécessaire de définir ce paramètre. Pour plus d'informations, consultez la rubrique Vue d'ensemble.
ProductKey	String	Non	a1BwAGV****	ProductKey du produit auquel appartiennent les appareils. Si vous spécifiez ce paramètre, les statistiques des appareils liés au produit sont renvoyées. Si vous spécifiez également le paramètre GroupId, les statistiques des appareils créés sous le produit et ajoutés au groupe sont renvoyées. Si vous ne spécifiez ni ce paramètre ni le paramètre GroupId, les statistiques de tous les appareils associés au compte actuel sont renvoyées.
GroupId	String	Non	W16X8Tvdosec****	ID du groupe auquel appartiennent les appareils. Si vous spécifiez ce paramètre, les statistiques des appareils ajoutés au groupe sont renvoyées. Si vous spécifiez également le paramètre ProductKey, les statistiques des appareils créés sous le produit et ajoutés au groupe sont renvoyées. Si vous ne spécifiez ni ce paramètre ni le paramètre ProductKey, les statistiques de tous les appareils associés au compte actuel sont renvoyées.

Outre les paramètres de requête spécifiques à l'opération présentés ci-dessus, vous devez spécifier les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations, consultez la rubrique <a class="xref" data-link-href-cangjie="~~30561~~" href="/help/fr/iot/developer-reference/common-parameters" id="xref_5dn_x08_438" rel="noopener noreferrer" target="_blank">Paramètres de requête communs</a>.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez la rubrique Codes d'erreur.
Data	Struct		Statistiques des appareils renvoyées en cas de réussite de l'appel.
activeCount	Long	10	Nombre d'appareils activés.
deviceCount	Long	100	Nombre total d'appareils.
onlineCount	Long	10	Nombre d'appareils en ligne.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemple de requête

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

Exemple de réponse en cas de succès

Format XML

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

Format JSON

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

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le <a class="xref" data-link-href-cangjie="https://error-center.alibabacloud.com/status/product/Iot" href="https://error-center.alibabacloud.com/status/product/Iot" id="xref_8py_jda_lgf" rel="noopener noreferrer" target="_blank">Centre d'erreurs API</a>.