Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ Distributed Message Service for Kafka/ Referencia de la API/ APIs V2 (Recomendado)/ Consulta de mensaje/ Consulta de un mensaje con un período de tiempo especificado

Actualización más reciente 2022-11-07 GMT+08:00

Ver PDF

Consulta de un mensaje con un período de tiempo especificado

Función

Esta API se utiliza para consultar un mensaje con un período de tiempo especificado.

URI

GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/messages

**Tabla 1** Parámetros de ruta
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	ID del proyecto.
instance_id	Sí	String	ID de la instancia
topic	Sí	String	Nombre del tema Un nombre de tema debe comenzar con una letra y solo puede contener letras, guiones (-), guiones bajos (_), y dígitos.

**Tabla 2** Parámetros de consulta
Parámetro	Obligatorio	Tipo	Descripción
start_time	No	String	La hora de inicio de la consulta como marca de tiempo de Unix. Valor predeterminado: 0
end_time	No	String	Hora de finalización de la consulta, como marca de tiempo de Unix. Valor predeterminado: hora actual del sistema.
limit	No	Integer	Número de mensajes devueltos en una página. Valor predeterminado: 10
offset	No	Integer	Offset, que es la posición en la que comienza la consulta. El valor debe ser superior o igual a 0.
partition	No	String	Número de partición. El valor predeterminado es -1, que indica que se consultan todas las particiones.

Parámetros de solicitud

No hay

Parámetros de respuesta

Código de estado: 200

**Tabla 3** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
messages	Array of messages objects	Lista de mensajes.
messages_count	Integer	Cantidad total de mensajes
offsets_count	Integer	Número total de páginas.
offset	Integer	Página actual.

**Tabla 4** messages
Parámetro	Tipo	Descripción
topic	String	Nombre del tema
partition	Integer	Número de partición.
message_offset	Integer	Offset de mensaje.
size	Integer	Tamaño del mensaje en bytes.
timestamp	Long	Hora en la que se crea un mensaje. El valor es una marca de tiempo de Unix. La unidad es milisegundo.

Ejemplo de las solicitudes

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}/messages

Ejemplo de las respuestas

Código de estado: 200

El mensaje con el período de tiempo especificado se consulta correctamente.

{
  "messages" : [ {
    "topic" : "mytest",
    "partition" : 0,
    "message_offset" : 7,
    "size" : 6,
    "timestamp" : 1568125036045
  } ],
  "messages_count" : 1,
  "offsets_count" : 1,
  "offset" : 1
}