主页
产品
Red Hat Advanced Cluster Security for Kubernetes
4.6
API 参考
第 1 章版本 v1

第 1 章版本 v1

1.1. AdministrationEventService

1.1.1. ListAdministrationEvents

GET /v1/administration/events

List managingEvents 会在根据请求的字段过滤后返回事件列表。

1.1.1.1. 描述

1.1.1.2. 参数

1.1.1.2.1. 查询参数

Name	描述	必填	default
pagination.limit		-	null
pagination.offset		-	null
pagination.sortOption.field		-	null
pagination.sortOption.reversed		-	null
pagination.sortOption.aggregateBy.aggrFunc		-	UNSET
pagination.sortOption.aggregateBy.distinct		-	null
filter.from	在特定时间戳后，使用 last_occurred_at 匹配事件，即较低边界。	-	null
filter.until	在特定时间戳前，使用 last_occurred_at 匹配事件，如上个边界。	-	null
filter.domain	匹配来自特定域的事件。`字符串`	-	null
filter.resourceType	匹配与特定资源类型关联的事件。`字符串`	-	null
filter.type	根据事件类型匹配事件。`字符串`	-	null
filter.level	根据事件级别匹配。`字符串`	-	null

1.1.1.3. 返回类型

V1ListAdministrationEventsResponse

1.1.1.4. 内容类型

application/json

1.1.1.5. 响应

表 1.1. HTTP 响应代码
代码	消息	datatype
200	成功响应。	V1ListAdministrationEventsResponse
0	意外错误响应。	GooglerpcStatus

1.1.1.6. Samples

1.1.1.7. 常规对象参考

1.1.1.7.1. GooglerpcStatus

字段名称	类型	格式
code	整数	int32
message	字符串
详情	ProtobufAny列表

1.1.1.7.2. ProtobufAny

any 包含任意序列化协议缓冲区消息，以及一个描述序列化消息的类型的 URL。

protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持，或者对 Any 类型的其他生成的方法提供其他生成的方法。

示例 1: Pack 并在 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/x/y.z"。

1.1.1.7.2.1. JSON 表示

any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示，以及包含类型 URL 的附加字段 @type。Example:

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 表示法，则该表示将被嵌入一个字段值，该值 除 @type 字段外还包含自定义 JSON。示例（用于消息 [google.protobuf.Duration][]）：

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

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

1.1.1.7.3. V1AdministrationEvent

AdministrationEvents 是 Central 发出的管理事件。它们用于为用户提供异步后台任务的透明度。事件是 Central 的系统健康视图的一部分。

字段名称	类型	描述	格式
id	字符串	事件的 UUID。
type	V1AdministrationEventType		管理_EVENT_TYPE_UNKNOWN, MANAGEMENT_EVENT_TYPE_GENERIC, MANAGEMENT_EVENT_TYPE_LOG_MESSAGE,
level	V1AdministrationEventLevel		MANAGEMENT_EVENT_LEVEL_UNKNOWN, MANAGEMENT_EVENT_LEVEL_INFO, MANAGEMENT_EVENT_LEVEL_SUCCESS, MANAGEMENT_EVENT_LEVEL_WARNING, MANAGEMENT_EVENT_LEVEL_ERROR,
message	字符串	与事件关联的消息。消息可能包含此特定事件的详细信息。
提示	字符串	与事件关联的提示。hint 可根据事件类型包含不同的信息。它可以包含用于解析事件或信息提示的说明。
domain	字符串	与事件关联的域。事件的域概述了从中创建事件的功能域。例如，这可能是 \"Image Scanning\"。如果事件无法绑定到特定域，这将是 \"General\"。
resource	V1AdministrationEventResource
numOccurrences	字符串	与事件关联的发生时间。当事件可能会多次发生时，出现的事件会跟踪这个数量。	int64
lastOccurredAt	Date	指定事件最后一次发生的时间。	date-time
createdAt	Date	指定事件创建的时间。	date-time

1.1.1.7.4. V1AdministrationEventLevel

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

Enum 值
ADMIN_EVENT_LEVEL_UNKNOWN
ADMIN_EVENT_LEVEL_INFO
ADMIN_EVENT_LEVEL_SUCCESS
ADMIN_EVENT_LEVEL_WARNING
ADMIN_EVENT_LEVEL_ERROR

1.1.1.7.5. V1AdministrationEventResource

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

字段名称	类型	描述
type	字符串	与事件关联的资源类型。事件可能会引用特定镜像等底层资源。在这种情况下，资源类型将填写在此处。
id	字符串	与事件关联的资源 ID。如果事件引用底层资源，则资源 ID 会标识底层资源。根据管理事件的上下文，无法保证设置资源 ID。
name	字符串	与事件关联的资源名称。如果事件引用底层资源，则资源名称会标识底层资源。根据管理事件的上下文，无法保证设置资源名称。

1.1.1.7.6. V1AdministrationEventType

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

Enum 值
ADMIN_EVENT_TYPE_UNKNOWN
ADMINISTRATION_EVENT_TYPE_GENERIC
ADMIN_EVENT_TYPE_LOG_MESSAGE

1.1.1.7.7. V1ListAdministrationEventsResponse

字段名称	必填	nullable	类型	描述	格式
events			V1 managementEvent列表

1.1.2. GetAdministrationEvent

GET /v1/administration/events/{id}

Get administrationEvent 通过 ID 检索事件.

1.1.2.1. 描述

1.1.2.2. 参数

1.1.2.2.1. 路径参数

Name	描述	必填	default	pattern
id		X	null

1.1.2.3. 返回类型

V1GetAdministrationEventResponse

1.1.2.4. 内容类型

application/json

1.1.2.5. 响应

表 1.2. HTTP 响应代码
代码	消息	datatype
200	成功响应。	V1GetAdministrationEventResponse
0	意外错误响应。	GooglerpcStatus

1.1.2.6. Samples

1.1.2.7. 常规对象参考

1.1.2.7.1. GooglerpcStatus

字段名称	类型	格式
code	整数	int32
message	字符串
详情	ProtobufAny列表

1.1.2.7.2. ProtobufAny

any 包含任意序列化协议缓冲区消息，以及一个描述序列化消息的类型的 URL。

protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持，或者对 Any 类型的其他生成的方法提供其他生成的方法。

示例 1: Pack 并在 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 {
  ...
}

1.1.2.7.2.1. JSON 表示

any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示，以及包含类型 URL 的附加字段 @type。Example:

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

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

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

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

1.1.2.7.3. V1AdministrationEvent

AdministrationEvents 是 Central 发出的管理事件。它们用于为用户提供异步后台任务的透明度。事件是 Central 的系统健康视图的一部分。

字段名称	类型	描述	格式
id	字符串	事件的 UUID。
type	V1AdministrationEventType		管理_EVENT_TYPE_UNKNOWN, MANAGEMENT_EVENT_TYPE_GENERIC, MANAGEMENT_EVENT_TYPE_LOG_MESSAGE,
level	V1AdministrationEventLevel		MANAGEMENT_EVENT_LEVEL_UNKNOWN, MANAGEMENT_EVENT_LEVEL_INFO, MANAGEMENT_EVENT_LEVEL_SUCCESS, MANAGEMENT_EVENT_LEVEL_WARNING, MANAGEMENT_EVENT_LEVEL_ERROR,
message	字符串	与事件关联的消息。消息可能包含此特定事件的详细信息。
提示	字符串	与事件关联的提示。hint 可根据事件类型包含不同的信息。它可以包含用于解析事件或信息提示的说明。
domain	字符串	与事件关联的域。事件的域概述了从中创建事件的功能域。例如，这可能是 \"Image Scanning\"。如果事件无法绑定到特定域，这将是 \"General\"。
resource	V1AdministrationEventResource
numOccurrences	字符串	与事件关联的发生时间。当事件可能会多次发生时，出现的事件会跟踪这个数量。	int64
lastOccurredAt	Date	指定事件最后一次发生的时间。	date-time
createdAt	Date	指定事件创建的时间。	date-time

1.1.2.7.4. V1AdministrationEventLevel

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

Enum 值
ADMIN_EVENT_LEVEL_UNKNOWN
ADMIN_EVENT_LEVEL_INFO
ADMIN_EVENT_LEVEL_SUCCESS
ADMIN_EVENT_LEVEL_WARNING
ADMIN_EVENT_LEVEL_ERROR

1.1.2.7.5. V1AdministrationEventResource

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

字段名称	类型	描述
type	字符串	与事件关联的资源类型。事件可能会引用特定镜像等底层资源。在这种情况下，资源类型将填写在此处。
id	字符串	与事件关联的资源 ID。如果事件引用底层资源，则资源 ID 会标识底层资源。根据管理事件的上下文，无法保证设置资源 ID。
name	字符串	与事件关联的资源名称。如果事件引用底层资源，则资源名称会标识底层资源。根据管理事件的上下文，无法保证设置资源名称。

1.1.2.7.6. V1AdministrationEventType

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

Enum 值
ADMIN_EVENT_TYPE_UNKNOWN
ADMINISTRATION_EVENT_TYPE_GENERIC
ADMIN_EVENT_TYPE_LOG_MESSAGE

1.1.2.7.7. V1GetAdministrationEventResponse

字段名称	必填	nullable	类型	描述	格式
event			V1AdministrationEvent

1.1.3. CountAdministrationEvents

GET /v1/count/administration/events

Count administrationEvents 在根据请求字段过滤后返回事件数。

1.1.3.1. 描述

1.1.3.2. 参数

1.1.3.2.1. 查询参数

Name	描述	必填	default
filter.from	在特定时间戳后，使用 last_occurred_at 匹配事件，即较低边界。	-	null
filter.until	在特定时间戳前，使用 last_occurred_at 匹配事件，如上个边界。	-	null
filter.domain	匹配来自特定域的事件。`字符串`	-	null
filter.resourceType	匹配与特定资源类型关联的事件。`字符串`	-	null
filter.type	根据事件类型匹配事件。`字符串`	-	null
filter.level	根据事件级别匹配。`字符串`	-	null

1.1.3.3. 返回类型

V1CountAdministrationEventsResponse

1.1.3.4. 内容类型

application/json

1.1.3.5. 响应

表 1.3. HTTP 响应代码
代码	消息	datatype
200	成功响应。	V1CountAdministrationEventsResponse
0	意外错误响应。	GooglerpcStatus

1.1.3.6. Samples

1.1.3.7. 常规对象参考

1.1.3.7.1. GooglerpcStatus

字段名称	类型	格式
code	整数	int32
message	字符串
详情	ProtobufAny列表

1.1.3.7.2. ProtobufAny

any 包含任意序列化协议缓冲区消息，以及一个描述序列化消息的类型的 URL。

protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持，或者对 Any 类型的其他生成的方法提供其他生成的方法。

示例 1: Pack 并在 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 {
  ...
}

1.1.3.7.2.1. JSON 表示

any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示，以及包含类型 URL 的附加字段 @type。Example:

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

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

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

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

1.1.3.7.3. V1CountAdministrationEventsResponse

字段名称	必填	nullable	类型	描述	格式
æ•°é‡�			整数	过滤和重复数据删除后事件总数。	int32

返回顶部

第 1 章 版本 v1

1.1. AdministrationEventService

1.1.1. ListAdministrationEvents

1.1.1.1. 描述

1.1.1.2. 参数

1.1.1.2.1. 查询参数

1.1.1.3. 返回类型

1.1.1.4. 内容类型

1.1.1.5. 响应

1.1.1.6. Samples

1.1.1.7. 常规对象参考

1.1.1.7.1. GooglerpcStatus

1.1.1.7.2. ProtobufAny

1.1.1.7.2.1. JSON 表示

1.1.1.7.3. V1AdministrationEvent

1.1.1.7.4. V1AdministrationEventLevel

1.1.1.7.5. V1AdministrationEventResource

1.1.1.7.6. V1AdministrationEventType

1.1.1.7.7. V1ListAdministrationEventsResponse

1.1.2. GetAdministrationEvent

1.1.2.1. 描述

1.1.2.2. 参数

1.1.2.2.1. 路径参数

1.1.2.3. 返回类型

1.1.2.4. 内容类型

1.1.2.5. 响应

1.1.2.6. Samples

1.1.2.7. 常规对象参考

1.1.2.7.1. GooglerpcStatus

1.1.2.7.2. ProtobufAny

1.1.2.7.2.1. JSON 表示

1.1.2.7.3. V1AdministrationEvent

1.1.2.7.4. V1AdministrationEventLevel

1.1.2.7.5. V1AdministrationEventResource

1.1.2.7.6. V1AdministrationEventType

1.1.2.7.7. V1GetAdministrationEventResponse

1.1.3. CountAdministrationEvents

1.1.3.1. 描述

1.1.3.2. 参数

1.1.3.2.1. 查询参数

1.1.3.3. 返回类型

1.1.3.4. 内容类型

1.1.3.5. 响应

1.1.3.6. Samples

1.1.3.7. 常规对象参考

1.1.3.7.1. GooglerpcStatus

1.1.3.7.2. ProtobufAny

1.1.3.7.2.1. JSON 表示

1.1.3.7.3. V1CountAdministrationEventsResponse

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

第 1 章版本 v1