Todos os produtos
Search
Central de documentação

IoT Platform:QueryConsumerGroupByGroupId

Última atualização: Jun 26, 2026

Consulta os detalhes de um grupo de consumidores pelo ID do grupo para assinaturas no lado do servidor AMQP.

Limites

Cada conta Alibaba Cloud tem limite de 5 QPS.

Nota

Usuários RAM compartilham a cota da conta.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Chame esta operação no OpenAPI Explorer para gerar códigos de exemplo para diferentes SDKs.

Parâmetros da solicitação

Parâmetro Tipo Obrigatório Exemplo Descrição
Action String Sim QueryConsumerGroupByGroupId

Operação a executar. Defina o valor como QueryConsumerGroupByGroupId.

GroupId String Sim nJRaJPn5U1JITGf******

ID do grupo de consumidores retornado pela operação CreateConsumerGroup. Também é possível chamar QueryConsumerGroupList para consultar pelo nome do grupo ou localizá-lo no console IoT Platform em Rules > Server-side Subscription > Consumer Groups.

IotInstanceId String Não iot-cn-0pp1n8t****

ID da instância, disponível na página Overview do console IoT Platform.

Importante
  • Obrigatório se a instância tiver um ID. Sem esse parâmetro, a chamada falha.
  • Não obrigatório se a instância não tiver página Overview ou ID.

Visão geral.

Esta operação também requer Parâmetros comuns de solicitação.

Parâmetros de resposta

Parâmetro Tipo Exemplo Descrição
Code String iot.system.SystemException

Código de erro em caso de falha. Códigos de erro.

Data Struct

Detalhes do grupo de consumidores. Retornado em caso de sucesso.

CreateTime String 2020-05-20T00:05:20.000Z

Hora de criação do grupo de consumidores em UTC. Formato: yyyy-MM-ddTHH:mm:ss.SSSZ (ISO 8601).

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 em caso de falha.

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: Falha na chamada.

Exemplos

Exemplos de solicitações

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryConsumerGroupByGroupId
&GroupId=nJRaJPn5U1JITGf******
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<QueryConsumerGroupByGroupIdResponse>
    <Data>
        <GroupId>nJRaJPn5U1JITGf******</GroupId>
        <GroupName>Consumer group 1</GroupName>
        <CreateTime>2019-11-12T11:19:13.000Z</CreateTime>
    </Data>
    <RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
    <Success>true</Success>
</QueryConsumerGroupByGroupIdResponse>

Formato JSON

{
  "Data": {
        "GroupId": "nJRaJPn5U1JITGf******",
        "GroupName": "Consumer Group 1",
        "CreateTime": "2019-11-12T11:19:13.000Z"
    },
  "RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
  "Success": true
}

Códigos de erro

Para obter mais códigos de erro, visite a Central de Erros de API.