×

POST /v1/policies/from-search

描述

参数

请求体参数

名称 描述 必填 默认值 模式

请求体

V1PolicyFromSearchRequest

X

内容类型

  • application/json

响应

表 1. HTTP 响应代码
代码 消息 数据类型

200

成功的响应。

V1PolicyFromSearchResponse

0

意外的错误响应。

GooglerpcStatus

示例

常用对象引用

GooglerpcStatus

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

code

整数

int32

message

字符串

details

ProtobufAny 列表

PolicyMitreAttackVectors

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

tactic

字符串

techniques

string 列表

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上下文中预期使用的所有类型到二进制文件中。但是,对于使用方案httphttps或无方案的URL,可以选择设置一个类型服务器,将类型URL映射到消息定义,如下所示:* 如果未提供方案,则假定为https。* 对URL的HTTP GET请求必须产生二进制格式的[google.protobuf.Type][]值,或产生错误。* 应用程序允许根据URL缓存查找结果,或将其预编译到二进制文件中以避免任何查找。因此,需要在类型更改时保持二进制兼容性。(使用版本化的类型名称来管理重大更改。)注意:此功能当前在官方protobuf版本中不可用,并且不用于以type.googleapis.com开头的类型URL。截至2023年5月,没有广泛使用的类型服务器实现,也没有计划实现一个。除了httphttps(或空方案)之外的其他方案可能会与特定于实现的语义一起使用。

StorageBooleanOperator

枚举值

OR

AND

StorageEnforcementAction

  • FAIL_KUBE_REQUEST_ENFORCEMENT:只有在启用准入控制Webhook以监听exec和port-forward事件时,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

StorageEventSource

枚举值

NOT_APPLICABLE

DEPLOYMENT_EVENT

AUDIT_LOG_EVENT

StorageExclusion

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

名称

字符串

部署

StorageExclusionDeployment

镜像

StorageExclusionImage

过期时间

日期

日期时间

StorageExclusionDeployment

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

名称

字符串

范围

StorageScope

StorageExclusionImage

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

名称

字符串

StorageLifecycleStage

枚举值

DEPLOY

BUILD

RUNTIME

StoragePolicy

Next tag: 28
字段名称 必填 可为空 类型 描述 格式

ID

字符串

名称

字符串

策略名称。必须唯一。

描述

字符串

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

基本原理

字符串

补救措施

字符串

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

禁用

布尔值

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

类别

string 列表

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

生命周期阶段

StorageLifecycleStage 列表

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

事件源

StorageEventSource

NOT_APPLICABLE、DEPLOYMENT_EVENT、AUDIT_LOG_EVENT、

排除项

StorageExclusion 列表

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

范围

StorageScope 列表

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

严重性

StorageSeverity

UNSET_SEVERITY、LOW_SEVERITY、MEDIUM_SEVERITY、HIGH_SEVERITY、CRITICAL_SEVERITY、

执行操作

StorageEnforcementAction 列表

FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 只有在准入控制Webhook配置为对对象创建/更新强制执行时才生效。FAIL_KUBE_REQUEST_ENFORCEMENT 只有在启用准入控制Webhook以监听 exec 和 port-forward 事件时才生效。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的形式,可通过中心API找到。

上次更新时间

日期

日期时间

SORTName

字符串

仅供内部使用。

SORTLifecycleStage

字符串

仅供内部使用。

SORTEnforcement

布尔值

仅供内部使用。

策略版本

字符串

策略部分

StoragePolicySection 列表

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

MITRE 攻击向量

PolicyMitreAttackVectors 列表

条件锁定

布尔值

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

MITRE 向量锁定

布尔值

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

是否为默认策略

布尔值

只读字段。如果为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、

否定

布尔值

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

StoragePolicyValue 列表

StoragePolicySection

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

部分名称

字符串

策略组

StoragePolicyGroup 列表

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

存储策略来源 (StoragePolicySource)

枚举值

命令式 (IMPERATIVE)

声明式 (DECLARATIVE)

存储策略值 (StoragePolicyValue)

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

值 (value)

字符串

存储范围 (StorageScope)

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

集群 (cluster)

字符串

命名空间 (namespace)

字符串

标签 (label)

存储范围标签 (StorageScopeLabel)

存储范围标签 (StorageScopeLabel)

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

键 (key)

字符串

值 (value)

字符串

存储严重性 (StorageSeverity)

枚举值

未设置严重性 (UNSET_SEVERITY)

低严重性 (LOW_SEVERITY)

中严重性 (MEDIUM_SEVERITY)

高严重性 (HIGH_SEVERITY)

严重性 (CRITICAL_SEVERITY)

V1策略搜索请求 (V1PolicyFromSearchRequest)

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

搜索参数 (searchParams)

字符串

V1策略搜索响应 (V1PolicyFromSearchResponse)

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

策略 (policy)

存储策略 (StoragePolicy)

修改后的搜索词 (alteredSearchTerms)

string 列表

包含嵌套字段 (hasNestedFields)

布尔值