FOformancehq
Indexes

Get aggregated index registry status

Changed on

Returns the aggregated index registry status: per-index backfill cursor, per-replica IndexVersionState (current/pending), and cluster-wide counters (LastIndexedSequence, LastLogSequence, Lag, IndexFileSize). The optional ledger query parameter narrows the per-index entries to a single ledger; the aggregated counters always cover the bucket. Requires ledger:ReadOps scope.

get/v3/_/indexes/status

Request

  • Base URL
    http://localhost:9000
  • URL
    http://localhost:9000/v3/_/indexes/status
  • Auth
    • HTTP bearer
    • or none

Query parameters

ledgerstring

Headers

X-Consistency'linearizable' | 'stale'

Read consistency. linearizable (the default) runs a Raft ReadIndex barrier and waits for the receiving node to apply up to it. stale serves the read from the receiving node's own store, with no barrier and no forwarding to the leader, so the answer may lag the leader. Matching ignores case and surrounding whitespace. An unknown value, or a repeated or comma-joined header, returns 400 INVALID_REQUEST on every /v3 route, writes included; a valid value has no effect on writes. The gRPC equivalent is the x-consistency request metadata.

Response

Index status retrieved successfully.

dataobject required

GetIndexStatusResponse (protobuf JSON representation)

Changes

  • f5e817eca038Revision changes
    • info

      api operation id getIndexStatus removed and replaced with v3GetIndexStatus

  • 3da23d327316Revision changes
    • info

      added the media type text/plain for the response with the status

    • info

      added the media type text/plain for the response with the status