← Back to index Esc
Kind
Apiplan
Group
hub.traefik.io
Version
v1alpha1
apiVersion: hub.traefik.io/v1alpha1 kind: Apiplan metadata: name: example
View raw schema
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 APIPlan.
description string
Description describes the plan.
quota object
Quota defines the quota policy.
bucket string
Bucket defines the bucket strategy for the quota.
enum: subscription, application-api, application
limit integer required
Limit is the maximum number of requests per sliding Period.
period string
Period is the unit of time for the Limit.
format: duration
rateLimit object
RateLimit defines the rate limit policy.
bucket string
Bucket defines the bucket strategy for the rate limit.
enum: subscription, application-api, application
limit integer required
Limit is the number of requests per Period used to calculate the regeneration rate. Traffic will converge to this rate over time by delaying requests when possible, and dropping them when throttling alone is not enough.
period string
Period is the time unit used to express the rate. Combined with Limit, it defines the rate at which request capacity regenerates (Limit ÷ Period).
format: duration
title string required
Title is the human-readable name of the plan.
status object
The current status of this APIPlan.
conditions []object
lastTransitionTime string required
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format: date-time
message string required
message is a human readable message indicating details about the transition. This may be an empty string.
maxLength: 32768
observedGeneration integer
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
format: int64
minimum: 0
reason string required
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
minLength: 1
maxLength: 1024
status string required
status of the condition, one of True, False, Unknown.
enum: True, False, Unknown
type string required
type of condition in CamelCase or in foo.example.com/CamelCase.
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
maxLength: 316
hash string
Hash is a hash representing the APIPlan.
syncedAt string
format: date-time
version string
Copied!