ShowMessages
Função
Essa API é usada para consultar uma mensagem com um período de tempo especificado.
URI
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/messages
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto. |
instance_id |
Sim |
String |
ID da instância. |
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. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
start_time |
Não |
String |
Hora de início da consulta como um carimbo de data/hora Unix. Valor padrão: 0. |
end_time |
Não |
String |
Hora final da consulta, como um carimbo de data/hora Unix. Valor padrão: hora atual do sistema. |
limit |
Não |
Integer |
Número de mensagens retornadas em uma página. Valor padrão: 10. |
offset |
Não |
Integer |
Deslocamento, que é a posição onde a consulta começa. O valor deve ser superior ou igual a 0. |
partition |
Não |
String |
Número da partição. O valor padrão é -1, indicando que todas as partições são consultadas. |
Parâmetros de solicitação
Nenhum
Parâmetros de resposta
Código de estado: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
messages |
Array of messages objects |
Lista de mensagem. |
messages_count |
Integer |
Número total de mensagens. |
offsets_count |
Integer |
Número total de páginas. |
offset |
Integer |
Página atual. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
topic |
String |
Nome do tópico. |
partition |
Integer |
Número da partição. |
message_offset |
Integer |
Deslocamento da mensagem. |
size |
Integer |
Tamanho da mensagem em bytes. |
timestamp |
Long |
Hora em que uma mensagem é criada. O valor é um timestamp Unix. A unidade é milissegundo. |
Exemplos de solicitações
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}/messages
Exemplo de respostas
Código de estado: 200
A mensagem com o período de tempo especificado foi consultada com êxito.
{ "messages" : [ { "topic" : "mytest", "partition" : 0, "message_offset" : 7, "size" : 6, "timestamp" : 1568125036045 } ], "messages_count" : 1, "offsets_count" : 1, "offset" : 1 }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
A mensagem com o período de tempo especificado foi consultada com êxito. |
Códigos de erro
Consulte Códigos de erro.