STstrimzi
Consumers

GET /consumers/{groupid}/instances/{name}/records

Changed on

Retrieves records for a subscribed consumer, including message values, topics, and partitions. The request for this operation MUST use the base URL (including the host and port) returned in the response from the POST request to /consumers/{groupid} that was used to create this consumer.

Request

  • The document declares no server URL.
  • Auth
    none declared

Response

Poll request executed successfully.

topicstring

Topic name from which the record was consumed.

partitioninteger

Partition number from which the record was consumed.

offsetinteger

Offset of the record in the partition.

timestampinteger

The record timestamp, in milliseconds since the Unix epoch.

Example response

[
  {
    "topic": "topic",
    "key": "key1",
    "value": "value1",
    "partition": 0,
    "offset": 2,
    "timestamp": 1591897790000
  },
  {
    "topic": "topic",
    "key": "key2",
    "value": "value2",
    "partition": 1,
    "offset": 3,
    "timestamp": 1591897790000
  }
]

Changes

  • b8205c8ab4cbRevision changes
    • breaking

      added subschema #1 subschema #2 subschema #3 to the / response property oneOf list for the response status (media type: application/vnd.kafka.json.v2+json)

    • breaking

      added subschema #1 subschema #2 subschema #3 to the / response property oneOf list for the response status (media type: application/vnd.kafka.binary.v2+json)

    • breaking

      added subschema #1 subschema #2 subschema #3 to the / response property oneOf list for the response status (media type: application/vnd.kafka.text.v2+json)

    • breaking

      added subschema #1 subschema #2 subschema #3 to the / response property oneOf list for the response status (media type: application/vnd.kafka.v2+json)

    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 to the / response property oneOf list for the response status (media type: application/vnd.kafka.json.v2+json)

    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 to the / response property oneOf list for the response status (media type: application/vnd.kafka.binary.v2+json)

    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 to the / response property oneOf list for the response status (media type: application/vnd.kafka.text.v2+json)

    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 to the / response property oneOf list for the response status (media type: application/vnd.kafka.v2+json)

    • info

      removed subschema #1 subschema #2 subschema #3 from the / response property oneOf list for the response status (media type: application/vnd.kafka.json.v2+json)

    • info

      removed subschema #1 subschema #2 subschema #3 from the / response property oneOf list for the response status (media type: application/vnd.kafka.binary.v2+json)

    • info

      removed subschema #1 subschema #2 subschema #3 from the / response property oneOf list for the response status (media type: application/vnd.kafka.text.v2+json)

    • info

      removed subschema #1 subschema #2 subschema #3 from the / response property oneOf list for the response status (media type: application/vnd.kafka.v2+json)

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the / response property oneOf list for the response status (media type: application/vnd.kafka.json.v2+json)

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the / response property oneOf list for the response status (media type: application/vnd.kafka.binary.v2+json)

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the / response property oneOf list for the response status (media type: application/vnd.kafka.text.v2+json)

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the / response property oneOf list for the response status (media type: application/vnd.kafka.v2+json)

  • 426d9b9215e9Revision changes
    • breaking

      response property items/value list-of-types was widened by adding types null to media type application/vnd.kafka.binary.v2+json of response 200

    • breaking

      response property items/value list-of-types was widened by adding types null to media type application/vnd.kafka.json.v2+json of response 200

    • breaking

      response property items/value list-of-types was widened by adding types null to media type application/vnd.kafka.text.v2+json of response 200

    • breaking

      response property items/value list-of-types was widened by adding types null to media type application/vnd.kafka.v2+json of response 200

    • info

      added the optional property to the response with the status (media type: application/vnd.kafka.json.v2+json)

    • info

      added the optional property to the response with the status (media type: application/vnd.kafka.binary.v2+json)

    • info

      added the optional property to the response with the status (media type: application/vnd.kafka.text.v2+json)

    • info

      added the optional property to the response with the status (media type: application/vnd.kafka.v2+json)

    • info

      added the optional property to the response with the status (media type: application/vnd.kafka.json.v2+json)

    • info

      added the optional property to the response with the status (media type: application/vnd.kafka.binary.v2+json)

    • info

      added the optional property to the response with the status (media type: application/vnd.kafka.text.v2+json)

    • info

      added the optional property to the response with the status (media type: application/vnd.kafka.v2+json)

    • info

      added the optional property to the response with the status (media type: application/vnd.kafka.json.v2+json)

    • info

      added the optional property to the response with the status (media type: application/vnd.kafka.binary.v2+json)

    • info

      added the optional property to the response with the status (media type: application/vnd.kafka.text.v2+json)

    • info

      added the optional property to the response with the status (media type: application/vnd.kafka.v2+json)