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

Descrição da operação

Importante A OpenAPI do Alibaba Cloud é uma API de plano de controle usada para gerenciar e consultar recursos dos serviços do Alibaba Cloud. Você pode integrar a OpenAPI apenas no plano de controle. Não use a OpenAPI para o link de dados principal de envio e recebimento de mensagens, pois isso pode representar uma ameaça ao link.

Ao gerar relatórios de dados de consumo em um ambiente de produção, você pode usar esta operação para consultar as seguintes estatísticas para um group ID especificado durante um período de tempo:

Uma curva estatística do número total de mensagens consumidas.
Uma curva estatística de Transações Por Segundo (TPS) para consumo de mensagens.

Se sua aplicação possui um volume pequeno e irregular de mensagens, a consulta por TPS pode não retornar dados significativos. Nesse caso, você pode consultar o número total de mensagens consumidas.

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

get

Group

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

Group

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 a ser consultado.	GID_test
Topic	string	Sim	O nome do tópico a ser consultado.	test
BeginTime	integer	Sim	O início do intervalo de tempo a ser consultado. Este valor é um timestamp UNIX em milissegundos.	1570852800000
EndTime	integer	Sim	O fim do intervalo de tempo a ser consultado. Este valor é um timestamp UNIX em milissegundos.	1570868400000
Type	integer	Sim	O tipo de informação a ser consultada. Valores válidos: 0: A curva estatística do número total de mensagens consumidas. 1: A curva estatística do TPS para consumo de mensagens.	0
InstanceId	string	Não	O ID da instância à qual o grupo 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 é um parâmetro comum. Cada solicitação possui um ID exclusivo que você pode usar para solucionar problemas.	CE57AEDC-8FD2-43ED-8E3B-1F878077****
Data	object	Os dados retornados.
Records	object
StatsDataDo	array<object>	The data points.
	object
Y	number	The y-axis, which indicates the data value. The data can be the TPS or the total number of messages.	0
X	integer	The x-axis, which indicates the timestamp in milliseconds.	1570867800000
XUnit	string	A unidade do eixo x. O tempo é medido em ms.	ms
YUnit	string	A unidade do eixo y. O valor pode ser o número de mensagens consumidas (msg) ou o TPS para consumo de mensagens (msg/min).	msg
Title	string	O nome da tabela.	TopicXXX@GID_XXXReceive Trend Chart

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "CE57AEDC-8FD2-43ED-8E3B-1F878077****",
  "Data": {
    "Records": {
      "StatsDataDo": [
        {
          "Y": 0,
          "X": 1570867800000
        }
      ]
    },
    "XUnit": "ms",
    "YUnit": "msg",
    "Title": "TopicXXX@GID_XXXReceive 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.