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
| Property | Type | Description |
|---|---|---|
|
|
| What action was taken/failed regarding to the Regarding object. |
|
|
| 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 |
|
|
| The number of times this event has occurred. |
|
| Time when this Event was first observed. | |
|
| The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) | |
|
|
| ObjectReference contains enough information to let you inspect or modify the referred object. |
|
|
| 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 |
|
| The time at which the most recent occurrence of this event was recorded. | |
|
|
| A human-readable description of the status of this operation. |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| This should be a short, machine understandable string that gives the reason for the transition into the object’s current status. |
|
|
| ObjectReference contains enough information to let you inspect or modify the referred object. |
|
|
|
Name of the controller that emitted this Event, e.g. |
|
|
|
ID of the controller instance, e.g. |
|
|
| EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. |
|
|
| EventSource contains information for an event. |
|
|
| 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
| Property | Type | Description |
|---|---|---|
|
|
| API version of the referent. |
|
|
| 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 of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| 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 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
| Property | Type | Description |
|---|---|---|
|
|
| Number of occurrences in this series up to the last heartbeat time |
|
| Time of the last occurrence observed |
8.1.4. .source
- Description
- EventSource contains information for an event.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| Component from which the event is generated. |
|
|
| 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
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 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.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
8.2.3. /api/v1/namespaces/{namespace}/events
- HTTP method
-
DELETE - Description
- delete collection of Event
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list or watch objects of kind Event
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create an Event
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 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.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
8.2.5. /api/v1/namespaces/{namespace}/events/{name}
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Event |
- HTTP method
-
DELETE - Description
- delete an Event
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified Event
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified Event
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified Event
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
8.2.6. /api/v1/watch/namespaces/{namespace}/events/{name}
| Parameter | Type | Description |
|---|---|---|
|
|
| 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.
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
