Hanzo
OpenapiMq

Reads stored messages without a consumer: by sequence, by newest on a subject,…

Reads stored messages without a consumer: by sequence, by newest on a subject, or walking a subject forward from a sequence.

GET /v1/mq/stream/{name}/message

Addresshttps://api.hanzo.ai/v1/mq/stream/{name}/message
MethodGET
Operationget_mq_stream_by_name_message
AuthAuthorization: Bearer $HANZO_API_KEY

Reads stored messages without a consumer: by sequence, by newest on a subject, or walking a subject forward from a sequence.

Request

5 fields.

FieldInTypeRequiredDescription
namepathstringyesName is the stream name, from the path.
seqqueryintegerSeq reads the message at this sequence (with next_by_subject: the walk's start).
last_by_subjectquerystringLastBySubject reads the newest message on this org-relative subject.
next_by_subjectquerystringNextBySubject walks forward from seq collecting messages on this org-relative subject (wildcards supported).
limitqueryintegerLimit caps a next_by_subject walk (1–1000, default 100).

Response

StatusBodyMeaning
200readOutok

200 body — 9 fields.

FieldInTypeAlwaysDescription
messagesbodyDelivery[]Messages is what was read, stream-ordered.
messages[].databodystringData is the payload, base64-encoded.
messages[].headersbodyobjectHeaders are the message headers, when any were published.
messages[].headers.*bodystring[]
messages[].num_deliveredbodyintegerDelivered is how many times a consumer has been handed this message (pulls only).
messages[].num_pendingbodyintegerRemaining is how many messages follow this one for the consumer (pulls only).
messages[].sequencebodyintegerSequence is the message's stream sequence.
messages[].subjectbodystringSubject is the org-relative subject the message was stored under.
messages[].timestampbodystring (date-time)Timestamp is when the broker stored the message.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


MQ API · All Hanzo APIs · Interactive reference

How is this guide?

On this page