Consumer Group (v3)

Get Consumer Group Lag Summary

Return the maximum and total lag of the consumers belonging to the specified consumer group.

get/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary

Response

The max and total consumer lag in a consumer group.

kindstring required

cluster_idstring required

consumer_group_idstring required

max_lag_consumer_idstring required

max_lag_instance_idstring nullable

max_lag_client_idstring required

max_lag_topic_namestring required

max_lag_partition_idinteger required

max_laginteger required

total_laginteger required

Changes

Changed in 12 of the 50 revisions of this API.1044

Aug 8, 2023v325e5259d172212See the full diff
- ▲
  removed the media type text/plain for the response with the status 400
  response-media-type-removed
- ○
  api operation id getKafkaV3ConsumerGroupLagSummary removed and replaced with getKafkaConsumerGroupLagSummary
  api-operation-id-removed
- ○
  added the non-success response with the status 403
  response-non-success-status-added
Aug 8, 2023v31be42847ed213See the full diff
- ○
  api operation id getKafkaConsumerGroupLagSummary removed and replaced with getKafkaV3ConsumerGroupLagSummary
  api-operation-id-removed
- ○
  added the media type text/plain for the response with the status 400
  response-media-type-added
- ○
  removed the non-success response with the status 403
  response-non-success-status-removed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 10, 2023v3bb1cdf42f05212See the full diff
- ▲
  removed the media type text/plain for the response with the status 400
  response-media-type-removed
- ○
  api operation id getKafkaV3ConsumerGroupLagSummary removed and replaced with getKafkaConsumerGroupLagSummary
  api-operation-id-removed
- ○
  added the non-success response with the status 403
  response-non-success-status-added
Mar 22, 2022v37500cc59fcff6See the full diff
- ○
  api operation id getKafkaV3ConsumerGroupLagSummary was added
  api-operation-id-added
- ○
  api tag Consumer Group (v3) added
  api-tag-added
- ○
  api tag Consumer Group removed
  api-tag-removed
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Mar 22, 2022v30b87d328c66426See the full diff
- ▲
  the allOf[subschema #2]/max_lag response's property type/format changed from integer/int64 to integer/ for status 200
  response-property-type-changed
- ▲
  the allOf[subschema #2]/total_lag response's property type/format changed from integer/int64 to integer/ for status 200
  response-property-type-changed
- ○
  api operation id getKafkaV3ConsumerGroupLagSummary removed and replaced with
  api-operation-id-removed
- ○
  api tag Consumer Group added
  api-tag-added
- ○
  api tag Consumer Group (v3) removed
  api-tag-removed
- ○
  removed the non-success response with the status 400
  response-non-success-status-removed
- ○
  removed the non-success response with the status 401
  response-non-success-status-removed
- ○
  removed the non-success response with the status 429
  response-non-success-status-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 18, 2022v3242a6e383b716See the full diff
- ○
  api operation id getKafkaV3ConsumerGroupLagSummary was added
  api-operation-id-added
- ○
  api tag Consumer Group (v3) added
  api-tag-added
- ○
  api tag Consumer Group removed
  api-tag-removed
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Jan 18, 2022v3fbdd72178c666See the full diff
- ○
  api operation id getKafkaV3ConsumerGroupLagSummary removed and replaced with
  api-operation-id-removed
- ○
  api tag Consumer Group added
  api-tag-added
- ○
  api tag Consumer Group (v3) removed
  api-tag-removed
- ○
  removed the non-success response with the status 400
  response-non-success-status-removed
- ○
  removed the non-success response with the status 401
  response-non-success-status-removed
- ○
  removed the non-success response with the status 429
  response-non-success-status-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 8, 2021v32d4f120a20793See the full diff
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Sep 1, 2021v3fc95920a3a263See the full diff
- ○
  api operation id getKafkaV3ConsumerGroupLagSummary was added
  api-operation-id-added
- ○
  api tag Consumer Group (v3) added
  api-tag-added
- ○
  api tag Consumer Group removed
  api-tag-removed
Jul 7, 2021v3031b7043e56a2See the full diff
- ▲
  the allOf[subschema #2]/max_lag response's property type/format changed from integer/int64 to integer/ for status 200
  response-property-type-changed
- ▲
  the allOf[subschema #2]/total_lag response's property type/format changed from integer/int64 to integer/ for status 200
  response-property-type-changed

Full history (12 revisions)