Event

    apiVersion: events.k8s.io/v1

    import "k8s.io/api/events/v1"

    Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.


    • apiVersion: events.k8s.io/v1

    • kind: Event

    • metadata (ObjectMeta)

      Standard object’s metadata. More info:

    • eventTime (MicroTime), required

      eventTime is the time when this Event was first observed. It is required.

      MicroTime is version of Time with microsecond level precision.

    • action (string)

      action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters.

    • deprecatedCount (int32)

      deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type.

    • deprecatedLastTimestamp (Time)

      deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.

      Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    • deprecatedSource (EventSource)

      deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type.

      EventSource contains information for an event.

      • deprecatedSource.component (string)

        Component from which the event is generated.

      • deprecatedSource.host (string)

        Node name on which the event is generated.

    • note (string)

      note is a human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB.

    • reason (string)

      reason is why the action was taken. It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters.

    • regarding (ObjectReference)

      regarding contains the object this Event is about. In most cases it’s an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object.

    • related ()

      related is the optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object.

    • reportingController (string)

      reportingController is the name of the controller that emitted this Event, e.g. kubernetes.io/kubelet. This field cannot be empty for new Events.

    • reportingInstance (string)

      reportingInstance is the ID of the controller instance, e.g. kubelet-xyzf. This field cannot be empty for new Events and it can have at most 128 characters.

    • series (EventSeries)

      series is data about the Event series this event represents or nil if it’s a singleton Event.

      EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. How often to update the EventSeries is up to the event reporters. The default event reporter in “k8s.io/client-go/tools/events/event_broadcaster.go” shows how this struct is updated on heartbeats and can guide customized reporter implementations.

      • series.count (int32), required

        count is the number of occurrences in this series up to the last heartbeat time.

      • series.lastObservedTime (MicroTime), required

        lastObservedTime is the time when last Event from the series was seen before last heartbeat.

        MicroTime is version of Time with microsecond level precision.

    • type (string)

      type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable. This field cannot be empty for new Events.

    EventList is a list of Event objects.


    • apiVersion: events.k8s.io/v1

    • kind: EventList

    • metadata (ListMeta)

      Standard list metadata. More info:

    • items ([]Event), required

      items is a list of schema objects.


    HTTP Request

    GET /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}

    Parameters

    • name (in path): string, required

      name of the Event

    • namespace (in path): string, required

    • pretty (in query): string

      pretty

    Response

    200 (Event): OK

    401: Unauthorized

    list list or watch objects of kind Event

    HTTP Request

    GET /apis/events.k8s.io/v1/namespaces/{namespace}/events

    Parameters

    • namespace (in path): string, required

      namespace

    • allowWatchBookmarks (in query): boolean

    • continue (in query): string

    • fieldSelector (in query): string

      fieldSelector

    • labelSelector (in query): string

    • limit (in query): integer

      limit

    • pretty (in query): string

    • resourceVersion (in query): string

      resourceVersion

    • resourceVersionMatch (in query): string

    • timeoutSeconds (in query): integer

      timeoutSeconds

    • watch (in query): boolean

    Response

    200 (): OK

    401: Unauthorized

    HTTP Request

    GET /apis/events.k8s.io/v1/events

    Parameters

    • allowWatchBookmarks (in query): boolean

      allowWatchBookmarks

    • continue (in query): string

    • fieldSelector (in query): string

      fieldSelector

    • labelSelector (in query): string

    • limit (in query): integer

      limit

    • pretty (in query): string

    • resourceVersion (in query): string

      resourceVersion

    • resourceVersionMatch (in query): string

    • timeoutSeconds (in query): integer

      timeoutSeconds

    Response

    200 (EventList): OK

    401: Unauthorized

    create create an Event

    HTTP Request

    POST /apis/events.k8s.io/v1/namespaces/{namespace}/events

    Parameters

    • namespace (in path): string, required

      namespace

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation (in query): string

      fieldValidation

    • pretty (in query): string

    Response

    200 (): OK

    201 (Event): Created

    202 (): Accepted

    401: Unauthorized

    HTTP Request

    PUT /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}

    Parameters

    • name (in path): string, required

      name of the Event

    • namespace (in path): string, required

      namespace

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation

    • pretty (in query): string

    Response

    200 (): OK

    201 (Event): Created

    401: Unauthorized

    patch partially update the specified Event

    HTTP Request

    PATCH /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}

    Parameters

    • name (in path): string, required

      name of the Event

    • namespace (in path): string, required

      namespace

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation (in query): string

      fieldValidation

    • force (in query): boolean

    • pretty (in query): string

      pretty

    Response

    200 (Event): OK

    201 (): Created

    401: Unauthorized

    HTTP Request

    DELETE /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}

    Parameters

    • name (in path): string, required

      name of the Event

    • namespace (in path): string, required

      namespace

    • body:

    • dryRun (in query): string

      dryRun

    • gracePeriodSeconds (in query): integer

    • pretty (in query): string

      pretty

    • propagationPolicy (in query): string

    Response

    200 (): OK

    202 (Status): Accepted

    401: Unauthorized

    deletecollection delete collection of Event

    HTTP Request

    DELETE /apis/events.k8s.io/v1/namespaces/{namespace}/events

    Parameters

    • namespace (in path): string, required

      namespace

    • body:

    • continue (in query): string

      continue

    • dryRun (in query): string

    • fieldSelector (in query): string

      fieldSelector

    • gracePeriodSeconds (in query): integer

    • labelSelector (in query): string

      labelSelector

    • limit (in query): integer

    • pretty (in query): string

      pretty

    • propagationPolicy (in query): string

    • resourceVersion (in query): string

      resourceVersion

    • resourceVersionMatch (in query): string

    • timeoutSeconds (in query): integer

      timeoutSeconds

    Response

    200 (Status): OK

    Last modified December 08, 2021 at 9:34 AM PST: