Msgs

Stream Receive

Changed on

Receives messages from a topic using a consumer group.

Each consumer in the group reads from all partitions. Messages are locked by leases for the specified duration to prevent duplicate delivery within the same consumer group.

post/api/v1.msgs.stream.receive

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Request body

namespacestring nullable
topicstring required
consumer_groupstring required
batch_sizeinteger
lease_duration_msinteger
default_starting_position'earliest' | 'latest'
batch_wait_msinteger nullable

Maximum time (in milliseconds) to wait for messages before returning.

Example request

{
  "namespace": "some_namespace",
  "topic": "some_topic_name",
  "consumer_group": "some_consumer_group"
}

Response

Example response

{
  "msgs": [
    {
      "topic": "some_topic_name~0"
    }
  ]
}

Changes

  • a542ced3f593Revision changes
    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new invalid-input enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new operation-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • warning

      added the new server-error enum value to the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the invalid_input enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the operation_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

    • info

      removed the server_error enum value from the response property for the response status

  • b1d873e9a6e4Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status