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

Consulta mensajes de cola de mensajes muertos por página para un Group ID y un intervalo de tiempo especificados.

Descripción de la operación

Importante

La OpenAPI de Alibaba Cloud es una API de gestión. Puede utilizarla para administrar y consultar recursos de servicios de Alibaba Cloud. Integre esta API únicamente con fines de gestión. No utilice esta API para enlaces de datos principales que envían y reciben mensajes, ya que esto puede generar amenazas de seguridad.

La consulta de mensajes de cola de mensajes muertos por Group ID es una consulta por rangos paginada. Este método se aplica únicamente a escenarios en los que consulta mensajes sin especificar un ID de mensaje.
Cuando consulte mensajes de cola de mensajes muertos por Group ID, especifique un intervalo de tiempo lo más corto posible. Un intervalo de tiempo prolongado puede devolver demasiados mensajes y dificultar la identificación de problemas. El flujo de llamada es el siguiente:
1. Para la primera consulta paginada, especifique el Group ID, la hora de inicio, la hora de finalización y el número de mensajes por página. Si se encuentran mensajes, la API devuelve los mensajes de la primera página, el número total de páginas y un ID de tarea de consulta.
2. Utilice el ID de tarea de consulta devuelto para recuperar más páginas de mensajes. En las solicitudes posteriores, especifique el ID de tarea de consulta y el número de página. La hora de inicio, la hora de finalización y el número de mensajes por página en estas solicitudes se ignoran porque se utilizan los valores de la primera consulta.

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

get

Group

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

Group

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

Ninguna

mq:OnsInstanceBaseInfo

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
GroupId	string	Sí	El ID del grupo de consumidores que se va a consultar.	GID_test_group_id
BeginTime	integer	Sí	El inicio del intervalo de tiempo que se va a consultar. Este valor es una marca de tiempo UNIX en milisegundos. Si especifica `TaskId` para recuperar más páginas, este parámetro se ignora. Se utiliza la hora de inicio de la primera consulta.	1570723200000
EndTime	integer	Sí	El final del intervalo de tiempo que se va a consultar. Este valor es una marca de tiempo UNIX en milisegundos. Si especifica `TaskId` para recuperar más páginas, este parámetro se ignora. Se utiliza la hora de finalización de la primera consulta.	1570809600000
TaskId	string	No	El ID de la tarea de consulta. Omita este parámetro en la primera consulta. Para consultas posteriores, utilice el ID de tarea devuelto por la consulta anterior.	0BC1310300002A9F000021E4D7A48346
CurrentPage	integer	Sí	El número de página que se va a devolver. Las páginas comienzan desde 1. El valor puede ser de hasta 50 y no debe exceder el número total de páginas.	2
PageSize	integer	No	El número de mensajes que se van a devolver en cada página. Valor predeterminado: 20. Valor mínimo: 5. Valor máximo: 50. Si especifica `TaskId` para recuperar más páginas, este parámetro se ignora. Se utiliza el tamaño de página de la primera consulta.	5
InstanceId	string	No	El ID de la instancia que contiene el mensaje.	MQ_INST_111111111111_DOxxxxxx

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud. Cada solicitud tiene un ID único. Utilice este ID para solucionar problemas.	B00CD3C8-D81E-4A41-85E2-38F19252****
MsgFoundDo	object	El resultado de la consulta.
CurrentPage	integer	El número de página actual.	1
MsgFoundList	object
OnsRestMessageDo	array<object>	La lista de mensajes en la página actual. El tipo de datos es el mismo que el tipo de datos de la respuesta de la operación OnsDLQMessageGetById.
	array<object>
StoreSize	integer	El tamaño del mensaje en KB.	406
ReconsumeTimes	integer	El número de veces que se ha vuelto a consumir el mensaje.	1
StoreTimestamp	integer	La marca de tiempo UNIX que indica cuándo se almacenó el mensaje en el servidor.	1570760999811
InstanceId	string	El ID de la instancia.	MQ_INST_111111111111_DOxxxxxx
MsgId	string	El ID del mensaje.	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	El servidor que almacena el mensaje.	11.193.*.*:10911
Topic	string	El tema del mensaje.	test-mq_topic
PropertyList	object
MessageProperty	array<object>	Una lista de propiedades del mensaje.
	object
Value	string	El valor de la propiedad del mensaje.	TagA
Name	string	La propiedad del mensaje. Valores válidos: TRACE_ON: Indica si existe un rastro de mensaje. KEYS: La clave del mensaje. TAGS: La etiqueta del mensaje. INSTANCE_ID: El ID de la instancia que contiene el mensaje. Para obtener más información, consulte Términos.	TAGS
BornTimestamp	integer	La marca de tiempo UNIX que indica cuándo se produjo el mensaje.	1570760999721
BodyCRC	integer	El valor de verificación de redundancia cíclica (CRC) del cuerpo del mensaje.	914112295
BornHost	string	El productor que generó el mensaje.	42.120.*.*:59270
MaxPageCount	integer	El número total de páginas disponibles.	400
TaskId	string	El ID de la tarea de consulta. Este ID se devuelve en la primera consulta. Utilice este ID para recuperar las páginas siguientes.	0BC1310300002A9F000021E4D7A48346

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "B00CD3C8-D81E-4A41-85E2-38F19252****",
  "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.