QueryDeviceGroupByTags - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les groupes de périphériques par tag.

Limites

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

Remarque

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

Débogage

Alibaba Cloud met à votre disposition OpenAPI Explorer pour simplifier l'utilisation des API. OpenAPI Explorer calcule automatiquement la valeur de la signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de la requête

Parameter	Type	Required	Example	Description
Action	String	Yes	QueryDeviceGroupByTags	Opération à effectuer. Définissez la valeur sur QueryDeviceGroupByTags.
Tag.N.TagKey	String	Yes	group	Clé de chaque tag.
Tag.N.TagValue	String	Yes	tag	Valeur du tag.
IotInstanceId	String	No	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 échoue. Si votre instance ne possède pas de page Overview ou d'ID, il n'est pas nécessaire de définir ce paramètre. Pour plus d'informations, consultez Overview.
CurrentPage	Integer	No	1	Numéro de la page à renvoyer. Valeur par défaut : 1.
PageSize	Integer	No	10	Nombre d'entrées à renvoyer par page. Valeur par défaut : 10.

Outre les paramètres de requête spécifiques à l'opération, vous devez spécifier les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations, consultez Paramètres de requête communs.

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez Codes d'erreur.
Data	Array of DeviceGroup		Informations sur le groupe renvoyées en cas de réussite de l'appel.
DeviceGroup
GroupId	String	Z0ElGF5aqc0t****	ID du groupe.
GroupName	String	test11	Nom du groupe.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
Page	Integer	1	Numéro de la page renvoyée.
PageCount	Integer	1	Nombre total de pages.
PageSize	Integer	10	Nombre d'entrées renvoyées par page.
RequestId	String	9599EE98-1642-4FCD-BFC4-039E458A4693	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é.
Total	Integer	1	Nombre total d'enregistrements.

Exemples

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceGroupByTags
&Tag.1.TagKey=group
&Tag.1.TagValue=tag
&CurrentPage=1
&PageSize=10
&<Common request parameters>

Exemples de réponses réussies

Format XML

<QueryDeviceGroupByTagsResponse> 
    <PageCount>1</PageCount>  
    <Data> 
        <DeviceGroup> 
            <GroupName>test11</GroupName>  
            <GroupId>Z0ElGF5aqc0t****</GroupId> 
        </DeviceGroup> 
    </Data>  
    <Page>1</Page>  
    <PageSize>10</PageSize>  
    <RequestId>9599EE98-1642-4FCD-BFC4-039E458A4693</RequestId>  
    <Success>true</Success>  
    <Total>1</Total> 
</QueryDeviceGroupByTagsResponse>

Format JSON

{
    "PageCount": 1, 
    "Data": {
        "DeviceGroup": [
            {
                "GroupName": "test11", 
                "GroupId": "Z0ElGF5aqc0t****"
            }
        ]
    }, 
    "Page": 1, 
    "PageSize": 10, 
    "RequestId": "9599EE98-1642-4FCD-BFC4-039E458A4693", 
    "Success": true, 
    "Total": 1
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs de l'API.