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

Consulta las etiquetas de un grupo.

Límites

Cada cuenta de Alibaba Cloud admite un máximo de 500 consultas por segundo (QPS).

Nota

Los usuarios RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

Alibaba Cloud ofrece 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 desde OpenAPI Explorer. Esta herramienta 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í	QueryDeviceGroupTagList	La operación que desea ejecutar. Establezca el valor en QueryDeviceGroupTagList.
GroupId	String	Sí	W16X8Tvdosec****	El ID del grupo. Este ID es el identificador único global (GUID) del grupo.
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.
GroupType	String	No	LINK_PLATFORM_DYNAMIC	El tipo de grupo. Si establece el valor en LINK_PLATFORM_DYNAMIC, se consulta 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 de solicitud específicos de la operación mencionados a continuación, debe especificar 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 GroupTagInfo		La información de etiquetas devuelta si la llamada es exitosa. Para obtener más información, consulte el siguiente parámetro GroupTagInfo.
GroupTagInfo
TagKey	String	room1	La clave de la etiqueta.
TagValue	String	bulb	El valor de la etiqueta.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	214154FF-9D47-4E3F-AAAD-F4CE67F41060	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=QueryDeviceGroupTagList
&GroupId=W16X8Tvdosec****
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<QueryDeviceGroupTagListResponse>
      <Data>
            <GroupTagInfo>
                  <TagValue>bulb</TagValue>
                  <TagKey>room1</TagKey>
            </GroupTagInfo>
      </Data>
      <RequestId>214154FF-9D47-4E3F-AAAD-F4CE67F41060</RequestId>
      <Success>true</Success>
</QueryDeviceGroupTagListResponse>

Formato JSON

{
    "Data":{
        "GroupTagInfo":[
            {
                "TagValue":"bulb",
                "TagKey":"room1"
            }
        ]
    },
    "RequestId":"214154FF-9D47-4E3F-AAAD-F4CE67F41060",
    "Success":true
}

Códigos de error

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