QueryDeviceGroupInfo - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les détails d'un groupe.

Limites

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

Remarque

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

Débogage

Alibaba Cloud met à disposition OpenAPI Explorer pour simplifier l'utilisation des API. OpenAPI Explorer calcule automatiquement la valeur de la signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer pour plus de commodité. 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	QueryDeviceGroupInfo	L'opération que vous souhaitez effectuer. Définissez la valeur sur QueryDeviceGroupInfo.
GroupId	String	Oui	tDQvBJqbUyHs****	L'ID du groupe. L'ID est l'identifiant unique global (GUID) du groupe. Vous pouvez appeler l'opération QueryDeviceGroupList pour interroger le paramètre GroupId.
IotInstanceId	String	Non	iot-cn-0pp1n8t****	L'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. Si vous ne définissez pas ce paramètre, l'appel échouera. Si votre instance ne possède pas de page Overview ou d'ID, vous n'avez pas besoin de définir ce paramètre. Pour plus d'informations, consultez la rubrique Overview.
GroupType	String	Non	LINK_PLATFORM_DYNAMIC	Le type de groupe. Définissez la valeur sur LINK_PLATFORM_DYNAMIC. Cette valeur indique un groupe dynamique. Si vous ne spécifiez pas ce paramètre, un groupe statique est interrogé par défaut.

En plus des paramètres de requête spécifiques à l'opération mentionnés ci-dessus, vous devez spécifier les paramètres de requête communs lors de l'appel à cette opération. Pour plus d'informations, consultez la rubrique Paramètres de requête communs.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Le code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez la rubrique Codes d'erreur.
Data	Struct		Les détails du groupe renvoyés en cas de réussite de l'appel. Ce paramètre inclut les paramètres suivants.
DeviceActive	Integer	1	Le nombre d'appareils activés.
DeviceCount	Integer	10	Le nombre total d'appareils.
DeviceOnline	Integer	0	Le nombre d'appareils en ligne.
DynamicGroupExpression	String	product_key = "a1***" and name LIKE "test%"	La règle du groupe dynamique. Ce paramètre est renvoyé si un groupe dynamique est interrogé.
GroupDesc	String	usefulGroup	La description du groupe.
GroupId	String	tDQvBJqbUyHs****	L'ID du groupe.
GroupName	String	aliyun	Le nom du groupe.
UtcCreate	String	2018-09-14T14:35:51.000Z	L'heure de création du groupe.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	7411716B-A488-4EEB-9AA0-6DB05AD2491F	L'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=QueryDeviceGroupInfo
&GroupId=tDQvBJqbUyHs****
&<Common request parameters>

Exemple de réponse réussie

XML format

<QueryDeviceGroupInfoResponse>
<RequestId>7411716B-A488-4EEB-9AA0-6DB05AD2491F</RequestId>
<Data>
    <GroupName>aliyun</GroupName>
    <UtcCreate>2021-10-14T14:35:51.000Z</UtcCreate>
    <DeviceOnline>0</DeviceOnline>
    <GroupDesc>usefulGroup</GroupDesc>
    <DeviceActive>1</DeviceActive>
    <DynamicGroupExpression>product_key = "a1***" and name LIKE "test%"</DynamicGroupExpression>
    <DeviceCount>10</DeviceCount>
    <GroupId>tDQvBJqbUyHs****</GroupId>
</Data>
<Success>true</Success>
</QueryDeviceGroupInfoResponse>

JSON format

{
    "RequestId": "7411716B-A488-4EEB-9AA0-6DB05AD2491F",
    "Data": {
        "GroupName": "aliyun",
        "UtcCreate": "2021-10-14T14:35:51.000Z",
        "DeviceOnline": 0,
        "GroupDesc": "usefulGroup",
        "DeviceActive": 1,
        "DynamicGroupExpression": "product_key = \"a1***\" and name LIKE \"test%\"",
        "DeviceCount": 10,
        "GroupId": "tDQvBJqbUyHs****"
    },
    "Success": true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs API.