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

Consulta todos los grupos de consumidores de la cuenta actual al usar suscripciones AMQP del lado del servidor. También puede llamar a esta operación para buscar por nombre de grupo de consumidores mediante coincidencia aproximada.

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

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame 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í	QueryConsumerGroupList	La operación que desea ejecutar. Establezca el valor en QueryConsumerGroupList.
CurrentPage	Integer	Sí	1	Número de página que se devolverá. La numeración comienza en 1.
PageSize	Integer	No	2	Número de entradas por página. Valores válidos: de 1 a 1000.
IotInstanceId	String	No	iot-cn-0pp1n8t****	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 ID, configure este parámetro; de lo contrario, la llamada fallará. Si su instancia no tiene página Overview o ID, omita este parámetro. Para obtener más información, consulte Descripción general.
Fuzzy	Boolean	No	false	Indica si se realizará una búsqueda aproximada. Valores válidos: true: realiza una búsqueda aproximada. Especifique el parámetro GroupName. false: consulta todos los grupos de consumidores de la cuenta actual. Valor predeterminado: false.
GroupName	String	No	Grupos de consumidores de tipo A	Nombre del grupo de consumidores que se consultará. Este parámetro es obligatorio si Fuzzy se establece en true.

Además de los parámetros 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	Código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
CurrentPage	Integer	1	Número de página devuelta.
Data	Array of ConsumerGroupDTO		Detalles del grupo de consumidores. Se devuelve si la llamada es exitosa. Para obtener más información, consulte ConsumerGroupDTO.
ConsumerGroupDTO
CreateTime	String	2020-05-20T00:05:20.000Z	Hora de creación del grupo de consumidores. Sigue el estándar ISO 8601 con formato yyyy-MM-ddTHH:mm:ss.SSSZ, en UTC y con precisión de milisegundos.
GroupId	String	nJRaJPn5U1JITGf******	ID del grupo de consumidores.
GroupName	String	Grupo de consumidores 1	Nombre del grupo de consumidores.
ErrorMessage	String	Ocurrió una excepción del sistema.	Mensaje de error devuelto si la llamada falla.
PageCount	Integer	4	Número total de páginas devueltas.
PageSize	Integer	2	Número de entradas devueltas por página.
RequestId	String	73B9DF43-7780-47DE-8BED-077729D28BD2	ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.
Total	Integer	8	Número total de entradas.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryConsumerGroupList
&CurrentPage=1
&PageSize=2
&Fuzzy=true
&GroupName=Consumer groups of the A type
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<QueryConsumerGroupListResponse>
    <PageSize>2</PageSize>
    <PageCount>4</PageCount>
    <CurrentPage>1</CurrentPage>
    <Total>8</Total>
    <Data>
        <ConsumerGroupDTO>
            <GroupId>nJRaJPn5U1JITGf******</GroupId>
            <GroupName>Consumer Group 1</GroupName>
            <CreateTime>2020-05-29T03:37:56.000Z</CreateTime>
        </ConsumerGroupDTO>
        <ConsumerGroupDTO>
            <GroupId>qJRaJPndeefwgef******</GroupId>
            <GroupName>Consumer Group 2</GroupName>
            <CreateTime>2020-01-17T07:27:01.000Z</CreateTime>
        </ConsumerGroupDTO>
    </Data>
    <RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
    <Success>true</Success>
</QueryConsumerGroupListResponse>

Formato JSON

{
    "PageSize": 2,
    "PageCount": 4,
    "CurrentPage": 1,
    "Total": 8,
    "Data": {
        "ConsumerGroupDTO": [
            {
                "GroupId": "nJRaJPn5U1JITGf******",
                "GroupName": "Consumer Group 1",
                "CreateTime": "2020-05-29T03:37:56.000Z"
            },
            {
                "GroupId": "qJRaJPndeefwgef******",
                "GroupName": "Consumer Group 2",
                "CreateTime": "2020-01-17T07:27:01.000Z"
            }
        ]
    },
  "RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
  "Success": true
}

Códigos de error

Para consultar la lista de códigos de error, visite el Centro de errores de API.