Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda/ Distributed Message Service for Kafka/ Referência de API/ As API V2 (Recomendado)/ Consulta das mensagens/ ShowInstanceMessages

Atualizado em 2022-11-07 GMT+08:00

Ver PDF

ShowInstanceMessages

Função

Essa API é usada para consultar o offset e o conteúdo de uma mensagem. Essa API consulta o offset da mensagem com base no carimbo de data/hora e, em seguida, consulta o conteúdo da mensagem com base no offset.

URI

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

**Tabela 1** Parâmetros de caminho
Parâmetro	Obrigatório	Tipo	Descrição
project_id	Sim	String	ID do projeto do inquilino.
instance_id	Sim	String	ID da instância.

**Tabela 2** Parâmetros de consulta
Parâmetro	Obrigatório	Tipo	Descrição
topic	Sim	String	Nome do tópico. Um nome de tópico deve começar com uma letra e só pode conter letras, hífens (-) , sublinhados (_), e dígitos.
asc	Não	Boolean	Se classificar as mensagens por tempo.
start_time	Não	String	Hora de início. O valor é um timestamp Unix, em milissegundos. Esse parâmetro é obrigatório quando você consulta o offset da mensagem.
end_time	Não	String	Hora de fim. O valor é um timestamp Unix, em milissegundos. Esse parâmetro é obrigatório quando você consulta o offset da mensagem.
limit	Não	String	Tamanho da página. O valor varia de 0 a 50.
offset	Não	String	Deslocamento, que é a posição onde a consulta começa. O valor deve ser superior ou igual a 0.
download	Não	Boolean	Se o download é necessário.
message_offset	Não	String	Deslocamento da mensagem. This parameter is mandatory when you query the message content. Se start_time e end_time não estiverem vazios, este parâmetro é inválido.
partition	Não	String	Partições. This parameter is mandatory when you query the message content. Se start_time e end_time não estiverem vazios, este parâmetro é inválido.

Parâmetros de solicitação

Nenhum

Parâmetros de resposta

Código de estado: 200

**Tabela 3** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
messages	Array of MessagesEntity objects	Lista de mensagem.
total	Long	Número total de mensagens.
size	Long	Número de mensagens.

**Tabela 4** MessagesEntity
Parâmetro	Tipo	Descrição
topic	String	Nome do tópico.
partition	Integer	Partição onde a mensagem está localizada.
key	String	Chave de mensagem.
value	String	Conteúdo da mensagem.
size	Integer	Tamanho da mensagem.
timestamp	Long	Nome do tópico.
huge_message	Boolean	Bandeira de Big Data.
message_offset	Integer	Deslocamento da mensagem.
message_id	String	ID da mensagem.
app_id	String	ID do aplicativo.
tag	String	Rótulos de mensagem.

Código de estado: 400

**Tabela 5** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Descrição de erro.

Código de estado: 403

**Tabela 6** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Descrição de erro.

Exemplos de solicitações

Consulta do offset da mensagem.

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

Consulta do conteúdo da mensagem.

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

Exemplo de respostas

Código de estado: 200

A consulta foi bem-sucedida.

{ "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 }