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

Consulta os dados de status detalhados de um ID de grupo especificado, incluindo verificação de consistência de assinatura, estatísticas de TPS de consumo, status de balanceamento de carga e conexões de consumidor.

Descrição da operação

Importante As operações OpenAPI fornecidas pelo Alibaba Cloud são operações de API de gerenciamento e controle usadas para gerenciar e consultar recursos dos serviços do Alibaba Cloud. Recomendamos que você integre essas operações de API apenas em links de gerenciamento e controle. Não dependa de operações 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 solucionar as causas de exceções de consumo após uma verificação rápida do acúmulo de mensagens e do status online do cliente. Com base nos resultados retornados, você pode determinar se as relações de assinatura do ID de grupo especificado são consistentes, se o balanceamento de carga está normal e obter as informações Jstack dos clientes online.
Esta operação chama um grande número de operações de API de back-end para agregar dados. Portanto, a velocidade de consulta é lenta. Não chame esta operação com frequência.

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

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 de consumidores a ser consultado.	GID_test_group_id
Detail	boolean	Não	Especifica se devem ser consultadas informações detalhadas. Valores válidos: true: Consulta informações detalhadas. Você pode obter os parâmetros de resposta ConsumerConnectionInfoList e DetailInTopicList. false: Não consulta informações detalhadas. Este é o valor padrão. Os parâmetros de resposta ConsumerConnectionInfoList e DetailInTopicList estão vazios.	true
NeedJstack	boolean	Não	Especifica se as informações Jstack devem ser impressas. Valores válidos: true: Imprime as informações Jstack. Você pode obter as informações de pilha do parâmetro de resposta Jstack. Nota Para imprimir as informações Jstack, certifique-se de que o parâmetro de solicitação Detail esteja definido como true. false: Não imprime as informações Jstack. Este é o valor padrão. O parâmetro de resposta Jstack está vazio.	true
InstanceId	string	Não	O ID da instância correspondente ao ID do grupo a ser consultado.	MQ_INST_111111111111_DOxxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O parâmetro comum. O ID de cada solicitação é único e pode ser usado para solucionar e localizar problemas.	10EDC518-10E7-4B34-92FB-171235FA****
Data	object	Os resultados da consulta.
ConsumeTps	number	O TPS total de consumo.	0
ConsumeModel	string	O modelo de consumo. Valores válidos: CLUSTERING: modo de consumo por clustering. BROADCASTING: modo de consumo por broadcasting. Para obter mais informações sobre os dois modos de assinatura, consulte Consumo por clustering e consumo por broadcasting.	CLUSTERING
ConnectionSet	object
ConnectionDo	array<object>	As informações sobre os clientes online no cluster.
	object
RemoteIP	string	O endereço IP do host ou o endereço IP público.	42.120.74.**
Version	string	A versão do consumidor.	V4_3_6_SNAPSHOT
ClientAddr	string	O endereço IP e a porta da instância do consumidor.	30.5.121.**
Language	string	A linguagem do consumidor.	JAVA
ClientId	string	O ID da instância do consumidor.	30.5.121.**@25560#-1999745829#-1737591554#458773089270275
Diff	integer	O número de mensagens acumuladas por cliente.	100
TotalDiff	integer	O acúmulo total de mensagens no cluster.	197
ConsumerConnectionInfoList	object
ConsumerConnectionInfoDo	array<object>	As informações detalhadas sobre os clientes online no cluster, incluindo Jstack e tempo de resposta de consumo (RT). Para obter as informações detalhadas, certifique-se de que o parâmetro de solicitação Detail esteja definido como true. Caso contrário, o valor retornado estará vazio.
	array<object>	O conteúdo de teste. Este conteúdo não é enviado para o ICMS.
ConsumeModel	string	O modelo de consumo. Valores válidos: CLUSTERING: modo de consumo por clustering. BROADCASTING: modo de consumo por broadcasting. Para obter mais informações sobre os dois modos de assinatura, consulte Consumo por clustering e consumo por broadcasting.	CLUSTERING
RunningDataList	object
ConsumerRunningDataDo	array<object>	As estatísticas de status em tempo real.
	object
Rt	number	O RT de consumo. Unidade: milissegundos.	0
Topic	string	O nome do tópico assinado.	test-mq_topic
FailedCountPerHour	integer	O número de mensagens que falharam ao serem consumidas por hora.	0
OkTps	number	O TPS de mensagens consumidas com sucesso.	0
FailedTps	number	O TPS de mensagens que falharam ao serem consumidas.	0
SubscriptionSet	object
SubscriptionData	array<object>	O conjunto de relações de assinatura.
	array<object>
SubString	string	A expressão de tag para a subcategoria do tópico assinado.	*
SubVersion	integer	O número da versão da relação de assinatura. O valor é um inteiro longo de incremento automático.	1570701364301
Topic	string	O nome do tópico assinado.	test-mq_topic
TagsSet	object
Tag	array	O conjunto de tags assinadas.
	string	O conjunto de tags assinadas.	ff
Jstack	object
ThreadTrackDo	array<object>	As informações Jstack. Para obter as informações Jstack, certifique-se de que o parâmetro de solicitação NeedJstack esteja definido como true. Caso contrário, o valor retornado estará vazio.
	array<object>	O conteúdo de teste. Este conteúdo não é publicado no ICMS.
TrackList	object
Track	array	A string de informações Jstack.
	string	A string de informações Jstack.	TID: 52 STATE: WAITING
Thread	string	O nome do thread.	ConsumeMessageThread_0
LastTimeStamp	integer	A hora do último consumo. O valor é um carimbo de data/hora UNIX em milissegundos.	1570701368114
StartTimeStamp	integer	A hora de início do consumo. O valor é um carimbo de data/hora UNIX em milissegundos.	1570701361528
Language	string	A linguagem do cliente.	JAVA
ClientId	string	O ID da instância do consumidor.	30.5..@25560#-1999745829#-1737591554#458773089270275
Connection	string	As informações de conexão.	**
Version	string	A versão do cliente.	V4_3_6
ConsumeType	string	O modo de consumo de mensagens do consumidor. Valores válidos: PUSH: O servidor ApsaraMQ for RocketMQ envia mensagens para o consumidor. PULL: O consumidor extrai mensagens do servidor ApsaraMQ for RocketMQ.	PUSH
ThreadCount	integer	O número de threads de consumo.	20
InstanceId	string	O ID da instância.	MQ_INST_111111111111_DOxxxxxx
DetailInTopicList	object
DetailInTopicDo	array<object>	O status de consumo de cada tópico. Para obter as informações detalhadas, certifique-se de que o parâmetro de solicitação Detail esteja definido como true. Caso contrário, o valor retornado estará vazio.
	object
DelayTime	integer	O tempo de atraso de consumo do tópico especificado. Unidade: milissegundos.	0
TotalDiff	integer	O número total de mensagens acumuladas para o tópico.	0
LastTimestamp	integer	A hora do último consumo. O valor é um carimbo de data/hora UNIX em milissegundos.	1570701259403
Topic	string	O nome do tópico.	test-mq_topic
SubscriptionSame	boolean	Indica se as relações de assinatura são consistentes.	true
DelayTime	integer	O tempo máximo de atraso de consumo entre todos os tópicos assinados pelo ID de grupo especificado. Unidade: milissegundos.	100857
LastTimestamp	integer	A hora do último consumo. O valor é um carimbo de data/hora UNIX em milissegundos.	1566883844954
Online	boolean	Indica se o cliente está online.	true
RebalanceOK	boolean	Indica se o rebalanceamento do cliente está normal. Valores válidos: true: Normal. false: Anormal.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "10EDC518-10E7-4B34-92FB-171235FA****",
  "Data": {
    "ConsumeTps": 0,
    "ConsumeModel": "CLUSTERING",
    "ConnectionSet": {
      "ConnectionDo": [
        {
          "RemoteIP": "42.120.74.**",
          "Version": "V4_3_6_SNAPSHOT",
          "ClientAddr": "30.5.121.**",
          "Language": "JAVA",
          "ClientId": "30.5.121.**@25560#-1999745829#-1737591554#458773089270275",
          "Diff": 100
        }
      ]
    },
    "TotalDiff": 197,
    "ConsumerConnectionInfoList": {
      "ConsumerConnectionInfoDo": [
        {
          "ConsumeModel": "CLUSTERING",
          "RunningDataList": {
            "ConsumerRunningDataDo": [
              {
                "Rt": 0,
                "Topic": "test-mq_topic",
                "FailedCountPerHour": 0,
                "OkTps": 0,
                "FailedTps": 0
              }
            ]
          },
          "SubscriptionSet": {
            "SubscriptionData": [
              {
                "SubString": "*",
                "SubVersion": 1570701364301,
                "Topic": "test-mq_topic",
                "TagsSet": {
                  "Tag": [
                    "ff"
                  ]
                }
              }
            ]
          },
          "Jstack": {
            "ThreadTrackDo": [
              {
                "TrackList": {
                  "Track": [
                    "TID: 52 STATE: WAITING"
                  ]
                },
                "Thread": "ConsumeMessageThread_0"
              }
            ]
          },
          "LastTimeStamp": 1570701368114,
          "StartTimeStamp": 1570701361528,
          "Language": "JAVA",
          "ClientId": "30.5.**.**@25560#-1999745829#-1737591554#458773089270275",
          "Connection": "**",
          "Version": "V4_3_6",
          "ConsumeType": "PUSH",
          "ThreadCount": 20
        }
      ]
    },
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
    "DetailInTopicList": {
      "DetailInTopicDo": [
        {
          "DelayTime": 0,
          "TotalDiff": 0,
          "LastTimestamp": 1570701259403,
          "Topic": "test-mq_topic"
        }
      ]
    },
    "SubscriptionSame": true,
    "DelayTime": 100857,
    "LastTimestamp": 1566883844954,
    "Online": true,
    "RebalanceOK": true
  }
}

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.