事件 [undefined/v1] - 元数据 API | API 参考 | OpenShift 容器平台 4.17

规范
API 端点

描述

事件是集群中某个位置发生的事件报告。事件的保留时间有限，触发器和消息可能会随着时间推移而发生变化。事件使用者不应依赖于具有给定原因的事件的时机反映一致的底层触发器，也不应依赖于具有该原因的事件的持续存在。事件应被视为信息性的、尽力而为的补充数据。

类型

对象

必需

元数据
involvedObject

规范

属性类型描述

属性	类型	描述
`action`	`字符串`	关于相关对象的采取/失败的操作。
`apiVersion`	`字符串`	APIVersion 定义了此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`count`	`整数`	此事件发生的次数。
`eventTime`	`MicroTime`	首次观察到此事件的时间。
`firstTimestamp`	`时间`	首次记录事件的时间。（服务器接收时间在 TypeMeta 中。）
`involvedObject`	`对象`	ObjectReference 包含足够的信息，可让您检查或修改引用的对象。
`kind`	`字符串`	Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。无法更新。采用驼峰式命名法。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`lastTimestamp`	`时间`	记录此事件最近一次发生的时间。
`message`	`字符串`	此操作状态的人类可读描述。
`元数据`	`ObjectMeta`	标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`reason`	`字符串`	这应该是一个简短的、机器可理解的字符串，它给出对象转换为当前状态的原因。
`related`	`对象`	ObjectReference 包含足够的信息，可让您检查或修改引用的对象。
`reportingComponent`	`字符串`	发出此事件的控制器的名称，例如 `kubernetes.io/kubelet`。
`reportingInstance`	`字符串`	控制器实例的 ID，例如 `kubelet-xyzf`。
`series`	`对象`	EventSeries 包含有关一系列事件的信息，即持续发生一段时间的事情。
`source`	`对象`	EventSource 包含事件的信息。
`type`	`字符串`	此事件的类型（正常、警告），将来可能会添加新类型

action

字符串

关于相关对象的采取/失败的操作。

apiVersion

字符串

APIVersion 定义了此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

count

整数

此事件发生的次数。

eventTime

MicroTime

首次观察到此事件的时间。

firstTimestamp

时间

首次记录事件的时间。（服务器接收时间在 TypeMeta 中。）

involvedObject

对象

ObjectReference 包含足够的信息，可让您检查或修改引用的对象。

kind

字符串

Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。无法更新。采用驼峰式命名法。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

lastTimestamp

时间

记录此事件最近一次发生的时间。

message

字符串

此操作状态的人类可读描述。

元数据

ObjectMeta

标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

reason

字符串

这应该是一个简短的、机器可理解的字符串，它给出对象转换为当前状态的原因。

related

对象

ObjectReference 包含足够的信息，可让您检查或修改引用的对象。

reportingComponent

字符串

发出此事件的控制器的名称，例如 kubernetes.io/kubelet。

reportingInstance

字符串

控制器实例的 ID，例如 kubelet-xyzf。

series

对象

EventSeries 包含有关一系列事件的信息，即持续发生一段时间的事情。

source

对象

EventSource 包含事件的信息。

type

字符串

此事件的类型（正常、警告），将来可能会添加新类型

.involvedObject

描述: ObjectReference 包含足够的信息，可让您检查或修改引用的对象。
类型: 对象

属性类型描述

属性	类型	描述
`apiVersion`	`字符串`	引用的 API 版本。
`fieldPath`	`字符串`	如果引用的是对象的一部分而不是整个对象，则此字符串应包含有效的 JSON/Go 字段访问语句，例如 desiredState.manifest.containers[2]。例如，如果对象引用是指 Pod 中的容器，则这将采用以下值： "spec.containers{name}"（其中“name”是指触发事件的容器的名称）或者如果没有指定容器名称，则为 "spec.containers[2]"（此 Pod 中索引为 2 的容器）。选择此语法只是为了具有一些明确定义的方法来引用对象的一部分。
`kind`	`字符串`	引用的 Kind。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`name`	`字符串`	引用的名称。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names
`namespace`	`字符串`	引用对象的命名空间。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/namespaces/
`resourceVersion`	`字符串`	此引用的特定 resourceVersion（如果存在）。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
`uid`	`字符串`	引用的UID。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#uids

apiVersion

字符串

引用的 API 版本。

fieldPath

字符串

如果引用的是对象的一部分而不是整个对象，则此字符串应包含有效的 JSON/Go 字段访问语句，例如 desiredState.manifest.containers[2]。例如，如果对象引用是指 Pod 中的容器，则这将采用以下值： "spec.containers{name}"（其中“name”是指触发事件的容器的名称）或者如果没有指定容器名称，则为 "spec.containers[2]"（此 Pod 中索引为 2 的容器）。选择此语法只是为了具有一些明确定义的方法来引用对象的一部分。

kind

字符串

name

字符串

namespace

字符串

引用对象的命名空间。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

字符串

此引用的特定 resourceVersion（如果存在）。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

字符串

描述: ObjectReference 包含足够的信息，可让您检查或修改引用的对象。
类型: 对象

属性类型描述

属性	类型	描述
`apiVersion`	`字符串`	引用的 API 版本。
`fieldPath`	`字符串`	如果引用的是对象的一部分而不是整个对象，则此字符串应包含有效的 JSON/Go 字段访问语句，例如 desiredState.manifest.containers[2]。例如，如果对象引用是指 Pod 中的容器，则这将采用以下值： "spec.containers{name}"（其中“name”是指触发事件的容器的名称）或者如果没有指定容器名称，则为 "spec.containers[2]"（此 Pod 中索引为 2 的容器）。选择此语法只是为了具有一些明确定义的方法来引用对象的一部分。
`kind`	`字符串`	引用的 Kind。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`name`	`字符串`	引用的名称。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names
`namespace`	`字符串`	引用对象的命名空间。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/namespaces/
`resourceVersion`	`字符串`	此引用的特定 resourceVersion（如果存在）。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
`uid`	`字符串`	引用的UID。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#uids

apiVersion

字符串

引用的 API 版本。

fieldPath

字符串

kind

字符串

name

字符串

namespace

字符串

引用对象的命名空间。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

字符串

此引用的特定 resourceVersion（如果存在）。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

字符串

.series

描述: EventSeries 包含有关一系列事件的信息，即持续发生一段时间的事情。
类型: 对象

属性类型描述

属性	类型	描述
`count`	`整数`	在此系列中直到最后一次心跳时间的出现次数
`lastObservedTime`	`MicroTime`	观察到最后一次出现的时间

count

整数

在此系列中直到最后一次心跳时间的出现次数

lastObservedTime

MicroTime

观察到最后一次出现的时间

.source

描述: EventSource 包含事件的信息。
类型: 对象

属性类型描述

属性	类型	描述
`component`	`字符串`	生成事件的组件。
`host`	`字符串`	生成事件的节点名称。

component

字符串

生成事件的组件。

host

字符串

生成事件的节点名称。

API 端点

提供以下API端点

/api/v1/events
- GET：列出或监视 Event 类型的对象
/api/v1/watch/events
- GET：监视 Event 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。
/api/v1/namespaces/{namespace}/events
- DELETE：删除 Event 集合
- GET：列出或监视 Event 类型的对象
- POST：创建一个 Event
/api/v1/watch/namespaces/{namespace}/events
- GET：监视 Event 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。
/api/v1/namespaces/{namespace}/events/{name}
- DELETE：删除一个 Event
- GET：读取指定的 Event
- PATCH：部分更新指定的 Event
- PUT：替换指定的 Event
/api/v1/watch/namespaces/{namespace}/events/{name}
- GET：监视 Event 类型对象的更改。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数将其过滤为单个项目。

/api/v1/events

HTTP 方法: GET
描述: 列出或监视 Event 类型的对象

表 1. HTTP 响应
HTTP 代码	响应体
200 - OK	`EventList` 模式
401 - 未授权	空

/api/v1/watch/events

HTTP 方法: GET
描述: 监视 Event 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。

表 2. HTTP 响应
HTTP 代码	响应体
200 - OK	`WatchEvent` 模式
401 - 未授权	空

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

HTTP 方法: DELETE
描述: 删除 Event 集合

表 3. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

表 4. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 列出或监视 Event 类型的对象

表 5. HTTP 响应
HTTP 代码	响应体
200 - OK	`EventList` 模式
401 - 未授权	空

HTTP 方法: POST
描述: 创建一个 Event

表 6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的除最后一个重复字段之外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 7. 请求体参数
参数	类型	描述
`body`	`Event` 模式

表 8. HTTP 响应
HTTP 代码	响应体
200 - OK	`Event` 模式
201 - 已创建	`Event` 模式
202 - 已接受	`Event` 模式
401 - 未授权	空

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

HTTP 方法: GET
描述: 监视 Event 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。

表 9. HTTP 响应
HTTP 代码	响应体
200 - OK	`WatchEvent` 模式
401 - 未授权	空

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

表 10. 全局路径参数
参数	类型	描述
`name`	`字符串`	Event 的名称

HTTP 方法: DELETE
描述: 删除一个 Event

表 11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

表 12. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status` 模式
202 - 已接受	`Status` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 读取指定的 Event

表 13. HTTP 响应
HTTP 代码	响应体
200 - OK	`Event` 模式
401 - 未授权	空

HTTP 方法: PATCH
描述: 部分更新指定的 Event

表 14. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的除最后一个重复字段之外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 15. HTTP 响应
HTTP 代码	响应体
200 - OK	`Event` 模式
201 - 已创建	`Event` 模式
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定的 Event

表 16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的除最后一个重复字段之外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 17. 请求体参数
参数	类型	描述
`body`	`Event` 模式

表 18. HTTP 响应
HTTP 代码	响应体
200 - OK	`Event` 模式
201 - 已创建	`Event` 模式
401 - 未授权	空

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

表 19. 全局路径参数
参数	类型	描述
`name`	`字符串`	Event 的名称

HTTP 方法: GET
描述: 监视 Event 类型对象的更改。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数将其过滤为单个项目。

表 20. HTTP 响应
HTTP 代码	响应体
200 - OK	`WatchEvent` 模式
401 - 未授权	空

事件 [v1]

规范

.involvedObject

.related

.series

.source

API 端点

/api/v1/events

/api/v1/watch/events

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

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

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

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