kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
website/docs/api-reference/v1.5/documents/_generated_event_v1_concept.md

717 lines
15 KiB
Markdown
Raw Normal View History

Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
-----------
# Event v1
Group | Version | Kind
------------ | ---------- | -----------
Core | v1 | Event
<aside class="notice">Other api versions of this object exist: <a href="#event-versioned">versioned</a> </aside>
Event is a report of an event somewhere in the cluster.
<aside class="notice">
Appears In <a href="#eventlist-v1">EventList</a> </aside>
Field | Description
------------ | -----------
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
apiVersion <br /> *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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
count <br /> *integer* | The number of times this event has occurred.
firstTimestamp <br /> *[Time](#time-unversioned)* | The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
involvedObject <br /> *[ObjectReference](#objectreference-v1)* | The object that this event is about.
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
kind <br /> *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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
lastTimestamp <br /> *[Time](#time-unversioned)* | The time at which the most recent occurrence of this event was recorded.
message <br /> *string* | A human-readable description of the status of this operation.
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
reason <br /> *string* | This should be a short, machine understandable string that gives the reason for the transition into the object's current status.
source <br /> *[EventSource](#eventsource-v1)* | The component reporting this event. Should be a short machine understandable string.
type <br /> *string* | Type of this event (Normal, Warning), new types could be added in the future
### EventList v1
Field | Description
------------ | -----------
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
apiVersion <br /> *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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
items <br /> *[Event](#event-v1) array* | List of events
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
kind <br /> *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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
## <strong>Write Operations</strong>
See supported operations below...
## Create
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
create an Event
### HTTP Request
`POST /api/v1/namespaces/{namespace}/events`
### Path Parameters
Parameter | Description
------------ | -----------
namespace | object name and auth scope, such as for teams and projects
### Query Parameters
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
Parameter | Description
------------ | -----------
pretty | If 'true', then the output is pretty printed.
### Body Parameters
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
Parameter | Description
------------ | -----------
body <br /> *[Event](#event-v1)* |
### Response
Code | Description
------------ | -----------
200 <br /> *[Event](#event-v1)* | OK
## Replace
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
replace the specified Event
### HTTP Request
`PUT /api/v1/namespaces/{namespace}/events/{name}`
### Path Parameters
Parameter | Description
------------ | -----------
name | name of the Event
namespace | object name and auth scope, such as for teams and projects
### Query Parameters
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
Parameter | Description
------------ | -----------
pretty | If 'true', then the output is pretty printed.
### Body Parameters
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
Parameter | Description
------------ | -----------
body <br /> *[Event](#event-v1)* |
### Response
Code | Description
------------ | -----------
200 <br /> *[Event](#event-v1)* | OK
## Patch
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
partially update the specified Event
### HTTP Request
`PATCH /api/v1/namespaces/{namespace}/events/{name}`
### Path Parameters
Parameter | Description
------------ | -----------
name | name of the Event
namespace | object name and auth scope, such as for teams and projects
### Query Parameters
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
Parameter | Description
------------ | -----------
pretty | If 'true', then the output is pretty printed.
### Body Parameters
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
Parameter | Description
------------ | -----------
body <br /> *[Patch](#patch-unversioned)* |
### Response
Code | Description
------------ | -----------
200 <br /> *[Event](#event-v1)* | OK
## Delete
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
delete an Event
### HTTP Request
`DELETE /api/v1/namespaces/{namespace}/events/{name}`
### Path Parameters
Parameter | Description
------------ | -----------
name | name of the Event
namespace | object name and auth scope, such as for teams and projects
### Query Parameters
Parameter | Description
------------ | -----------
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
pretty | If 'true', then the output is pretty printed.
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
### Body Parameters
Parameter | Description
------------ | -----------
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
### Response
Code | Description
------------ | -----------
200 <br /> *[Status](#status-unversioned)* | OK
## Delete Collection
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
delete collection of Event
### HTTP Request
`DELETE /api/v1/namespaces/{namespace}/events`
### Path Parameters
Parameter | Description
------------ | -----------
namespace | object name and auth scope, such as for teams and projects
### Query Parameters
Parameter | Description
------------ | -----------
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
pretty | If 'true', then the output is pretty printed.
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSeconds | Timeout for the list/watch call.
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
### Response
Code | Description
------------ | -----------
200 <br /> *[Status](#status-unversioned)* | OK
## <strong>Read Operations</strong>
See supported operations below...
## Read
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
read the specified Event
### HTTP Request
`GET /api/v1/namespaces/{namespace}/events/{name}`
### Path Parameters
Parameter | Description
------------ | -----------
name | name of the Event
namespace | object name and auth scope, such as for teams and projects
### Query Parameters
Parameter | Description
------------ | -----------
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
pretty | If 'true', then the output is pretty printed.
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
export | Should this value be exported. Export strips fields that a user can not specify.
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
### Response
Code | Description
------------ | -----------
200 <br /> *[Event](#event-v1)* | OK
## List
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
list or watch objects of kind Event
### HTTP Request
`GET /api/v1/namespaces/{namespace}/events`
### Path Parameters
Parameter | Description
------------ | -----------
namespace | object name and auth scope, such as for teams and projects
### Query Parameters
Parameter | Description
------------ | -----------
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
pretty | If 'true', then the output is pretty printed.
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSeconds | Timeout for the list/watch call.
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
### Response
Code | Description
------------ | -----------
200 <br /> *[EventList](#eventlist-v1)* | OK
## List All Namespaces
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
list or watch objects of kind Event
### HTTP Request
`GET /api/v1/events`
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
### Query Parameters
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
Parameter | Description
------------ | -----------
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty | If 'true', then the output is pretty printed.
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSeconds | Timeout for the list/watch call.
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
### Response
Code | Description
------------ | -----------
200 <br /> *[EventList](#eventlist-v1)* | OK
## Watch
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
watch changes to an object of kind Event
### HTTP Request
`GET /api/v1/watch/namespaces/{namespace}/events/{name}`
### Path Parameters
Parameter | Description
------------ | -----------
name | name of the Event
namespace | object name and auth scope, such as for teams and projects
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
### Query Parameters
Parameter | Description
------------ | -----------
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
pretty | If 'true', then the output is pretty printed.
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSeconds | Timeout for the list/watch call.
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
### Response
Code | Description
------------ | -----------
200 <br /> *[Event](#event-versioned)* | OK
## Watch List All Namespaces
>bdocs-tab:kubectl `kubectl` Command
```bdocs-tab:kubectl_shell
Coming Soon
```
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
```bdocs-tab:curl_shell
Coming Soon
```
>bdocs-tab:kubectl Output
```bdocs-tab:kubectl_json
Coming Soon
```
>bdocs-tab:curl Response Body
```bdocs-tab:curl_json
Coming Soon
```
watch individual changes to a list of Event
### HTTP Request
`GET /api/v1/watch/events`
Fix issue in reference docs where query parameters were listed as path params and body params were listed as query params.
2017-01-13 23:08:36 +00:00
### Query Parameters
Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
2016-11-29 19:35:29 +00:00
Parameter | Description
------------ | -----------
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty | If 'true', then the output is pretty printed.
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSeconds | Timeout for the list/watch call.
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
### Response
Code | Description
------------ | -----------
200 <br /> *[Event](#event-versioned)* | OK