Apiratelimit v1alpha1 — hub.traefik.io

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata object

spec object

The desired behavior of this APIRateLimit.

apiSelector object

APISelector selects the APIs that will be rate limited. Multiple APIRateLimits can select the same set of APIs. This field is optional and follows standard label selector semantics. An empty APISelector matches any API.

matchExpressions []object

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key string required

key is the label key that the selector applies to.

operator string required

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values []string

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

matchLabels object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

apis []object

APIs defines a set of APIs that will be rate limited. Multiple APIRateLimits can select the same APIs. When combined with APISelector, this set of APIs is appended to the matching APIs.

maxItems: 100

name string required

Name of the API.

maxLength: 253

everyone boolean

Everyone indicates that all users will, by default, be rate limited with this configuration. If an APIRateLimit explicitly target a group, the default rate limit will be ignored.

groups []string

Groups are the consumer groups that will be rate limited. Multiple APIRateLimits can target the same set of consumer groups, the most restrictive one applies. When a consumer belongs to multiple groups, the least restrictive APIRateLimit applies.

limit integer required

Limit is the maximum number of token in the bucket.

period string

Period is the unit of time for the Limit.

format: duration

strategy string

Strategy defines how the bucket state will be synchronized between the different Traefik Hub instances. It can be, either "local" or "distributed".

enum: local, distributed

status object

The current status of this APIRateLimit.

hash string

Hash is a hash representing the APIRateLimit.

syncedAt string

format: date-time

version string