OrdinateDB

Documentation

product Pre-releaseunwritten sections are marked
GET/v1/collectors

List collector connection diagnostics

operation ID: get_v1_collectors

Overview

List collector connection diagnostics. Collector and job operations expose ingestion diagnostics and managed storage work.

When to use it

  • Use it when an application needs to list collector connection diagnostics.
  • Use it when an operator is monitoring data ingestion or coordinating a storage-maintenance workflow.

Quick example

Set the base URL and replace generated identifiers or credentials with values from your installation.

cURL

curl --request GET \
  --url "$ORDINATE_URL/v1/collectors" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

Expected output · 200

Collector diagnostics

Example 200 output

[
  {
    "collector_id": "string",
    "session_epoch": 0,
    "streams": [
      "string"
    ],
    "last_batch_arrival_ns": 0,
    "last_collector_receipt_ns": 0,
    "watermark_ns": 0,
    "acked_through": 0,
    "credit_live": 0,
    "credit_backfill": 0,
    "fenced_streams_total": 0,
    "last_fenced_ns": 0
  }
]

The cURL request supplies the documented path and query values and asks OrdinateDB to list collector connection diagnostics. The documented 200 response is collector diagnostics.

How it works

These routes report server-managed collector or job state; collector writes themselves use the separate gRPC ingest contract.

Reference

Required capability
read
Authorization scope
held anywhere

Parameters

No parameters.

Request body

This operation has no request body.

Responses

200Collector diagnostics

application/json

array

acked_throughintegerrequired
minimum: 0
collector_idstringrequired
credit_backfillintegerrequired
minimum: 0
credit_liveintegerrequired
minimum: 0
fenced_streams_totalintegerrequired
minimum: 0
last_batch_arrival_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
last_collector_receipt_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
last_fenced_nsany ofrequired

any of

option 1

integer

UTC Unix timestamp in nanoseconds

format: int64

option 2

null
session_epochintegerrequired
minimum: 0
streamsarrayrequired

array

string
watermark_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
unknown fields rejected

Example 200 output

[
  {
    "collector_id": "string",
    "session_epoch": 0,
    "streams": [
      "string"
    ],
    "last_batch_arrival_ns": 0,
    "last_collector_receipt_ns": 0,
    "watermark_ns": 0,
    "acked_through": 0,
    "credit_live": 0,
    "credit_backfill": 0,
    "fenced_streams_total": 0,
    "last_fenced_ns": 0
  }
]
401Authentication required

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 401 output

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}
403Read capability is not granted

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 403 output

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

Code examples

These examples are generated from the source contract. Replace the base URL, credentials, identifiers, and minimal generated values for your instance.

JavaScript

const ordinateUrl = "http://localhost:8080";
const token = "<bearer-token>";

const response = await fetch(`${ordinateUrl}/v1/collectors`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${token}`
  }
});

if (!response.ok) {
  throw new Error(`OrdinateDB returned ${response.status}: ${await response.text()}`);
}

const data = await response.json();
console.log(data);

Related topics