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

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 no sistema.

Você pode chamar esta operação para consultar as estatísticas de mensagens publicadas em um tópico específico em um ambiente de produção. Você pode consultar o número de mensagens publicadas no tópico ou as transações por segundo (TPS) para publicação de mensagens dentro de um intervalo de tempo especificado, com base nos requisitos do seu negócio.

Se a sua aplicação publicar um pequeno número de mensagens e não publicar mensagens em intervalos específicos, recomendamos que você consulte o número de mensagens publicadas no tópico durante cada período de amostragem, pois as estatísticas de TPS podem não mostrar uma tendência de mudança clara.

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

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
Topic	string	Sim	O nome do tópico que você deseja consultar.	test
BeginTime	integer	Sim	O timestamp que indica o início do intervalo de tempo a ser consultado. Unidade: milissegundos.	1570852800000
EndTime	integer	Sim	O timestamp que indica o fim do intervalo de tempo a ser consultado. Unidade: milissegundos.	1570868400000
Type	integer	Sim	O tipo de informação que você deseja consultar. Valores válidos: 0: o número de mensagens publicadas no tópico durante cada período de amostragem. 1: o TPS para publicação de mensagens no tópico durante cada período de amostragem.	0
InstanceId	string	Não	O ID da instância à qual o tópico que você deseja consultar pertence.	MQ_INST_111111111111_DOxxxxxx
Period	integer	Não	O período de amostragem. Unidade: minutos. Valores válidos: 1, 5 e 10.	10

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 o ID para solucionar problemas.	E213AD8A-0730-4B3D-A35A-340DA47D****
Data	object	Os dados retornados.
Records	object
StatsDataDo	array<object>	The data set returned based on sampling period.
	object
Y	number	The Y axis. This parameter indicates the TPS for message publishing or the number of messages that are published.	0
X	integer	The X axis. The value of this parameter is a UNIX timestamp in milliseconds.	1570852800000
XUnit	string	A unidade do timestamp.	ms
YUnit	string	A unidade do eixo Y.	msg
Title	string	O nome da tabela.	TopicXXX Send Trend Chart

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "E213AD8A-0730-4B3D-A35A-340DA47D****",
  "Data": {
    "Records": {
      "StatsDataDo": [
        {
          "Y": 0,
          "X": 1570852800000
        }
      ]
    },
    "XUnit": "ms",
    "YUnit": "msg",
    "Title": "TopicXXX  Send Trend Chart"
  }
}

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.