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

Consulta por página todos los mensajes almacenados en un tema especificado dentro de un intervalo de tiempo determinado.

Descripción de la operación

Nota

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

Si no conoce el ID o la clave del mensaje que desea consultar, puede llamar a esta operación para consultar todos los mensajes almacenados en el tema dentro de un intervalo de tiempo especificado. Los resultados se muestran por página.
Se recomienda especificar un intervalo de tiempo corto para consultar mensajes. Si especifica un intervalo de tiempo largo, se devuelve una gran cantidad de mensajes. En este caso, no podrá encontrar el mensaje que desea consultar de manera eficiente. Puede seguir estos pasos para consultar mensajes:
1. Realice una consulta paginada especificando el tema, la hora de inicio, la hora de fin y el número de entradas que se devolverán en cada página. Si el tema contiene mensajes, se devuelve de forma predeterminada la información sobre los mensajes de la primera página, el número total de páginas y el ID de la tarea.
2. Especifique el ID de la tarea y un número de página para volver a llamar a esta operación y consultar los mensajes de la página especificada. Los parámetros BeginTime, EndTime y PageSize no surten efecto. De forma predeterminada, el sistema utiliza los valores de estos parámetros que usted especificó en la solicitud cuando creó la tarea de consulta indicada.

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

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 cuyos mensajes desea consultar.	test-mq_topic
BeginTime	integer	Sí	El inicio del intervalo de tiempo de la consulta. El valor de este parámetro es una marca de tiempo UNIX en milisegundos. Si especifica un valor válido para el parámetro TaskId en la solicitud, este parámetro no surte efecto. El sistema utiliza el valor del parámetro BeginTime que usted especificó en la solicitud cuando creó la tarea de consulta indicada.	1570723200000
EndTime	integer	Sí	El fin del intervalo de tiempo de la consulta. El valor de este parámetro es una marca de tiempo UNIX en milisegundos. Si especifica un valor válido para el parámetro TaskId en la solicitud, este parámetro no surte efecto. El sistema utiliza el valor del parámetro EndTime que usted especificó en la solicitud cuando creó la tarea de consulta indicada.	1570809600000
TaskId	string	No	El ID de la tarea de consulta. La primera vez que llama a esta operación para consultar la información sobre mensajes en un tema especificado dentro de un intervalo de tiempo determinado, este parámetro no es obligatorio. Este parámetro es necesario en consultas posteriores para obtener mensajes de una página específica. Puede obtener el ID de la tarea del resultado devuelto en la primera consulta.	0BC1310300002A9F000021E4D7A48346
CurrentPage	integer	Sí	El número de la página que se va a devolver. Las páginas comienzan desde la página 1. Valores válidos: de 1 a 50.	2
PageSize	integer	No	El número de entradas que se devolverán en cada página. Valores válidos: de 5 a 50. Valor predeterminado: 20. Si especifica un valor válido para el parámetro TaskId en la solicitud, este parámetro no surte efecto. El sistema utiliza el valor del parámetro PageSize que usted especificó en la solicitud para crear la tarea de consulta.	5
InstanceId	string	No	El ID de la instancia a la que pertenece el mensaje que desea consultar.	MQ_INST_111111111111_DOxxxxxx

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos devueltos.
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.	5DC2A47E-2B31-4722-96C8-FA59C9*****
MsgFoundDo	object	La información sobre el mensaje consultado.
CurrentPage	integer	El número de la página devuelta.	1
MsgFoundList	object
OnsRestMessageDo	array<object>	La información sobre los mensajes en la página devuelta. La información contenida en este parámetro es la misma que la devuelta por la operación OnsMessageGetByMsgId.
	array<object>
StoreSize	integer	El tamaño del mensaje. Unidad: KB.	406
ReconsumeTimes	integer	El número de reintentos realizados para enviar el mensaje a los consumidores.	1
StoreTimestamp	integer	La hora en que el broker de ApsaraMQ for RocketMQ almacenó el mensaje. El valor es una marca de tiempo UNIX que representa el número de milisegundos transcurridos desde la época (1 de enero de 1970, 00:00:00 UTC).	1570760999811
InstanceId	string	El ID de la instancia.	MQ_INST_111111111111_DOxxxxxx
MsgId	string	El ID del mensaje.	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	El broker de ApsaraMQ for RocketMQ que almacena el mensaje.	11.193.*.*:10911
Topic	string	El tema al que pertenece el mensaje.	test-mq_topic
PropertyList	object
MessageProperty	array<object>	Los atributos del mensaje.
	object
Value	string	El valor del atributo.	TagA
Name	string	El nombre del atributo. Valores válidos: TRACE_ON: indica si existe un rastro del mensaje. KEYS: indica la clave del mensaje. TAGS: indica la etiqueta del mensaje. INSTANCE_ID: indica el ID de la instancia que contiene el mensaje. Para obtener información sobre los términos utilizados en ApsaraMQ for RocketMQ, consulte Términos.	TAGS
BornTimestamp	integer	La hora en que se generó el mensaje. El valor es una marca de tiempo UNIX que representa el número de milisegundos transcurridos desde la época (1 de enero de 1970, 00:00:00 UTC).	1570760999721
BodyCRC	integer	El valor de verificación de redundancia cíclica (CRC) del cuerpo del mensaje.	914112295
BornHost	string	El cliente productor que generó el mensaje.	42.120.*.*:59270
MaxPageCount	integer	El número total de páginas devueltas.	400
TaskId	string	El ID de la tarea de consulta. La primera vez que llama a esta operación para consultar los mensajes enviados a un grupo de consumidores especificado dentro de un intervalo de tiempo determinado, se devuelve este parámetro. Puede utilizar el ID de la tarea para consultar los detalles de los mensajes en otras páginas devueltas.	0BC1310300002A9F000021E4D7A48346

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "5DC2A47E-2B31-4722-96C8-FA59C9*****",
  "MsgFoundDo": {
    "CurrentPage": 1,
    "MsgFoundList": {
      "OnsRestMessageDo": [
        {
          "StoreSize": 406,
          "ReconsumeTimes": 1,
          "StoreTimestamp": 1570760999811,
          "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
          "MsgId": "1E0578FE110F18B4AAC235C05F2*****",
          "StoreHost": "11.193.***.***:10911",
          "Topic": "test-mq_topic",
          "PropertyList": {
            "MessageProperty": [
              {
                "Value": "TagA",
                "Name": "TAGS"
              }
            ]
          },
          "BornTimestamp": 1570760999721,
          "BodyCRC": 914112295,
          "BornHost": "42.120.***.***:59270"
        }
      ]
    },
    "MaxPageCount": 400,
    "TaskId": "0BC1310300002A9F000021E4D7A48346"
  }
}

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.