Resources / RateLimitPolicy

RateLimitPolicy

How many API requests a principal may send. The policy bound to a billing account (spec.accountRef) applies to requests addressed to that account's projects; the policy named `default` applies to everything else. Platform administrators and the platform's own components are not limited. Only platform administrators write policies; changes apply within a minute.

Access: By invitation. Policies run in observe mode: a request over its limit is served, not refused. See Service access.

Overview

APIlimits.etorm.com/v1alpha1
Resourceratelimitpolicies (cluster-scoped inside its cluster)
Short namesrlp
Available inthe platform only
Statusnone: the object is configuration only

Minimal example

apiVersion: limits.etorm.com/v1alpha1
kind: RateLimitPolicy
metadata:
  name: example
spec: {}

Spec

FieldTypeRequiredDefaultAllowedDescription
modestring (one of)"observe"observe, enforceobserve: requests over the limit are counted and audited but still served; enforce: they are refused with 429. New policies observe; a policy is switched to enforce only after its observed rates are known.
accountRefreference to BillingAccountThe billing account this policy is for. Absent: the platform default (the object must then be named `default`).
requestsPerMinuteinteger1 to 1000000Requests a principal may send per minute, on average (default 1200).
burstinteger1 to 1000000Requests a principal may send at once after being idle; at least writeCost (default 200).
writeCostinteger1 to 1000A write (anything but GET) counts as this many requests (default 5).
ipRequestsPerMinuteinteger1 to 1000000Requests per minute from one client address before sign-in is checked (default 600). Only the platform default applies.
ipBurstinteger1 to 1000000Requests one client address may send at once (default 100). Only the platform default applies.
maxWatchesinteger1 to 10000Open watches per principal (default 20).
maxBodyBytesinteger1024 to 67108864Largest request body in bytes (default 4194304).

Columns in listings

ColumnFrom
Account.spec.accountRef.name
Per-Minute.spec.requestsPerMinute
Burst.spec.burst
Watches.spec.maxWatches

All resources