列出管理事件 - AdministrationEventService | API 参考 | Red Hat Advanced Cluster Security for Kubernetes 4.6

GET /v1/administration/events

ListAdministrationEvents 返回根据请求字段过滤后的事件列表。

描述

参数

查询参数

名称描述必填默认值模式

名称	描述	必填	默认值
pagination.limit		-	空
pagination.offset		-	空
pagination.sortOption.field		-	空
pagination.sortOption.reversed		-	空
pagination.sortOption.aggregateBy.aggrFunc		-	未设置 (UNSET)
pagination.sortOption.aggregateBy.distinct		-	空
filter.from	匹配 last_occurred_at 在特定时间戳之后的事件，即下边界。	-	空
filter.until	匹配 last_occurred_at 在特定时间戳之前的事件，即上边界。	-	空
filter.domain	匹配来自特定域的事件。`字符串`	-	空
filter.resourceType	匹配与特定资源类型关联的事件。`字符串`	-	空
filter.type	根据事件类型匹配事件。`字符串`	-	空
filter.level	根据事件级别匹配事件。`字符串`	-	空

pagination.limit

空

pagination.offset

空

pagination.sortOption.field

空

pagination.sortOption.reversed

空

pagination.sortOption.aggregateBy.aggrFunc

未设置 (UNSET)

pagination.sortOption.aggregateBy.distinct

空

filter.from

匹配 last_occurred_at 在特定时间戳之后的事件，即下边界。

空

filter.until

匹配 last_occurred_at 在特定时间戳之前的事件，即上边界。

空

filter.domain

匹配来自特定域的事件。字符串

空

filter.resourceType

匹配与特定资源类型关联的事件。字符串

空

filter.type

根据事件类型匹配事件。字符串

空

filter.level

根据事件级别匹配事件。字符串

空

返回类型

V1ListAdministrationEventsResponse

内容类型

application/json

响应

表 1. HTTP 响应代码
代码	消息	数据类型
200	成功的响应。	V1ListAdministrationEventsResponse
0	意外的错误响应。	GooglerpcStatus

示例

常用对象引用

GooglerpcStatus

字段名称

必填

可空

类型

描述

格式

code

整数

int32

message

字符串

details

ProtobufAny 列表

ProtobufAny

Any包含任意序列化的 Protocol Buffer 消息以及描述序列化消息类型的 URL。

Protobuf 库提供支持，以实用函数或 Any 类型的附加生成方法的形式打包/解包 Any 值。

示例 1：在 C++ 中打包和解包消息。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

示例 2：在 Java 中打包和解包消息。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

Protobuf 库提供的打包方法默认使用“type.googleapis.com/full.type.name”作为类型 URL，解包方法仅使用类型 URL 中最后一个“/”后的完全限定类型名称，例如“foo.bar.com/x/y.z”将产生类型名称“y.z”。

JSON 表示

Any值的 JSON 表示使用反序列化的嵌入式消息的常规表示，并添加一个包含类型 URL 的附加字段@type。示例

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

如果嵌入式消息类型是众所周知的并且具有自定义 JSON 表示，则该表示将被嵌入，添加一个value字段，该字段除了@type字段外还包含自定义 JSON。示例（对于消息 [google.protobuf.Duration][]）

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

字段名称必填可空类型描述格式

字段名称	必填	可空	类型	描述	格式
@type			字符串	一个 URL/资源名称，唯一标识序列化 Protocol Buffer 消息的类型。此字符串必须包含至少一个“/”字符。URL 路径的最后一个段必须表示类型的完全限定名称（如`path/google.protobuf.Duration`）。名称应采用规范形式（例如，不接受前导“.”）。实际上，团队通常会将其预期在 Any 上下文中使用的所有类型预编译到二进制文件中。但是，对于使用方案`http`、`https`或无方案的 URL，可以选择设置类型服务器，该服务器将类型 URL 映射到消息定义，如下所示：* 如果未提供方案，则假定为`https`。* 对 URL 的 HTTP GET 必须产生二进制格式的 [google.protobuf.Type][] 值，否则会产生错误。* 应用程序可以根据 URL 缓存查找结果，或将其预编译到二进制文件中以避免任何查找。因此，需要在更改类型时保留二进制兼容性。（使用版本化的类型名称来管理重大更改。）注意：此功能当前在官方 protobuf 版本中不可用，并且不用于以 type.googleapis.com 开头的类型 URL。截至 2023 年 5 月，没有广泛使用的类型服务器实现，也没有计划实现一个。除了`http`、`https`（或空方案）之外的其他方案可能会与特定于实现的语义一起使用。

@type

字符串

一个 URL/资源名称，唯一标识序列化 Protocol Buffer 消息的类型。此字符串必须包含至少一个“/”字符。URL 路径的最后一个段必须表示类型的完全限定名称（如path/google.protobuf.Duration）。名称应采用规范形式（例如，不接受前导“.”）。实际上，团队通常会将其预期在 Any 上下文中使用的所有类型预编译到二进制文件中。但是，对于使用方案http、https或无方案的 URL，可以选择设置类型服务器，该服务器将类型 URL 映射到消息定义，如下所示：* 如果未提供方案，则假定为https。* 对 URL 的 HTTP GET 必须产生二进制格式的 [google.protobuf.Type][] 值，否则会产生错误。* 应用程序可以根据 URL 缓存查找结果，或将其预编译到二进制文件中以避免任何查找。因此，需要在更改类型时保留二进制兼容性。（使用版本化的类型名称来管理重大更改。）注意：此功能当前在官方 protobuf 版本中不可用，并且不用于以 type.googleapis.com 开头的类型 URL。截至 2023 年 5 月，没有广泛使用的类型服务器实现，也没有计划实现一个。除了http、https（或空方案）之外的其他方案可能会与特定于实现的语义一起使用。

V1AdministrationEvent

AdministrationEvents 是 Central 发出的管理事件。它们用于为异步后台任务的用户创建透明性。事件是 Central 系统运行状况视图的一部分。

字段名称	类型	描述	格式
id	字符串	事件的 UUID。
type	V1AdministrationEventType		ADMINISTRATION_EVENT_TYPE_UNKNOWN, ADMINISTRATION_EVENT_TYPE_GENERIC, ADMINISTRATION_EVENT_TYPE_LOG_MESSAGE,
level	V1AdministrationEventLevel		ADMINISTRATION_EVENT_LEVEL_UNKNOWN, ADMINISTRATION_EVENT_LEVEL_INFO, ADMINISTRATION_EVENT_LEVEL_SUCCESS, ADMINISTRATION_EVENT_LEVEL_WARNING, ADMINISTRATION_EVENT_LEVEL_ERROR,
message	字符串	与事件关联的消息。该消息可能包含此特定事件的详细信息。
hint	字符串	与事件关联的提示。提示可能包含基于事件类型的不同信息。它可以包含解决事件的说明或信息提示。
domain	字符串	与事件关联的域。事件的域概述了创建事件的功能域。例如，这可能是“图像扫描”。对于无法绑定到特定域的事件，这将是“常规”。
resource	V1AdministrationEventResource
numOccurrences	字符串	与事件关联的出现次数。当事件可能多次发生时，出现次数会跟踪数量。	int64
lastOccurredAt	日期	指定事件最后一次发生的时间。	日期时间
createdAt	日期	指定事件创建时间。	日期时间

字段名称

必填

可空

类型

描述

格式

字符串

事件的 UUID。

type

V1AdministrationEventType

ADMINISTRATION_EVENT_TYPE_UNKNOWN, ADMINISTRATION_EVENT_TYPE_GENERIC, ADMINISTRATION_EVENT_TYPE_LOG_MESSAGE,

level

V1AdministrationEventLevel

ADMINISTRATION_EVENT_LEVEL_UNKNOWN, ADMINISTRATION_EVENT_LEVEL_INFO, ADMINISTRATION_EVENT_LEVEL_SUCCESS, ADMINISTRATION_EVENT_LEVEL_WARNING, ADMINISTRATION_EVENT_LEVEL_ERROR,

message

字符串

与事件关联的消息。该消息可能包含此特定事件的详细信息。

hint

字符串

与事件关联的提示。提示可能包含基于事件类型的不同信息。它可以包含解决事件的说明或信息提示。

domain

字符串

与事件关联的域。事件的域概述了创建事件的功能域。例如，这可能是“图像扫描”。对于无法绑定到特定域的事件，这将是“常规”。

resource

V1AdministrationEventResource

numOccurrences

字符串

与事件关联的出现次数。当事件可能多次发生时，出现次数会跟踪数量。

int64

lastOccurredAt

日期

指定事件最后一次发生的时间。

日期时间

createdAt

日期

指定事件创建时间。

日期时间

V1AdministrationEventLevel

AdministrationEventLevel 公开了不同级别的事件。

枚举值
ADMINISTRATION_EVENT_LEVEL_UNKNOWN
ADMINISTRATION_EVENT_LEVEL_INFO
ADMINISTRATION_EVENT_LEVEL_SUCCESS
ADMINISTRATION_EVENT_LEVEL_WARNING
ADMINISTRATION_EVENT_LEVEL_ERROR

枚举值

ADMINISTRATION_EVENT_LEVEL_UNKNOWN

ADMINISTRATION_EVENT_LEVEL_INFO

ADMINISTRATION_EVENT_LEVEL_SUCCESS

ADMINISTRATION_EVENT_LEVEL_WARNING

ADMINISTRATION_EVENT_LEVEL_ERROR

V1AdministrationEventResource

Resource 包含与事件关联的资源的所有信息。

字段名称	类型	描述
type	字符串	与事件关联的资源类型。事件可能引用底层资源，例如特定图像。在这种情况下，资源类型将在此处填充。
id	字符串	与事件关联的资源 ID。如果事件引用底层资源，则资源 ID 标识底层资源。资源 ID 是否设置取决于管理事件的上下文，并非保证一定设置。
name	字符串	与事件关联的资源名称。如果事件引用底层资源，则资源名称标识底层资源。资源名称是否设置取决于管理事件的上下文，并非保证一定设置。

字段名称

必填

可空

类型

描述

格式

type

字符串

与事件关联的资源类型。事件可能引用底层资源，例如特定图像。在这种情况下，资源类型将在此处填充。

字符串

与事件关联的资源 ID。如果事件引用底层资源，则资源 ID 标识底层资源。资源 ID 是否设置取决于管理事件的上下文，并非保证一定设置。

name

字符串

与事件关联的资源名称。如果事件引用底层资源，则资源名称标识底层资源。资源名称是否设置取决于管理事件的上下文，并非保证一定设置。

V1AdministrationEventType

AdministrationEventType 公开了不同类型的事件。

枚举值
ADMINISTRATION_EVENT_TYPE_UNKNOWN
ADMINISTRATION_EVENT_TYPE_GENERIC
ADMINISTRATION_EVENT_TYPE_LOG_MESSAGE

枚举值

ADMINISTRATION_EVENT_TYPE_UNKNOWN

ADMINISTRATION_EVENT_TYPE_GENERIC

ADMINISTRATION_EVENT_TYPE_LOG_MESSAGE

V1ListAdministrationEventsResponse

字段名称

必填

可空

类型

描述

格式

events

V1AdministrationEvent 列表