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

Descrição da operação

Importante As operações do OpenAPI do Alibaba Cloud são operações de API de gerenciamento usadas para gerenciar e consultar recursos dos serviços do Alibaba Cloud. Integre essas operações apenas em links de gerenciamento. Não dependa de operações do OpenAPI no link de dados principal para envio e recebimento de mensagens. Caso contrário, podem ocorrer riscos no link.

Esta operação é normalmente usada para obter as informações de conexão dos clientes sob um ID de grupo especificado quando ocorrem exceções de consumo. Você pode visualizar o status do consumidor para diagnosticar preliminarmente a causa.

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:QueryConsumerConnection

get

Grupo.

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

Grupo.

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

Nenhuma

mq:OnsInstanceBaseInfo

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
GroupId	string	Sim	O ID do grupo.	GID_test_consumer_id
InstanceId	string	Não	O ID da instância correspondente ao ID do grupo.	MQ_INST_111111111111_DOxxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação. Este é um parâmetro comum. Cada solicitação possui um ID exclusivo que pode ser usado para solucionar e localizar problemas.	DE4140C7-F42D-473D-A5FF-B1E31692****
Data	object	A estrutura de dados da resposta.
ConnectionList	object
ConnectionDo	array<object>	As informações de conexão do ID de grupo especificado.
	object
Version	string	A versão do cliente consumidor.	V4_3_6
ClientAddr	string	O endereço IP e a porta da instância consumidora.	30.5.121.**
Language	string	A linguagem de desenvolvimento da aplicação consumidora.	JAVA
ClientId	string	O ID da instância consumidora.	30.5.121.**@24813#-1999745829#-1737591554#453111174894656
MessageModel	string	O modo de consumo. Valores válidos:\n- CLUSTERING: consumo em cluster.\n- BROADCASTING: consumo por broadcast.	CLUSTERING

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "DE4140C7-F42D-473D-A5FF-B1E31692****",
  "Data": {
    "ConnectionList": {
      "ConnectionDo": [
        {
          "Version": "V4_3_6",
          "ClientAddr": "30.5.121.**",
          "Language": "JAVA",
          "ClientId": "30.5.121.**@24813#-1999745829#-1737591554#453111174894656"
        }
      ]
    },
    "MessageModel": "CLUSTERING"
  }
}

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.