Questo contenuto non è disponibile nella lingua selezionata.

Chapter 8. Event [v1]


Description
Event is a report of an event somewhere in the cluster. 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.
Type
object
Required
  • metadata
  • involvedObject

8.1. Specification

PropertyTypeDescription

action

string

What action was taken/failed regarding to the Regarding object.

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

count

integer

The number of times this event has occurred.

eventTime

MicroTime

Time when this Event was first observed.

firstTimestamp

Time

The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)

involvedObject

object

ObjectReference contains enough information to let you inspect or modify the referred object.

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

lastTimestamp

Time

The time at which the most recent occurrence of this event was recorded.

message

string

A human-readable description of the status of this operation.

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

reason

string

This should be a short, machine understandable string that gives the reason for the transition into the object’s current status.

related

object

ObjectReference contains enough information to let you inspect or modify the referred object.

reportingComponent

string

Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.

reportingInstance

string

ID of the controller instance, e.g. kubelet-xyzf.

series

object

EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.

source

object

EventSource contains information for an event.

type

string

Type of this event (Normal, Warning), new types could be added in the future

8.1.1. .involvedObject

Description
ObjectReference contains enough information to let you inspect or modify the referred object.
Type
object
PropertyTypeDescription

apiVersion

string

API version of the referent.

fieldPath

string

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

kind

string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

string

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

8.1.3. .series

Description
EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.
Type
object
PropertyTypeDescription

count

integer

Number of occurrences in this series up to the last heartbeat time

lastObservedTime

MicroTime

Time of the last occurrence observed

8.1.4. .source

Description
EventSource contains information for an event.
Type
object
PropertyTypeDescription

component

string

Component from which the event is generated.

host

string

Node name on which the event is generated.

8.2. API endpoints

The following API endpoints are available:

  • /api/v1/events

    • GET: list or watch objects of kind Event
  • /api/v1/watch/events

    • GET: watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
  • /api/v1/namespaces/{namespace}/events

    • DELETE: delete collection of Event
    • GET: list or watch objects of kind Event
    • POST: create an Event
  • /api/v1/watch/namespaces/{namespace}/events

    • GET: watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
  • /api/v1/namespaces/{namespace}/events/{name}

    • DELETE: delete an Event
    • GET: read the specified Event
    • PATCH: partially update the specified Event
    • PUT: replace the specified Event
  • /api/v1/watch/namespaces/{namespace}/events/{name}

    • GET: watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

8.2.1. /api/v1/events

HTTP method
GET
Description
list or watch objects of kind Event
Table 8.1. HTTP responses
HTTP codeReponse body

200 - OK

EventList schema

401 - Unauthorized

Empty

8.2.2. /api/v1/watch/events

HTTP method
GET
Description
watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
Table 8.2. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

8.2.3. /api/v1/namespaces/{namespace}/events

HTTP method
DELETE
Description
delete collection of Event
Table 8.3. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 8.4. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list or watch objects of kind Event
Table 8.5. HTTP responses
HTTP codeReponse body

200 - OK

EventList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create an Event
Table 8.6. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 8.7. Body parameters
ParameterTypeDescription

body

Event schema

 
Table 8.8. HTTP responses
HTTP codeReponse body

200 - OK

Event schema

201 - Created

Event schema

202 - Accepted

Event schema

401 - Unauthorized

Empty

8.2.4. /api/v1/watch/namespaces/{namespace}/events

HTTP method
GET
Description
watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
Table 8.9. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

8.2.5. /api/v1/namespaces/{namespace}/events/{name}

Table 8.10. Global path parameters
ParameterTypeDescription

name

string

name of the Event

HTTP method
DELETE
Description
delete an Event
Table 8.11. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 8.12. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified Event
Table 8.13. HTTP responses
HTTP codeReponse body

200 - OK

Event schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified Event
Table 8.14. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 8.15. HTTP responses
HTTP codeReponse body

200 - OK

Event schema

201 - Created

Event schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified Event
Table 8.16. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 8.17. Body parameters
ParameterTypeDescription

body

Event schema

 
Table 8.18. HTTP responses
HTTP codeReponse body

200 - OK

Event schema

201 - Created

Event schema

401 - Unauthorized

Empty

8.2.6. /api/v1/watch/namespaces/{namespace}/events/{name}

Table 8.19. Global path parameters
ParameterTypeDescription

name

string

name of the Event

HTTP method
GET
Description
watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
Table 8.20. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Formazione

Prova, acquista e vendi

Community

Informazioni sulla documentazione di Red Hat

Aiutiamo gli utenti Red Hat a innovarsi e raggiungere i propri obiettivi con i nostri prodotti e servizi grazie a contenuti di cui possono fidarsi.

Rendiamo l’open source più inclusivo

Red Hat si impegna a sostituire il linguaggio problematico nel codice, nella documentazione e nelle proprietà web. Per maggiori dettagli, visita ilBlog di Red Hat.

Informazioni su Red Hat

Forniamo soluzioni consolidate che rendono più semplice per le aziende lavorare su piattaforme e ambienti diversi, dal datacenter centrale all'edge della rete.

© 2024 Red Hat, Inc.