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

Consulta los detalles de un grupo.

Límites

Cada cuenta de Alibaba Cloud admite un máximo de 30 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í	QueryDeviceGroupInfo	La operación que desea ejecutar. Establezca el valor en QueryDeviceGroupInfo.
GroupId	String	Sí	tDQvBJqbUyHs****	El ID del grupo. Este ID es el identificador único global (GUID) del grupo. Llame a la operación QueryDeviceGroupList para consultar el parámetro GroupId.
IotInstanceId	String	No	iot-cn-0pp1n8t****	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 más información, consulte Descripción general.
GroupType	String	No	LINK_PLATFORM_DYNAMIC	El tipo de grupo. Establezca el valor en LINK_PLATFORM_DYNAMIC. Este valor indica un grupo dinámico. Si no especifica este parámetro, se consulta un grupo estático de forma predeterminada.

Además de los parámetros específicos de la operación anteriores, debe especificar los parámetros de solicitud comunes al llamar a esta operación. Para 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 más información, consulte Códigos de error.
Data	Struct		Los detalles del grupo devueltos si la llamada es exitosa. Incluye los siguientes campos:
DeviceActive	Integer	1	El número de dispositivos activados.
DeviceCount	Integer	10	El número total de dispositivos.
DeviceOnline	Integer	0	El número de dispositivos en línea.
DynamicGroupExpression	String	product_key = "a1***" and name LIKE "test%"	La regla del grupo dinámico. Este parámetro se devuelve solo si se consulta un grupo dinámico.
GroupDesc	String	usefulGroup	La descripción del grupo.
GroupId	String	tDQvBJqbUyHs****	El ID del grupo.
GroupName	String	aliyun	El nombre del grupo.
UtcCreate	String	2018-09-14T14:35:51.000Z	La hora en que se creó el grupo.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	7411716B-A488-4EEB-9AA0-6DB05AD2491F	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=QueryDeviceGroupInfo
&GroupId=tDQvBJqbUyHs****
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

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

Formato JSON

{
    "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
}

Códigos de error

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