Skip to main content
GET
Run a PromQL range query through an Operator agent

Query Parameters

clusterArn
string
required

ARN of the EKS cluster whose Operator agent proxies the query. Resolved to a connected agent inside the caller's own organization, which is what confines this endpoint to clusters the caller can see — an ARN belonging to another tenant resolves to nothing.

endpoint
string
required

Base URL of the Prometheus to query, without the /api/v1/query_range suffix. Naming it is not a permission: the agent judges every proxied destination against its own httpProxy.allowedEndpoints, so an endpoint that install was not configured for is refused in the cluster.

authSecret
string | null

Name of a Kubernetes Secret in the Operator namespace whose contents the AGENT presents as the Authorization header. A name, never a value — Ravion neither reads nor stores the credential. Omit for an endpoint that needs none.

query
string
required

PromQL expression. Occurrences of $__interval are replaced server-side with the normalized step, so range-vector windows always match the resolution actually queried.

step
integer<int32>
required

Requested step in seconds. Widened server-side to a 15s floor and to whatever keeps the window under the 11,000-samples-per-series cap; the effective value is echoed as stepSeconds.

startTime
string
required

Inclusive start of the query window (ISO 8601). Must be earlier than endTime.

endTime
string
required

Inclusive end of the query window (ISO 8601). Must be after startTime and not in the future.

Response

The request has succeeded.

Response payload for a PromQL range query proxied through an Operator agent. series and stepSeconds are the same shape the Amazon Managed Prometheus endpoint returns, so one chart component renders both; offlineClusters is the field that exists only here.

offlineClusters
string[]
required

Cluster ARNs whose Operator agent is not connected, so no query could be sent. Empty on a normal answer. Render this as an explicit state and fall through to the next source in the chart's chain — never as an empty result.

series
object[]
required

Result series, in the order Prometheus returned them.

stepSeconds
integer<int32>
required

The step in seconds actually used, after normalization to Prometheus's floor and per-series sample cap. May be coarser than the requested step.