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

Consulta grupos de dispositivos por etiqueta.

Límites

Cada cuenta de Alibaba Cloud admite un máximo de 5 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 en OpenAPI Explorer. OpenAPI Explorer 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í	QueryDeviceGroupByTags	La operación que desea ejecutar. Establezca el valor en QueryDeviceGroupByTags.
Tag.N.TagKey	String	Sí	group	La clave de cada etiqueta.
Tag.N.TagValue	String	Sí	tag	El valor de la etiqueta.
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 de Overview o ID, omita este parámetro. Para obtener más información, consulte Descripción general.
CurrentPage	Integer	No	1	El número de página que se devolverá. Valor predeterminado: 1.
PageSize	Integer	No	10	El número de entradas que se devolverán en cada página. Valor predeterminado: 10.

Además de los parámetros de solicitud específicos de la operación anteriores, especifique 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	Array of DeviceGroup		La información del grupo devuelta si la llamada es exitosa.
DeviceGroup
GroupId	String	Z0ElGF5aqc0t****	El ID del grupo.
GroupName	String	test11	El nombre del grupo.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
Page	Integer	1	El número de la página devuelta.
PageCount	Integer	1	El número total de páginas.
PageSize	Integer	10	El número de entradas devueltas en cada página.
RequestId	String	9599EE98-1642-4FCD-BFC4-039E458A4693	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.
Total	Integer	1	El número total de registros.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

Formato 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>

Formato JSON

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

Códigos de error

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