Get cloud storage status for a partition

GET /v1/cloud_storage/status/{topic}/{partition}

Get cloud storage status for a partition.

Path parameters

  • topic string Required
  • partition integer Required

Responses

  • 200 application/json

    Partition cloud storage status response

    Hide response attributes Show response attributes object
    • cloud_storage_mode string

      The partition's cloud storage mode (disabled, write_only, read_only, full, or read_replica).

    • ms_since_last_manifest_upload integer

      Delta in milliseconds since the last upload of the partition's manifest

    • ms_since_last_segment_upload integer

      Delta in milliseconds since the last segment upload for the partition

    • ms_since_last_manifest_sync integer

      Delta in milliseconds since the last manifest sync. Only present for read replicas.

    • metadata_update_pending boolean

      If true, the remote metadata may not yet include all segments that have been uploaded

    • total_log_size_bytes integer

      Total size of the log for the partition (overlap between local and cloud log is excluded)

    • cloud_log_size_bytes integer

      Total size of the addressable cloud log for the partition

    • local_log_size_bytes integer

      Total size of the addressable local log for the partition

    • cloud_log_segment_count integer

      Number of segments in the local log

    • cloud_log_start_offset integer | null

      The first Kafka offset accessible from the cloud (inclusive)

    • cloud_log_last_offset integer | null

      The last Kafka offset accessible from the cloud (inclusive)

    • local_log_start_offset integer | null

      The first Kafka offset accessible locally (inclusive)

    • local_log_last_offset integer | null

      The last Kafka offset accessible locally (inclusive)

GET /v1/cloud_storage/status/{topic}/{partition}
curl \
 --request GET 'http://localhost:9644/v1/cloud_storage/status/{topic}/{partition}'
Response examples (200)
{
  "cloud_storage_mode": "string",
  "ms_since_last_manifest_upload": 42,
  "ms_since_last_segment_upload": 42,
  "ms_since_last_manifest_sync": 42,
  "metadata_update_pending": true,
  "total_log_size_bytes": 42,
  "cloud_log_size_bytes": 42,
  "local_log_size_bytes": 42,
  "cloud_log_segment_count": 42,
  "cloud_log_start_offset": 42,
  "cloud_log_last_offset": 42,
  "local_log_start_offset": 42,
  "local_log_last_offset": 42
}