QueryConsumerGroupList - IoT Platform: Central de Documentação do Alibaba Cloud

Consulta todos os grupos de consumidores da conta atual em assinaturas do lado do servidor AMQP. Também permite buscar grupos de consumidores por nome com correspondência parcial.

Limites

Cada conta Alibaba Cloud admite no máximo 5 consultas por segundo (QPS).

Nota

Usuários RAM de uma conta Alibaba Cloud compartilham a cota dessa conta.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parameter	Type	Required	Example	Description
Action	String	Yes	QueryConsumerGroupList	Operação a ser executada. Defina o valor como QueryConsumerGroupList.
CurrentPage	Integer	Yes	1	Número da página a retornar. A numeração começa em 1.
PageSize	Integer	No	2	Quantidade de entradas a retornar por página. Valores válidos: 1 a 1000.
IotInstanceId	String	No	iot-cn-0pp1n8t****	ID da instância. Visualize o ID da instância na página Overview do console IoT Platform. Importante Se a instância tiver um ID, configure este parâmetro. Caso contrário, a chamada falhará. Se a instância não tiver página Overview ou ID, não defina este parâmetro. Para mais informações, consulte Visão geral.
Fuzzy	Boolean	No	false	Define se a busca será por correspondência parcial. Valores válidos: true: realiza busca por correspondência parcial. Especifique o parâmetro GroupName. false: consulta todos os grupos de consumidores da conta atual. Valor padrão: false.
GroupName	String	No	Consumer groups of the A type	Nome do grupo de consumidores a consultar. Obrigatório quando Fuzzy for true.

Além dos parâmetros específicos desta operação, especifique os parâmetros comuns de solicitação. Para mais detalhes, consulte Parâmetros comuns de solicitação.

Parâmetros de resposta

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Código de erro retornado se a chamada falhar. Para mais informações, consulte Códigos de erro.
CurrentPage	Integer	1	Número da página retornada.
Data	Array of ConsumerGroupDTO		Detalhes do grupo de consumidores. Retornado apenas se a chamada for bem-sucedida. Para mais informações, consulte ConsumerGroupDTO.
ConsumerGroupDTO
CreateTime	String	2020-05-20T00:05:20.000Z	Horário de criação do grupo de consumidores. Segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ss.SSSZ, em UTC e com precisão de milissegundos.
GroupId	String	nJRaJPn5U1JITGf******	ID do grupo de consumidores.
GroupName	String	Consumer Group 1	Nome do grupo de consumidores.
ErrorMessage	String	A system exception occurred.	Mensagem de erro retornada se a chamada falhar.
PageCount	Integer	4	Total de páginas retornadas.
PageSize	Integer	2	Quantidade de entradas retornadas por página.
RequestId	String	73B9DF43-7780-47DE-8BED-077729D28BD2	ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. true: chamada bem-sucedida. false: chamada falhou.
Total	Integer	8	Total de entradas.

Exemplos

Exemplo de solicitação

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

Exemplo de resposta de sucesso

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 erro

Para obter uma lista de códigos de erro, visite o API Error Center.