OnsTrendTopicInputTps - ApsaraMQ for RocketMQ - Centro de documentación de Alibaba Cloud

Descripción de la operación

Nota

Las operaciones de API proporcionadas por Alibaba Cloud se utilizan para administrar y consultar recursos de los servicios de Alibaba Cloud. Se recomienda integrar estas operaciones de API únicamente en sistemas de administración. No utilice estas operaciones de API en el sistema principal de los servicios de mensajería; de lo contrario, podrían producirse riesgos en el sistema.

Puede llamar a esta operación para consultar las estadísticas de los mensajes publicados en un tema específico en un entorno de producción. Según sus requisitos empresariales, puede consultar la cantidad de mensajes publicados en el tema o las transacciones por segundo (TPS) de publicación de mensajes dentro de un intervalo de tiempo especificado.

Si su aplicación publica una pequeña cantidad de mensajes y no lo hace a intervalos específicos, se recomienda consultar la cantidad de mensajes publicados en el tema durante cada período de muestreo, ya que es posible que las estadísticas de TPS no muestren una tendencia de cambio clara.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

mq:QueryTrendTopicInputTps

get

Topic

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

Topic

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

Ninguna

mq:OnsInstanceBaseInfo

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Topic	string	Sí	El nombre del tema que desea consultar.	test
BeginTime	integer	Sí	La marca de tiempo que indica el inicio del intervalo de tiempo a consultar. Unidad: milisegundos.	1570852800000
EndTime	integer	Sí	La marca de tiempo que indica el fin del intervalo de tiempo a consultar. Unidad: milisegundos.	1570868400000
Type	integer	Sí	El tipo de información que desea consultar. Valores válidos: 0: la cantidad de mensajes publicados en el tema durante cada período de muestreo. 1: las TPS de publicación de mensajes en el tema durante cada período de muestreo.	0
InstanceId	string	No	El ID de la instancia a la que pertenece el tema que desea consultar.	MQ_INST_111111111111_DOxxxxxx
Period	integer	No	El período de muestreo. Unidad: minutos. Valores válidos: 1, 5 y 10.	10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud. Este parámetro es un parámetro común. Cada solicitud tiene un ID único. Puede utilizar este ID para solucionar problemas.	E213AD8A-0730-4B3D-A35A-340DA47D****
Data	object	Los datos devueltos.
Records	object
StatsDataDo	array<object>	El conjunto de datos devuelto según el período de muestreo.
	object
Y	number	El eje Y. Este parámetro indica las TPS de publicación de mensajes o la cantidad de mensajes publicados.	0
X	integer	El eje X. El valor de este parámetro es una marca de tiempo UNIX en milisegundos.	1570852800000
XUnit	string	La unidad de la marca de tiempo.	ms
YUnit	string	La unidad del eje Y.	msg
Title	string	El nombre de la tabla.	Gráfico de tendencias de envío de TopicXXX

Ejemplos

Respuesta exitosa

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 error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.