OnsTopicSubDetail - ApsaraMQ for RocketMQ: Central de Documentação do Alibaba Cloud

Consulta os grupos de consumidores online que assinam um tópico especificado.

Descrição da operação

Nota

As operações de API fornecidas pela Alibaba Cloud são usadas para gerenciar e consultar recursos dos serviços da Alibaba Cloud. Recomendamos que você integre essas operações de API apenas em sistemas de gerenciamento. Não use essas operações de API no sistema principal dos serviços de mensagens. Caso contrário, podem ocorrer riscos ao sistema.

Você pode chamar esta operação para consultar os grupos de consumidores online que assinam um tópico especificado. Se todos os consumidores em um grupo estiverem offline, as informações sobre o grupo não serão retornadas.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

mq:QueryTopicSubDetail

get

Topic

acs:mq:{#regionId}:{#accountId}:{#TopicName}

Topic

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}

Nenhuma

mq:OnsInstanceBaseInfo

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância que contém o tópico que você deseja consultar.	MQ_INST_111111111111_DOxxxxxx
Topic	string	Sim	O nome do tópico que você deseja consultar.	test

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação. Este parâmetro é um parâmetro comum. Cada solicitação tem um ID exclusivo. Você pode usar este ID para solucionar problemas.	87B6207F-2908-42B5-A134-84956DCA****
Data	object	Os dados retornados.
SubscriptionDataList	object
SubscriptionDataList	array<object>	The information about the online consumer groups that subscribe to the topic.
	object
GroupId	string	The ID of the consumer group that subscribes to the topic.	GID_test
MessageModel	string	The consumption mode. Valid values: CLUSTERING: the clustering consumption mode BROADCASTING: the broadcasting consumption mode For more information about consumption modes, see Clustering consumption and broadcasting consumption.	CLUSTERING
SubString	string	The expression based on which consumers in the consumer group subscribe to the topic.	*
Online	string	Indicates whether the consumer group is online.	true
Topic	string	O nome do tópico.	test

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "87B6207F-2908-42B5-A134-84956DCA****",
  "Data": {
    "SubscriptionDataList": {
      "SubscriptionDataList": [
        {
          "GroupId": "GID_test",
          "MessageModel": "CLUSTERING",
          "SubString": "*",
          "Online": "true"
        }
      ]
    },
    "Topic": "test"
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.