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 mensajes

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

Ver PDF

Consulta de mensajes

Función

Esta API se utiliza para consultar el offset y el contenido de un mensaje. Esta API consulta el offset del mensaje basado en la marca de tiempo y, a continuación, consulta el contenido del mensaje basado en el offset.

URI

GET /v2/{project_id}/instances/{instance_id}/messages

**Tabla 1** Parámetros de ruta
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	ID del proyecto del tenant.
instance_id	Sí	String	ID de la instancia

**Tabla 2** Parámetros de consulta
Parámetro	Obligatorio	Tipo	Descripción
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.
asc	No	Boolean	Si desea ordenar los mensajes por tiempo.
start_time	No	String	Hora de inicio. El valor es una marca de tiempo Unix, en milisegundos. Este parámetro es obligatorio cuando se consulta el offset del mensaje.
end_time	No	String	Hora de fin. El valor es una marca de tiempo Unix, en milisegundos. Este parámetro es obligatorio cuando se consulta el offset del mensaje.
limit	No	String	Tamaño de página. El valor varía de 0 a 50.
offset	No	String	Offset, que es la posición en la que comienza la consulta. El valor debe ser superior o igual a 0.
download	No	Boolean	Si se requiere descarga.
message_offset	No	String	Offset de mensaje. Este parámetro es obligatorio cuando consulta el contenido del mensaje. Si start_time y end_time no están vacíos, este parámetro no es válido.
partition	No	String	Partición. Este parámetro es obligatorio cuando consulta el contenido del mensaje. Si start_time y end_time no están vacíos, este parámetro no es válido.

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 MessagesEntity objects	Lista de mensajes.
total	Long	Cantidad total de mensajes
size	Long	Número de mensajes.

**Tabla 4** MessagesEntity
Parámetro	Tipo	Descripción
topic	String	Nombre del tema
partition	Integer	Partición donde se encuentra el mensaje.
key	String	Clave de mensaje
value	String	Contenido del mensaje
size	Integer	Tamaño del mensaje.
timestamp	Long	Nombre del tema
huge_message	Boolean	Bandera de datos grandes.
message_offset	Integer	Offset de mensaje.
message_id	String	ID del mensaje.
app_id	String	ID de aplicación.
tag	String	Etiqueta de mensaje.

Código de estado: 400

**Tabla 5** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
error_code	String	Código de error.
error_msg	String	Descripción de error.

Código de estado: 403

**Tabla 6** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
error_code	String	Código de error.
error_msg	String	Descripción de error.

Ejemplo de las solicitudes

Consultar el offset del mensaje.

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/messages?asc=false&end_time=1608609032042&limit=10&offset=0&start_time=1608608432042&topic=topic-test

Consultar el contenido del mensaje.

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/messages?download=false&message_offset=0&partition=0&topic=topic-test

Ejemplo de las respuestas

Código de estado: 200

La consulta se realiza correctamente.

{
  "messages" : [ {
    "topic" : "topic-test",
    "partition" : 0,
    "value" : "hello world",
    "size" : 21,
    "timestamp" : 1607598463502,
    "huge_message" : false,
    "message_offset" : 4,
    "message_id" : "",
    "app_id" : "",
    "tag" : ""
  } ],
  "total" : 1,
  "size" : 1
}