获取告警 - AlertService | API 参考 | Red Hat Advanced Cluster Security for Kubernetes 4.6

名称	描述	必填	默认值	模式
id		X	null

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

AlertDeploymentContainer

字段名称

必填

可为空

类型

描述

格式

image

StorageContainerImage

name

字符串

AlertEnforcement

字段名称

必填

可为空

类型

描述

格式

action

StorageEnforcementAction

UNSET_ENFORCEMENT, SCALE_TO_ZERO_ENFORCEMENT, UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT, KILL_POD_ENFORCEMENT, FAIL_BUILD_ENFORCEMENT, FAIL_KUBE_REQUEST_ENFORCEMENT, FAIL_DEPLOYMENT_CREATE_ENFORCEMENT, FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT,

message

字符串

AlertEntityType

枚举值
UNSET
DEPLOYMENT
CONTAINER_IMAGE
RESOURCE

枚举值

UNSET

DEPLOYMENT

CONTAINER_IMAGE

RESOURCE

AlertProcessViolation

字段名称

必填

可为空

类型

描述

格式

message

字符串

processes

StorageProcessIndicator 列表

AlertResourceResourceType

枚举值
UNKNOWN
SECRETS
CONFIGMAPS
CLUSTER_ROLES
CLUSTER_ROLE_BINDINGS
NETWORK_POLICIES
SECURITY_CONTEXT_CONSTRAINTS
EGRESS_FIREWALLS

枚举值

UNKNOWN

SECRETS

CONFIGMAPS

CLUSTER_ROLES

CLUSTER_ROLE_BINDINGS

NETWORK_POLICIES

SECURITY_CONTEXT_CONSTRAINTS

EGRESS_FIREWALLS

AlertViolation

字段名称

必填

可为空

类型

描述

格式

message

字符串

keyValueAttrs

ViolationKeyValueAttrs

网络流量信息 (networkFlowInfo)

违规网络流量信息 (ViolationNetworkFlowInfo)

类型 (type)

告警违规类型 (AlertViolationType)

GENERIC，K8S_EVENT，NETWORK_FLOW，NETWORK_POLICY，

时间 (time)

日期 (Date)

指示违规时间。此字段与顶层字段“time”不同，顶层字段“time”表示在策略告警多次发生的情况下告警最后一次发生的时间。从 55.0 版本开始，此字段仅为 Kubernetes 事件违规设置，但将来可能不限于此。

日期时间 (date-time)

AlertViolationType

枚举值
GENERIC
K8S_EVENT
NETWORK_FLOW
NETWORK_POLICY

枚举值

GENERIC

K8S_EVENT

NETWORK_FLOW

NETWORK_POLICY

GooglerpcStatus

字段名称

必填

可为空

类型

描述

格式

代码 (code)

整数 (Integer)

int32

message

字符串

详情 (details)

ProtobufAny 列表

KeyValueAttrsKeyValueAttr

字段名称

必填

可为空

类型

描述

格式

键 (key)

字符串

值 (value)

字符串

NetworkFlowInfoEntity

字段名称

必填

可为空

类型

描述

格式

name

字符串

实体类型 (entityType)

StorageNetworkEntityInfoType

UNKNOWN_TYPE，DEPLOYMENT，INTERNET，LISTEN_ENDPOINT，EXTERNAL_SOURCE，INTERNAL_ENTITIES，

部署命名空间 (deploymentNamespace)

字符串

部署类型 (deploymentType)

字符串

端口 (port)

整数 (Integer)

int32

PolicyMitreAttackVectors

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

策略 (tactic)

字符串

技术 (techniques)

string 列表

ProcessSignalLineageInfo

字段名称

必填

可为空

类型

描述

格式

父级UID (parentUid)

长整数 (Long)

int64

父级执行文件路径 (parentExecFilePath)

字符串

ProtobufAny

Any 包含任意序列化的协议缓冲区消息以及描述序列化消息类型的 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/资源名称。此字符串必须包含至少一个“/”字符。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/资源名称。此字符串必须包含至少一个“/”字符。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（或空方案）以外的方案，并具有特定于实现的语义。

StorageAlert

Next available tag: 24

字段名称

必填

可为空

类型

描述

格式

id

字符串

策略 (policy)

StoragePolicy

生命周期阶段 (lifecycleStage)

StorageLifecycleStage

DEPLOY，BUILD，RUNTIME，

集群 ID (clusterId)

字符串

集群名称 (clusterName)

字符串

命名空间 (namespace)

字符串

命名空间 ID (namespaceId)

字符串

部署 (deployment)

StorageAlertDeployment

image

StorageContainerImage

资源 (resource)

StorageAlertResource

违规 (violations)

AlertViolation 列表

对于运行时阶段告警，最多保留 40 个违规。

进程违规 (processViolation)

AlertProcessViolation

执行 (enforcement)

AlertEnforcement

时间 (time)

日期 (Date)

日期时间 (date-time)

首次发生 (firstOccurred)

日期 (Date)

日期时间 (date-time)

已解决时间 (resolvedAt)

日期 (Date)

告警已解决的时间。仅当 ViolationState 为 RESOLVED 时设置。

日期时间 (date-time)

状态 (state)

StorageViolationState

ACTIVE，SNOOZED，RESOLVED，ATTEMPTED，

休眠至 (snoozeTill)

日期 (Date)

日期时间 (date-time)

平台组件 (platformComponent)

布尔值 (Boolean)

实体类型 (entityType)

AlertEntityType

UNSET，DEPLOYMENT，CONTAINER_IMAGE，RESOURCE，

StorageAlertDeployment

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

id

字符串

name

字符串

类型 (type)

字符串

命名空间 (namespace)

字符串

此字段必须在 Alert 中重复，用于范围管理和搜索。

命名空间 ID (namespaceId)

字符串

此字段必须在 Alert 中重复，用于范围管理和搜索。

标签 (labels)

string 映射

集群 ID (clusterId)

字符串

此字段必须在 Alert 中重复，用于范围管理和搜索。

集群名称 (clusterName)

字符串

此字段必须在 Alert 中重复，用于范围管理和搜索。

容器 (containers)

AlertDeploymentContainer 列表

注释 (annotations)

string 映射

非活动 (inactive)

布尔值 (Boolean)

StorageAlertResource

Represents an alert on a kubernetes resource other than a deployment (configmaps, secrets, etc.)

字段名称

必填

可为空

类型

描述

格式

资源类型 (resourceType)

AlertResourceResourceType

UNKNOWN，SECRETS，CONFIGMAPS，CLUSTER_ROLES，CLUSTER_ROLE_BINDINGS，NETWORK_POLICIES，SECURITY_CONTEXT_CONSTRAINTS，EGRESS_FIREWALLS，

name

字符串

集群 ID (clusterId)

字符串

此字段必须在 Alert 中重复，用于范围管理和搜索。

集群名称 (clusterName)

字符串

此字段必须在 Alert 中重复，用于范围管理和搜索。

命名空间 (namespace)

字符串

此字段必须在 Alert 中重复，用于范围管理和搜索。

命名空间 ID (namespaceId)

字符串

此字段必须在 Alert 中重复，用于范围管理和搜索。

StorageBooleanOperator

枚举值
OR
AND

枚举值

OR

AND

StorageContainerImage

Next tag: 12

字段名称

必填

可为空

类型

描述

格式

id

字符串

name

StorageImageName

不可拉取 (notPullable)

布尔值 (Boolean)

是集群本地 (isClusterLocal)

布尔值 (Boolean)

StorageEnforcementAction

FAIL_KUBE_REQUEST_ENFORCEMENT：只有在启用准入控制 Webhook 以侦听 exec 和端口转发事件时，FAIL_KUBE_REQUEST_ENFORCEMENT 才会生效。
FAIL_DEPLOYMENT_CREATE_ENFORCEMENT：只有在配置准入控制 Webhook 以强制执行对象创建时，FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 才会生效。
FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT：只有在配置准入控制 Webhook 以强制执行对象更新时，FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT 才会生效。

枚举值
UNSET_ENFORCEMENT
SCALE_TO_ZERO_ENFORCEMENT
UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT
KILL_POD_ENFORCEMENT
FAIL_BUILD_ENFORCEMENT
FAIL_KUBE_REQUEST_ENFORCEMENT
FAIL_DEPLOYMENT_CREATE_ENFORCEMENT
FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT

枚举值

UNSET_ENFORCEMENT

SCALE_TO_ZERO_ENFORCEMENT

UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT

KILL_POD_ENFORCEMENT

FAIL_BUILD_ENFORCEMENT

FAIL_KUBE_REQUEST_ENFORCEMENT

FAIL_DEPLOYMENT_CREATE_ENFORCEMENT

FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT

StorageEventSource

枚举值
NOT_APPLICABLE
DEPLOYMENT_EVENT
AUDIT_LOG_EVENT

枚举值

NOT_APPLICABLE

DEPLOYMENT_EVENT

AUDIT_LOG_EVENT

StorageExclusion

字段名称

必填

可为空

类型

描述

格式

name

字符串

部署 (deployment)

StorageExclusionDeployment

image

StorageExclusionImage

过期时间 (expiration)

日期 (Date)

日期时间 (date-time)

StorageExclusionDeployment

字段名称

必填

可为空

类型

描述

格式

name

字符串

范围 (scope)

StorageScope

StorageExclusionImage

字段名称

必填

可为空

类型

描述

格式

name

字符串

StorageImageName

字段名称

必填

可为空

类型

描述

格式

注册表 (registry)

字符串

远程 (remote)

字符串

标签 (tag)

字符串

全名 (fullName)

字符串

StorageL4Protocol

枚举值
L4_PROTOCOL_UNKNOWN
L4_PROTOCOL_TCP
L4_PROTOCOL_UDP
L4_PROTOCOL_ICMP
L4_PROTOCOL_RAW
L4_PROTOCOL_SCTP
L4_PROTOCOL_ANY

枚举值

L4_PROTOCOL_UNKNOWN

L4_PROTOCOL_TCP

L4_PROTOCOL_UDP

L4_PROTOCOL_ICMP

L4_PROTOCOL_RAW

L4_PROTOCOL_SCTP

L4_PROTOCOL_ANY

StorageLifecycleStage

枚举值
DEPLOY
BUILD
RUNTIME

枚举值

DEPLOY

BUILD

RUNTIME

StorageNetworkEntityInfoType

INTERNAL_ENTITIES：INTERNAL_ENTITIES 用于将所有内部实体分组到单个网络图节点下

枚举值
UNKNOWN_TYPE（未知类型）
DEPLOYMENT
INTERNET（互联网）
LISTEN_ENDPOINT（监听端点）
EXTERNAL_SOURCE（外部来源）
INTERNAL_ENTITIES（内部实体）

枚举值

UNKNOWN_TYPE（未知类型）

DEPLOYMENT

INTERNET（互联网）

LISTEN_ENDPOINT（监听端点）

EXTERNAL_SOURCE（外部来源）

INTERNAL_ENTITIES（内部实体）

StoragePolicy

Next tag: 28

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

id

字符串

name

字符串

策略名称。必须唯一。

描述

字符串

此策略的自由格式文本描述。

基本原理

字符串

补救措施

字符串

描述如何补救此策略的违规。

禁用

布尔值 (Boolean)

切换此策略是否执行并主动触发警报。

类别

string 列表

此策略所属的类别列表。类别名称必须已存在于 Central 中。

生命周期阶段

StorageLifecycleStage 列表

描述此策略适用的策略生命周期阶段。选项包括 DEPLOY、BUILD 和 RUNTIME。

事件源

StorageEventSource

NOT_APPLICABLE、DEPLOYMENT_EVENT、AUDIT_LOG_EVENT、

排除项

StorageExclusion 列表

定义应从此策略中排除的部署或镜像。

范围 (scope)

StorageScope 列表

定义应包含在此策略中的集群、命名空间和部署。未定义范围包括所有内容。

严重性

StorageSeverity

UNSET_SEVERITY、LOW_SEVERITY、MEDIUM_SEVERITY、HIGH_SEVERITY、CRITICAL_SEVERITY、

执行操作

StorageEnforcementAction 列表

FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 仅在准入控制 Webhook 配置为对对象创建/更新进行强制执行时才生效。FAIL_KUBE_REQUEST_ENFORCEMENT 仅在准入控制 Webhook 启用以监听 exec 和端口转发事件时才生效。FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT 仅在准入控制 Webhook 配置为对对象更新进行强制执行时才生效。列出在识别此策略的违规时要采取的执行操作。可能的值为 UNSET_ENFORCEMENT、SCALE_TO_ZERO_ENFORCEMENT、UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT、KILL_POD_ENFORCEMENT、FAIL_BUILD_ENFORCEMENT、FAIL_KUBE_REQUEST_ENFORCEMENT、FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 和 FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT。

通知程序

string 列表

应在识别此策略的违规时触发的通知程序 ID 列表。ID 应采用 UUID 格式，并可通过 Central API 找到。

上次更新

日期 (Date)

日期时间 (date-time)

SORTName

字符串

仅供内部使用。

SORTLifecycleStage

字符串

仅供内部使用。

SORTEnforcement

布尔值 (Boolean)

仅供内部使用。

策略版本

字符串

策略部分

StoragePolicySection 列表

PolicySections 定义此策略的违规条件。

MITRE 攻击向量

PolicyMitreAttackVectors 列表

criteriaLocked

布尔值 (Boolean)

只读字段。如果为 true，则策略的条件字段将被设置为只读。

mitreVectorsLocked

布尔值 (Boolean)

只读字段。如果为 true，则策略的 MITRE ATT&CK 字段将被设置为只读。

isDefault

布尔值 (Boolean)

只读字段。如果为 true，则表示该策略是默认策略；如果为 false，则表示该策略是自定义策略。

来源

StoragePolicySource

IMPERATIVE、DECLARATIVE、

StoragePolicyGroup

字段名称

必填

可为空

类型

描述

格式

字段名称

字符串

定义此 PolicyGroup 评估的部署或镜像上的哪个字段。有关可能值的完整列表，请参阅 http://docs.openshift.org.cn/acs/operating/manage-security-policies.html#policy-criteria_manage-security-policies。

布尔运算符

StorageBooleanOperator

OR、AND、

否定

布尔值 (Boolean)

确定此 PolicyGroup 的评估是否被否定。默认为 false。

值

StoragePolicyValue 列表

StoragePolicySection

字段名称

必填

可为空

类型

描述

格式

节名称

字符串

策略组

StoragePolicyGroup 列表

构成此部分的策略组集。每个组都可以被视为单个条件。

StoragePolicySource

枚举值
IMPERATIVE（命令式）
DECLARATIVE（声明式）

枚举值

IMPERATIVE（命令式）

DECLARATIVE（声明式）

StoragePolicyValue

字段名称

必填

可为空

类型

描述

格式

值 (value)

字符串

StorageProcessIndicator

Next available tag: 13

字段名称

必填

可为空

类型

描述

格式

id

字符串

部署 ID

字符串

容器名称

字符串

Pod ID

字符串

Pod UID

字符串

信号

StorageProcessSignal

集群 ID (clusterId)

字符串

命名空间 (namespace)

字符串

容器启动时间

日期 (Date)

日期时间 (date-time)

镜像 ID

字符串

StorageProcessSignal

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

id

字符串

用于标识消息的唯一 UUID。我们将其放在此处而不是顶层，因为我们希望每条消息都是自包含的。

容器 ID

字符串

时间 (time)

日期 (Date)

日期时间 (date-time)

name

字符串

参数

字符串

执行文件路径

字符串

PID

长整数 (Long)

int64

UID

长整数 (Long)

int64

GID

长整数 (Long)

int64

谱系

string 列表

抓取

布尔值 (Boolean)

谱系信息

ProcessSignalLineageInfo 列表

StorageScope

字段名称

必填

可为空

类型

描述

格式

集群

字符串

命名空间 (namespace)

字符串

标签

StorageScopeLabel

字段名称

必填

可为空

类型

描述

格式

键 (key)

字符串

值 (value)

字符串

StorageSeverity

枚举值
UNSET_SEVERITY（未设置严重性）
LOW_SEVERITY（低严重性）
MEDIUM_SEVERITY（中严重性）
HIGH_SEVERITY（高严重性）
CRITICAL_SEVERITY（严重严重性）

枚举值

UNSET_SEVERITY（未设置严重性）

LOW_SEVERITY（低严重性）

MEDIUM_SEVERITY（中严重性）

HIGH_SEVERITY（高严重性）

CRITICAL_SEVERITY（严重严重性）

StorageViolationState

枚举值
ACTIVE（活动）
SNOOZED（已暂停）
RESOLVED（已解决）
ATTEMPTED（已尝试）

枚举值

ACTIVE（活动）

SNOOZED（已暂停）

RESOLVED（已解决）

ATTEMPTED（已尝试）

ViolationKeyValueAttrs

字段名称

必填

可为空

类型

描述

格式

属性

KeyValueAttrsKeyValueAttr 列表

ViolationNetworkFlowInfo

字段名称

必填

可为空

类型

描述

格式

协议

StorageL4Protocol

L4_PROTOCOL_UNKNOWN、L4_PROTOCOL_TCP、L4_PROTOCOL_UDP、L4_PROTOCOL_ICMP、L4_PROTOCOL_RAW、L4_PROTOCOL_SCTP、L4_PROTOCOL_ANY、

来源

NetworkFlowInfoEntity

目标

NetworkFlowInfoEntity

GetAlert

描述

参数

路径参数

返回类型

内容类型

响应

示例

常用对象引用

AlertDeploymentContainer

AlertEnforcement

AlertEntityType

AlertProcessViolation

AlertResourceResourceType

AlertViolation

AlertViolationType

GooglerpcStatus

KeyValueAttrsKeyValueAttr

NetworkFlowInfoEntity

PolicyMitreAttackVectors

ProcessSignalLineageInfo

ProtobufAny

JSON 表示

StorageAlert

StorageAlertDeployment

StorageAlertResource

StorageBooleanOperator

StorageContainerImage

StorageEnforcementAction

StorageEventSource

StorageExclusion

StorageExclusionDeployment

StorageExclusionImage

StorageImageName

StorageL4Protocol

StorageLifecycleStage

StorageNetworkEntityInfoType

StoragePolicy

StoragePolicyGroup

StoragePolicySection

StoragePolicySource

StoragePolicyValue

StorageProcessIndicator

StorageProcessSignal

StorageScope

StorageScopeLabel

StorageSeverity

StorageViolationState

ViolationKeyValueAttrs

ViolationNetworkFlowInfo