1.45. PolicyService
1.45.1. CancelDryRunJob
DELETE /v1/policies/dryrunjob/{jobId}
1.45.1.1. 描述
1.45.1.2. 参数
1.45.1.2.1. 路径参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
jobId | X | null |
1.45.1.3. 返回类型
对象
1.45.1.4. 内容类型
- application/json
1.45.1.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 |
|
0 | 意外错误响应。 |
1.45.1.6. Samples
1.45.1.7. 常规对象参考
1.45.1.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.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.45.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 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.2. QueryDryRunJobStatus
GET /v1/policies/dryrunjob/{jobId}
1.45.2.1. 描述
1.45.2.2. 参数
1.45.2.2.1. 路径参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
jobId | X | null |
1.45.2.3. 返回类型
1.45.2.4. 内容类型
- application/json
1.45.2.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 | |
0 | 意外错误响应。 |
1.45.2.6. Samples
1.45.2.7. 常规对象参考
1.45.2.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.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 { ... }
默认情况下,protobuf 库提供的软件包方法将使用 'type.googleapis.com/full.type.name' 作为类型 URL,解包方法只使用类型 URL 中的完全限定类型名称,如 "foo.bar.com/x/x/y.z"。
1.45.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> }
如果嵌入式消息类型是知名且具有自定义 JSON 表示法,则该表示将被嵌入一个字段值,该值
除 @type
字段外还包含自定义 JSON。示例(用于消息 [google.protobuf.Duration][]):
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
@type | 字符串 |
唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.2.7.3. V1DryRunJobStatusResponse
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
待定 | 布尔值 | ||||
result |
1.45.2.7.4. V1DryRunResponse
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
alerts |
1.45.2.7.5. V1DryRunResponseAlert
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
部署 | 字符串 | ||||
违反情况 |
|
1.45.3. SubmitDryRunPolicyJob
POST /v1/policies/dryrunjob
1.45.3.1. 描述
1.45.3.2. 参数
1.45.3.2.1. 正文参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
正文(body) | X |
1.45.3.3. 返回类型
1.45.3.4. 内容类型
- application/json
1.45.3.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 | |
0 | 意外错误响应。 |
1.45.3.6. Samples
1.45.3.7. 常规对象参考
1.45.3.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.3.7.2. PolicyMitreAttackVectors
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
Tactic | 字符串 | ||||
技术 |
|
1.45.3.7.3. 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.45.3.7.3.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 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.3.7.4. StorageBooleanOperator
Enum 值 |
---|
或者 |
和 |
1.45.3.7.5. StorageEnforcementAction
- FAIL_KUBE_REQUEST_ENFORCEMENT: FAIL_KUBE_REQUEST_ENFORCEMENT 仅在启用了准入控制 webhook 来侦听 exec 和 port-forward 事件时生效。
- FAIL_DEPLOYMENT_CREATE_ENFORCEMENT: FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 仅在将准入控制 webhook 配置为在对象上创建时生效。
- FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT: FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT 仅在将准入控制 webhook 配置为强制实施对象更新时才会生效。
Enum 值 |
---|
SET_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 |
1.45.3.7.6. StorageEventSource
Enum 值 |
---|
NOT_APPLICABLE |
DEPLOYMENT_EVENT |
AUDIT_LOG_EVENT |
1.45.3.7.7. StorageExclusion
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
部署 | |||||
image | |||||
过期 | Date | date-time |
1.45.3.7.8. StorageExclusionDeployment
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
scope |
1.45.3.7.9. StorageExclusionImage
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 |
1.45.3.7.10. StorageLifecycleStage
Enum 值 |
---|
DEPLOY |
BUILD |
RUNTIME |
1.45.3.7.11. StoragePolicy
Next tag: 28
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
name | 字符串 | 策略的名称。必须是唯一的。 | |||
description | 字符串 | 此策略的自由格式文本描述。 | |||
rationale | 字符串 | ||||
补救 | 字符串 | 描述如何修复此策略的违反情况。 | |||
disabled | 布尔值 | 切换此策略是否正在执行并主动触发警报。 | |||
类别 |
| 此策略属于的类别列表。类别名称必须已存在于 Central 中。 | |||
lifecycleStages | 描述此策略应用到哪些策略生命周期阶段。选择是 DEPLOY、BUILD 和 RUNTIME。 | ||||
eventSource | NOT_APPLICABLE, DEPLOYMENT_EVENT, AUDIT_LOG_EVENT, | ||||
排除 | 定义应排除在此策略中的部署或镜像。 | ||||
scope | 定义此策略中包含的集群、命名空间和部署。未定义的范围包括所有内容。 | ||||
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
enforcementActions | 只有在将准入控制 Webhook 配置为对象创建/更新时,FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 才会生效。只有在启用了准入控制 Webhook 来侦听 exec 和 port-forward 事件时,FAIL_KUBE_REQUEST_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_POD_ENFORCEMENT, FAIL_BUILD_ENFORCEMENT,FAILS_DEPLOYMENT_UPDATE_ENFORCEMENT. | ||||
通知程序 |
| 确定此策略时应触发的通知程序 ID 列表。ID 应为 UUID 的形式,并通过 Central API 找到。 | |||
lastUpdated | Date | date-time | |||
sORTName | 字符串 | 仅供内部使用。 | |||
SORTLifecycleStage | 字符串 | 仅供内部使用。 | |||
SORTEnforcement | 布尔值 | 仅供内部使用。 | |||
policyVersion | 字符串 | ||||
policySections | PolicySections 定义此策略的违反标准。 | ||||
mitreAttackVectors | |||||
criteriaLocked | 布尔值 | 只读字段。如果为 true,策略的条件字段会以只读方式呈现。 | |||
mitreVectorsLocked | 布尔值 | 只读字段。如果为 true,则策略的 MITRE ATT&CK 字段以只读方式呈现。 | |||
isDefault | 布尔值 | 只读字段。如果为 false,表示策略是默认策略,如果为 false,则表示策略为默认策略。 | |||
source | 需要的声明, |
1.45.3.7.12. StoragePolicyGroup
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
fieldName | 字符串 | 定义此 PolicyGroup 评估的部署或镜像上的哪个字段。有关可能值的完整列表,请参阅 https://docs.openshift.com/acs/operating/manage-security-policies.html#policy-criteria_manage-security-policies。 | |||
booleanOperator | 或者,以及. | ||||
negate | 布尔值 | 确定此 PolicyGroup 的评估是否被否定。默认值为 false。 | |||
values |
1.45.3.7.13. StoragePolicySection
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
sectionName | 字符串 | ||||
policyGroups | 组成本节的策略组集合。每个组都可以被视为单独的条件。 |
1.45.3.7.14. StoragePolicySource
Enum 值 |
---|
IMPERATIVE |
DECLARATIVE |
1.45.3.7.15. StoragePolicyValue
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
value | 字符串 |
1.45.3.7.16. StorageScope
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
cluster | 字符串 | ||||
namespace | 字符串 | ||||
label |
1.45.3.7.17. StorageScopeLabel
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
1.45.3.7.18. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.45.3.7.19. V1JobId
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
jobId | 字符串 |
1.45.4. DryRunPolicy
POST /v1/policies/dryrun
DryRunPolicy 评估给定的策略,并在不创建策略的情况下返回任何警报。
1.45.4.1. 描述
1.45.4.2. 参数
1.45.4.2.1. 正文参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
正文(body) | X |
1.45.4.3. 返回类型
1.45.4.4. 内容类型
- application/json
1.45.4.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 | |
0 | 意外错误响应。 |
1.45.4.6. Samples
1.45.4.7. 常规对象参考
1.45.4.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.4.7.2. PolicyMitreAttackVectors
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
Tactic | 字符串 | ||||
技术 |
|
1.45.4.7.3. 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.45.4.7.3.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 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.4.7.4. StorageBooleanOperator
Enum 值 |
---|
或者 |
和 |
1.45.4.7.5. StorageEnforcementAction
- FAIL_KUBE_REQUEST_ENFORCEMENT: FAIL_KUBE_REQUEST_ENFORCEMENT 仅在启用了准入控制 webhook 来侦听 exec 和 port-forward 事件时生效。
- FAIL_DEPLOYMENT_CREATE_ENFORCEMENT: FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 仅在将准入控制 webhook 配置为在对象上创建时生效。
- FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT: FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT 仅在将准入控制 webhook 配置为强制实施对象更新时才会生效。
Enum 值 |
---|
SET_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 |
1.45.4.7.6. StorageEventSource
Enum 值 |
---|
NOT_APPLICABLE |
DEPLOYMENT_EVENT |
AUDIT_LOG_EVENT |
1.45.4.7.7. StorageExclusion
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
部署 | |||||
image | |||||
过期 | Date | date-time |
1.45.4.7.8. StorageExclusionDeployment
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
scope |
1.45.4.7.9. StorageExclusionImage
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 |
1.45.4.7.10. StorageLifecycleStage
Enum 值 |
---|
DEPLOY |
BUILD |
RUNTIME |
1.45.4.7.11. StoragePolicy
Next tag: 28
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
name | 字符串 | 策略的名称。必须是唯一的。 | |||
description | 字符串 | 此策略的自由格式文本描述。 | |||
rationale | 字符串 | ||||
补救 | 字符串 | 描述如何修复此策略的违反情况。 | |||
disabled | 布尔值 | 切换此策略是否正在执行并主动触发警报。 | |||
类别 |
| 此策略属于的类别列表。类别名称必须已存在于 Central 中。 | |||
lifecycleStages | 描述此策略应用到哪些策略生命周期阶段。选择是 DEPLOY、BUILD 和 RUNTIME。 | ||||
eventSource | NOT_APPLICABLE, DEPLOYMENT_EVENT, AUDIT_LOG_EVENT, | ||||
排除 | 定义应排除在此策略中的部署或镜像。 | ||||
scope | 定义此策略中包含的集群、命名空间和部署。未定义的范围包括所有内容。 | ||||
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
enforcementActions | 只有在将准入控制 Webhook 配置为对象创建/更新时,FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 才会生效。只有在启用了准入控制 Webhook 来侦听 exec 和 port-forward 事件时,FAIL_KUBE_REQUEST_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_POD_ENFORCEMENT, FAIL_BUILD_ENFORCEMENT,FAILS_DEPLOYMENT_UPDATE_ENFORCEMENT. | ||||
通知程序 |
| 确定此策略时应触发的通知程序 ID 列表。ID 应为 UUID 的形式,并通过 Central API 找到。 | |||
lastUpdated | Date | date-time | |||
sORTName | 字符串 | 仅供内部使用。 | |||
SORTLifecycleStage | 字符串 | 仅供内部使用。 | |||
SORTEnforcement | 布尔值 | 仅供内部使用。 | |||
policyVersion | 字符串 | ||||
policySections | PolicySections 定义此策略的违反标准。 | ||||
mitreAttackVectors | |||||
criteriaLocked | 布尔值 | 只读字段。如果为 true,策略的条件字段会以只读方式呈现。 | |||
mitreVectorsLocked | 布尔值 | 只读字段。如果为 true,则策略的 MITRE ATT&CK 字段以只读方式呈现。 | |||
isDefault | 布尔值 | 只读字段。如果为 false,表示策略是默认策略,如果为 false,则表示策略为默认策略。 | |||
source | 需要的声明, |
1.45.4.7.12. StoragePolicyGroup
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
fieldName | 字符串 | 定义此 PolicyGroup 评估的部署或镜像上的哪个字段。有关可能值的完整列表,请参阅 https://docs.openshift.com/acs/operating/manage-security-policies.html#policy-criteria_manage-security-policies。 | |||
booleanOperator | 或者,以及. | ||||
negate | 布尔值 | 确定此 PolicyGroup 的评估是否被否定。默认值为 false。 | |||
values |
1.45.4.7.13. StoragePolicySection
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
sectionName | 字符串 | ||||
policyGroups | 组成本节的策略组集合。每个组都可以被视为单独的条件。 |
1.45.4.7.14. StoragePolicySource
Enum 值 |
---|
IMPERATIVE |
DECLARATIVE |
1.45.4.7.15. StoragePolicyValue
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
value | 字符串 |
1.45.4.7.16. StorageScope
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
cluster | 字符串 | ||||
namespace | 字符串 | ||||
label |
1.45.4.7.17. StorageScopeLabel
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
1.45.4.7.18. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.45.4.7.19. V1DryRunResponse
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
alerts |
1.45.4.7.20. V1DryRunResponseAlert
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
部署 | 字符串 | ||||
违反情况 |
|
1.45.5. ExportPolicies
POST /v1/policies/export
ExportPolicies 使用策略 ID 列表,并返回整个策略列表或错误消息
1.45.5.1. 描述
1.45.5.2. 参数
1.45.5.2.1. 正文参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
正文(body) | X |
1.45.5.3. 返回类型
1.45.5.4. 内容类型
- application/json
1.45.5.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 | |
0 | 意外错误响应。 |
1.45.5.6. Samples
1.45.5.7. 常规对象参考
1.45.5.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.5.7.2. PolicyMitreAttackVectors
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
Tactic | 字符串 | ||||
技术 |
|
1.45.5.7.3. 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.45.5.7.3.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 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.5.7.4. StorageBooleanOperator
Enum 值 |
---|
或者 |
和 |
1.45.5.7.5. StorageEnforcementAction
- FAIL_KUBE_REQUEST_ENFORCEMENT: FAIL_KUBE_REQUEST_ENFORCEMENT 仅在启用了准入控制 webhook 来侦听 exec 和 port-forward 事件时生效。
- FAIL_DEPLOYMENT_CREATE_ENFORCEMENT: FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 仅在将准入控制 webhook 配置为在对象上创建时生效。
- FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT: FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT 仅在将准入控制 webhook 配置为强制实施对象更新时才会生效。
Enum 值 |
---|
SET_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 |
1.45.5.7.6. StorageEventSource
Enum 值 |
---|
NOT_APPLICABLE |
DEPLOYMENT_EVENT |
AUDIT_LOG_EVENT |
1.45.5.7.7. StorageExclusion
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
部署 | |||||
image | |||||
过期 | Date | date-time |
1.45.5.7.8. StorageExclusionDeployment
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
scope |
1.45.5.7.9. StorageExclusionImage
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 |
1.45.5.7.10. StorageExportPoliciesResponse
ExportPoliciesResponse is used by the API but it is defined in storage because we expect customers to store them. We do backwards-compatibility checks on objects in the storge folder and those checks should be applied to this object
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
policies |
1.45.5.7.11. StorageLifecycleStage
Enum 值 |
---|
DEPLOY |
BUILD |
RUNTIME |
1.45.5.7.12. StoragePolicy
Next tag: 28
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
name | 字符串 | 策略的名称。必须是唯一的。 | |||
description | 字符串 | 此策略的自由格式文本描述。 | |||
rationale | 字符串 | ||||
补救 | 字符串 | 描述如何修复此策略的违反情况。 | |||
disabled | 布尔值 | 切换此策略是否正在执行并主动触发警报。 | |||
类别 |
| 此策略属于的类别列表。类别名称必须已存在于 Central 中。 | |||
lifecycleStages | 描述此策略应用到哪些策略生命周期阶段。选择是 DEPLOY、BUILD 和 RUNTIME。 | ||||
eventSource | NOT_APPLICABLE, DEPLOYMENT_EVENT, AUDIT_LOG_EVENT, | ||||
排除 | 定义应排除在此策略中的部署或镜像。 | ||||
scope | 定义此策略中包含的集群、命名空间和部署。未定义的范围包括所有内容。 | ||||
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
enforcementActions | 只有在将准入控制 Webhook 配置为对象创建/更新时,FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 才会生效。只有在启用了准入控制 Webhook 来侦听 exec 和 port-forward 事件时,FAIL_KUBE_REQUEST_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_POD_ENFORCEMENT, FAIL_BUILD_ENFORCEMENT,FAILS_DEPLOYMENT_UPDATE_ENFORCEMENT. | ||||
通知程序 |
| 确定此策略时应触发的通知程序 ID 列表。ID 应为 UUID 的形式,并通过 Central API 找到。 | |||
lastUpdated | Date | date-time | |||
sORTName | 字符串 | 仅供内部使用。 | |||
SORTLifecycleStage | 字符串 | 仅供内部使用。 | |||
SORTEnforcement | 布尔值 | 仅供内部使用。 | |||
policyVersion | 字符串 | ||||
policySections | PolicySections 定义此策略的违反标准。 | ||||
mitreAttackVectors | |||||
criteriaLocked | 布尔值 | 只读字段。如果为 true,策略的条件字段会以只读方式呈现。 | |||
mitreVectorsLocked | 布尔值 | 只读字段。如果为 true,则策略的 MITRE ATT&CK 字段以只读方式呈现。 | |||
isDefault | 布尔值 | 只读字段。如果为 false,表示策略是默认策略,如果为 false,则表示策略为默认策略。 | |||
source | 需要的声明, |
1.45.5.7.13. StoragePolicyGroup
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
fieldName | 字符串 | 定义此 PolicyGroup 评估的部署或镜像上的哪个字段。有关可能值的完整列表,请参阅 https://docs.openshift.com/acs/operating/manage-security-policies.html#policy-criteria_manage-security-policies。 | |||
booleanOperator | 或者,以及. | ||||
negate | 布尔值 | 确定此 PolicyGroup 的评估是否被否定。默认值为 false。 | |||
values |
1.45.5.7.14. StoragePolicySection
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
sectionName | 字符串 | ||||
policyGroups | 组成本节的策略组集合。每个组都可以被视为单独的条件。 |
1.45.5.7.15. StoragePolicySource
Enum 值 |
---|
IMPERATIVE |
DECLARATIVE |
1.45.5.7.16. StoragePolicyValue
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
value | 字符串 |
1.45.5.7.17. StorageScope
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
cluster | 字符串 | ||||
namespace | 字符串 | ||||
label |
1.45.5.7.18. StorageScopeLabel
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
1.45.5.7.19. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.45.5.7.20. V1ExportPoliciesRequest
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
policyIds |
|
1.45.6. PolicyFromSearch
POST /v1/policies/from-search
1.45.6.1. 描述
1.45.6.2. 参数
1.45.6.2.1. 正文参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
正文(body) | X |
1.45.6.3. 返回类型
1.45.6.4. 内容类型
- application/json
1.45.6.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 | |
0 | 意外错误响应。 |
1.45.6.6. Samples
1.45.6.7. 常规对象参考
1.45.6.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.6.7.2. PolicyMitreAttackVectors
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
Tactic | 字符串 | ||||
技术 |
|
1.45.6.7.3. 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.45.6.7.3.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 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.6.7.4. StorageBooleanOperator
Enum 值 |
---|
或者 |
和 |
1.45.6.7.5. StorageEnforcementAction
- FAIL_KUBE_REQUEST_ENFORCEMENT: FAIL_KUBE_REQUEST_ENFORCEMENT 仅在启用了准入控制 webhook 来侦听 exec 和 port-forward 事件时生效。
- FAIL_DEPLOYMENT_CREATE_ENFORCEMENT: FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 仅在将准入控制 webhook 配置为在对象上创建时生效。
- FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT: FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT 仅在将准入控制 webhook 配置为强制实施对象更新时才会生效。
Enum 值 |
---|
SET_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 |
1.45.6.7.6. StorageEventSource
Enum 值 |
---|
NOT_APPLICABLE |
DEPLOYMENT_EVENT |
AUDIT_LOG_EVENT |
1.45.6.7.7. StorageExclusion
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
部署 | |||||
image | |||||
过期 | Date | date-time |
1.45.6.7.8. StorageExclusionDeployment
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
scope |
1.45.6.7.9. StorageExclusionImage
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 |
1.45.6.7.10. StorageLifecycleStage
Enum 值 |
---|
DEPLOY |
BUILD |
RUNTIME |
1.45.6.7.11. StoragePolicy
Next tag: 28
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
name | 字符串 | 策略的名称。必须是唯一的。 | |||
description | 字符串 | 此策略的自由格式文本描述。 | |||
rationale | 字符串 | ||||
补救 | 字符串 | 描述如何修复此策略的违反情况。 | |||
disabled | 布尔值 | 切换此策略是否正在执行并主动触发警报。 | |||
类别 |
| 此策略属于的类别列表。类别名称必须已存在于 Central 中。 | |||
lifecycleStages | 描述此策略应用到哪些策略生命周期阶段。选择是 DEPLOY、BUILD 和 RUNTIME。 | ||||
eventSource | NOT_APPLICABLE, DEPLOYMENT_EVENT, AUDIT_LOG_EVENT, | ||||
排除 | 定义应排除在此策略中的部署或镜像。 | ||||
scope | 定义此策略中包含的集群、命名空间和部署。未定义的范围包括所有内容。 | ||||
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
enforcementActions | 只有在将准入控制 Webhook 配置为对象创建/更新时,FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 才会生效。只有在启用了准入控制 Webhook 来侦听 exec 和 port-forward 事件时,FAIL_KUBE_REQUEST_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_POD_ENFORCEMENT, FAIL_BUILD_ENFORCEMENT,FAILS_DEPLOYMENT_UPDATE_ENFORCEMENT. | ||||
通知程序 |
| 确定此策略时应触发的通知程序 ID 列表。ID 应为 UUID 的形式,并通过 Central API 找到。 | |||
lastUpdated | Date | date-time | |||
sORTName | 字符串 | 仅供内部使用。 | |||
SORTLifecycleStage | 字符串 | 仅供内部使用。 | |||
SORTEnforcement | 布尔值 | 仅供内部使用。 | |||
policyVersion | 字符串 | ||||
policySections | PolicySections 定义此策略的违反标准。 | ||||
mitreAttackVectors | |||||
criteriaLocked | 布尔值 | 只读字段。如果为 true,策略的条件字段会以只读方式呈现。 | |||
mitreVectorsLocked | 布尔值 | 只读字段。如果为 true,则策略的 MITRE ATT&CK 字段以只读方式呈现。 | |||
isDefault | 布尔值 | 只读字段。如果为 false,表示策略是默认策略,如果为 false,则表示策略为默认策略。 | |||
source | 需要的声明, |
1.45.6.7.12. StoragePolicyGroup
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
fieldName | 字符串 | 定义此 PolicyGroup 评估的部署或镜像上的哪个字段。有关可能值的完整列表,请参阅 https://docs.openshift.com/acs/operating/manage-security-policies.html#policy-criteria_manage-security-policies。 | |||
booleanOperator | 或者,以及. | ||||
negate | 布尔值 | 确定此 PolicyGroup 的评估是否被否定。默认值为 false。 | |||
values |
1.45.6.7.13. StoragePolicySection
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
sectionName | 字符串 | ||||
policyGroups | 组成本节的策略组集合。每个组都可以被视为单独的条件。 |
1.45.6.7.14. StoragePolicySource
Enum 值 |
---|
IMPERATIVE |
DECLARATIVE |
1.45.6.7.15. StoragePolicyValue
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
value | 字符串 |
1.45.6.7.16. StorageScope
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
cluster | 字符串 | ||||
namespace | 字符串 | ||||
label |
1.45.6.7.17. StorageScopeLabel
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
1.45.6.7.18. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.45.6.7.19. V1PolicyFromSearchRequest
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
searchParams | 字符串 |
1.45.6.7.20. V1PolicyFromSearchResponse
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
policy | |||||
alteredSearchTerms |
| ||||
hasNestedFields | 布尔值 |
1.45.7. ListPolicies
GET /v1/policies
ListPolicies 返回策略列表。
1.45.7.1. 描述
1.45.7.2. 参数
1.45.7.2.1. 查询参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
query | - | null | ||
pagination.limit | - | null | ||
pagination.offset | - | null | ||
pagination.sortOption.field | - | null | ||
pagination.sortOption.reversed | - | null | ||
pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
pagination.sortOption.aggregateBy.distinct | - | null |
1.45.7.3. 返回类型
1.45.7.4. 内容类型
- application/json
1.45.7.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 | |
0 | 意外错误响应。 |
1.45.7.6. Samples
1.45.7.7. 常规对象参考
1.45.7.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.7.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.45.7.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 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.7.7.3. StorageEventSource
Enum 值 |
---|
NOT_APPLICABLE |
DEPLOYMENT_EVENT |
AUDIT_LOG_EVENT |
1.45.7.7.4. StorageLifecycleStage
Enum 值 |
---|
DEPLOY |
BUILD |
RUNTIME |
1.45.7.7.5. StorageListPolicy
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
name | 字符串 | ||||
description | 字符串 | ||||
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
disabled | 布尔值 | ||||
lifecycleStages | |||||
通知程序 |
| ||||
lastUpdated | Date | date-time | |||
eventSource | NOT_APPLICABLE, DEPLOYMENT_EVENT, AUDIT_LOG_EVENT, | ||||
isDefault | 布尔值 | ||||
source | 需要的声明, |
1.45.7.7.6. StoragePolicySource
Enum 值 |
---|
IMPERATIVE |
DECLARATIVE |
1.45.7.7.7. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.45.7.7.8. V1ListPoliciesResponse
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
policies |
1.45.8. DeletePolicy
DELETE /v1/policies/{id}
DeletePolicy 按 ID 删除策略。
1.45.8.1. 描述
1.45.8.2. 参数
1.45.8.2.1. 路径参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
id | X | null |
1.45.8.3. 返回类型
对象
1.45.8.4. 内容类型
- application/json
1.45.8.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 |
|
0 | 意外错误响应。 |
1.45.8.6. Samples
1.45.8.7. 常规对象参考
1.45.8.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.8.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.45.8.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 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.9. GetPolicy
GET /v1/policies/{id}
GetPolicy 按 ID 返回请求的策略。
1.45.9.1. 描述
1.45.9.2. 参数
1.45.9.2.1. 路径参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
id | X | null |
1.45.9.3. 返回类型
1.45.9.4. 内容类型
- application/json
1.45.9.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 | |
0 | 意外错误响应。 |
1.45.9.6. Samples
1.45.9.7. 常规对象参考
1.45.9.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.9.7.2. PolicyMitreAttackVectors
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
Tactic | 字符串 | ||||
技术 |
|
1.45.9.7.3. 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.45.9.7.3.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 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.9.7.4. StorageBooleanOperator
Enum 值 |
---|
或者 |
和 |
1.45.9.7.5. StorageEnforcementAction
- FAIL_KUBE_REQUEST_ENFORCEMENT: FAIL_KUBE_REQUEST_ENFORCEMENT 仅在启用了准入控制 webhook 来侦听 exec 和 port-forward 事件时生效。
- FAIL_DEPLOYMENT_CREATE_ENFORCEMENT: FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 仅在将准入控制 webhook 配置为在对象上创建时生效。
- FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT: FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT 仅在将准入控制 webhook 配置为强制实施对象更新时才会生效。
Enum 值 |
---|
SET_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 |
1.45.9.7.6. StorageEventSource
Enum 值 |
---|
NOT_APPLICABLE |
DEPLOYMENT_EVENT |
AUDIT_LOG_EVENT |
1.45.9.7.7. StorageExclusion
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
部署 | |||||
image | |||||
过期 | Date | date-time |
1.45.9.7.8. StorageExclusionDeployment
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
scope |
1.45.9.7.9. StorageExclusionImage
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 |
1.45.9.7.10. StorageLifecycleStage
Enum 值 |
---|
DEPLOY |
BUILD |
RUNTIME |
1.45.9.7.11. StoragePolicy
Next tag: 28
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
name | 字符串 | 策略的名称。必须是唯一的。 | |||
description | 字符串 | 此策略的自由格式文本描述。 | |||
rationale | 字符串 | ||||
补救 | 字符串 | 描述如何修复此策略的违反情况。 | |||
disabled | 布尔值 | 切换此策略是否正在执行并主动触发警报。 | |||
类别 |
| 此策略属于的类别列表。类别名称必须已存在于 Central 中。 | |||
lifecycleStages | 描述此策略应用到哪些策略生命周期阶段。选择是 DEPLOY、BUILD 和 RUNTIME。 | ||||
eventSource | NOT_APPLICABLE, DEPLOYMENT_EVENT, AUDIT_LOG_EVENT, | ||||
排除 | 定义应排除在此策略中的部署或镜像。 | ||||
scope | 定义此策略中包含的集群、命名空间和部署。未定义的范围包括所有内容。 | ||||
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
enforcementActions | 只有在将准入控制 Webhook 配置为对象创建/更新时,FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 才会生效。只有在启用了准入控制 Webhook 来侦听 exec 和 port-forward 事件时,FAIL_KUBE_REQUEST_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_POD_ENFORCEMENT, FAIL_BUILD_ENFORCEMENT,FAILS_DEPLOYMENT_UPDATE_ENFORCEMENT. | ||||
通知程序 |
| 确定此策略时应触发的通知程序 ID 列表。ID 应为 UUID 的形式,并通过 Central API 找到。 | |||
lastUpdated | Date | date-time | |||
sORTName | 字符串 | 仅供内部使用。 | |||
SORTLifecycleStage | 字符串 | 仅供内部使用。 | |||
SORTEnforcement | 布尔值 | 仅供内部使用。 | |||
policyVersion | 字符串 | ||||
policySections | PolicySections 定义此策略的违反标准。 | ||||
mitreAttackVectors | |||||
criteriaLocked | 布尔值 | 只读字段。如果为 true,策略的条件字段会以只读方式呈现。 | |||
mitreVectorsLocked | 布尔值 | 只读字段。如果为 true,则策略的 MITRE ATT&CK 字段以只读方式呈现。 | |||
isDefault | 布尔值 | 只读字段。如果为 false,表示策略是默认策略,如果为 false,则表示策略为默认策略。 | |||
source | 需要的声明, |
1.45.9.7.12. StoragePolicyGroup
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
fieldName | 字符串 | 定义此 PolicyGroup 评估的部署或镜像上的哪个字段。有关可能值的完整列表,请参阅 https://docs.openshift.com/acs/operating/manage-security-policies.html#policy-criteria_manage-security-policies。 | |||
booleanOperator | 或者,以及. | ||||
negate | 布尔值 | 确定此 PolicyGroup 的评估是否被否定。默认值为 false。 | |||
values |
1.45.9.7.13. StoragePolicySection
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
sectionName | 字符串 | ||||
policyGroups | 组成本节的策略组集合。每个组都可以被视为单独的条件。 |
1.45.9.7.14. StoragePolicySource
Enum 值 |
---|
IMPERATIVE |
DECLARATIVE |
1.45.9.7.15. StoragePolicyValue
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
value | 字符串 |
1.45.9.7.16. StorageScope
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
cluster | 字符串 | ||||
namespace | 字符串 | ||||
label |
1.45.9.7.17. StorageScopeLabel
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
1.45.9.7.18. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.45.10. GetPolicyMitreVectors
GET /v1/policies/{id}/mitrevectors
GetMitreVectorsForPolicy 按 ID 返回请求的策略。
1.45.10.1. 描述
1.45.10.2. 参数
1.45.10.2.1. 路径参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
id | X | null |
1.45.10.2.2. 查询参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
options.excludePolicy | 如果设置为 true,策略将从响应中排除。 | - | null |
1.45.10.3. 返回类型
1.45.10.4. 内容类型
- application/json
1.45.10.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 | |
0 | 意外错误响应。 |
1.45.10.6. Samples
1.45.10.7. 常规对象参考
1.45.10.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.10.7.2. PolicyMitreAttackVectors
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
Tactic | 字符串 | ||||
技术 |
|
1.45.10.7.3. 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.45.10.7.3.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 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.10.7.4. StorageBooleanOperator
Enum 值 |
---|
或者 |
和 |
1.45.10.7.5. StorageEnforcementAction
- FAIL_KUBE_REQUEST_ENFORCEMENT: FAIL_KUBE_REQUEST_ENFORCEMENT 仅在启用了准入控制 webhook 来侦听 exec 和 port-forward 事件时生效。
- FAIL_DEPLOYMENT_CREATE_ENFORCEMENT: FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 仅在将准入控制 webhook 配置为在对象上创建时生效。
- FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT: FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT 仅在将准入控制 webhook 配置为强制实施对象更新时才会生效。
Enum 值 |
---|
SET_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 |
1.45.10.7.6. StorageEventSource
Enum 值 |
---|
NOT_APPLICABLE |
DEPLOYMENT_EVENT |
AUDIT_LOG_EVENT |
1.45.10.7.7. StorageExclusion
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
部署 | |||||
image | |||||
过期 | Date | date-time |
1.45.10.7.8. StorageExclusionDeployment
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
scope |
1.45.10.7.9. StorageExclusionImage
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 |
1.45.10.7.10. StorageLifecycleStage
Enum 值 |
---|
DEPLOY |
BUILD |
RUNTIME |
1.45.10.7.11. StorageMitreAttackVector
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
Tactic | |||||
技术 |
1.45.10.7.12. StorageMitreTactic
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
name | 字符串 | ||||
description | 字符串 |
1.45.10.7.13. StorageMitreTechnique
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
name | 字符串 | ||||
description | 字符串 |
1.45.10.7.14. StoragePolicy
Next tag: 28
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
name | 字符串 | 策略的名称。必须是唯一的。 | |||
description | 字符串 | 此策略的自由格式文本描述。 | |||
rationale | 字符串 | ||||
补救 | 字符串 | 描述如何修复此策略的违反情况。 | |||
disabled | 布尔值 | 切换此策略是否正在执行并主动触发警报。 | |||
类别 |
| 此策略属于的类别列表。类别名称必须已存在于 Central 中。 | |||
lifecycleStages | 描述此策略应用到哪些策略生命周期阶段。选择是 DEPLOY、BUILD 和 RUNTIME。 | ||||
eventSource | NOT_APPLICABLE, DEPLOYMENT_EVENT, AUDIT_LOG_EVENT, | ||||
排除 | 定义应排除在此策略中的部署或镜像。 | ||||
scope | 定义此策略中包含的集群、命名空间和部署。未定义的范围包括所有内容。 | ||||
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
enforcementActions | 只有在将准入控制 Webhook 配置为对象创建/更新时,FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 才会生效。只有在启用了准入控制 Webhook 来侦听 exec 和 port-forward 事件时,FAIL_KUBE_REQUEST_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_POD_ENFORCEMENT, FAIL_BUILD_ENFORCEMENT,FAILS_DEPLOYMENT_UPDATE_ENFORCEMENT. | ||||
通知程序 |
| 确定此策略时应触发的通知程序 ID 列表。ID 应为 UUID 的形式,并通过 Central API 找到。 | |||
lastUpdated | Date | date-time | |||
sORTName | 字符串 | 仅供内部使用。 | |||
SORTLifecycleStage | 字符串 | 仅供内部使用。 | |||
SORTEnforcement | 布尔值 | 仅供内部使用。 | |||
policyVersion | 字符串 | ||||
policySections | PolicySections 定义此策略的违反标准。 | ||||
mitreAttackVectors | |||||
criteriaLocked | 布尔值 | 只读字段。如果为 true,策略的条件字段会以只读方式呈现。 | |||
mitreVectorsLocked | 布尔值 | 只读字段。如果为 true,则策略的 MITRE ATT&CK 字段以只读方式呈现。 | |||
isDefault | 布尔值 | 只读字段。如果为 false,表示策略是默认策略,如果为 false,则表示策略为默认策略。 | |||
source | 需要的声明, |
1.45.10.7.15. StoragePolicyGroup
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
fieldName | 字符串 | 定义此 PolicyGroup 评估的部署或镜像上的哪个字段。有关可能值的完整列表,请参阅 https://docs.openshift.com/acs/operating/manage-security-policies.html#policy-criteria_manage-security-policies。 | |||
booleanOperator | 或者,以及. | ||||
negate | 布尔值 | 确定此 PolicyGroup 的评估是否被否定。默认值为 false。 | |||
values |
1.45.10.7.16. StoragePolicySection
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
sectionName | 字符串 | ||||
policyGroups | 组成本节的策略组集合。每个组都可以被视为单独的条件。 |
1.45.10.7.17. StoragePolicySource
Enum 值 |
---|
IMPERATIVE |
DECLARATIVE |
1.45.10.7.18. StoragePolicyValue
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
value | 字符串 |
1.45.10.7.19. StorageScope
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
cluster | 字符串 | ||||
namespace | 字符串 | ||||
label |
1.45.10.7.20. StorageScopeLabel
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
1.45.10.7.21. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.45.10.7.22. V1GetPolicyMitreVectorsResponse
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
policy | |||||
vectors |
1.45.11. PatchPolicy
PATCH /v1/policies/{id}
PatchPolicy 编辑现有策略。
1.45.11.1. 描述
1.45.11.2. 参数
1.45.11.2.1. 路径参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
id | X | null |
1.45.11.2.2. 正文参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
正文(body) | X |
1.45.11.3. 返回类型
对象
1.45.11.4. 内容类型
- application/json
1.45.11.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 |
|
0 | 意外错误响应。 |
1.45.11.6. Samples
1.45.11.7. 常规对象参考
1.45.11.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.11.7.2. PolicyServicePatchPolicyBody
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
disabled | 布尔值 |
1.45.11.7.3. 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.45.11.7.3.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 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.12. PutPolicy
PUT /v1/policies/{id}
PutPolicy 修改现有策略。
1.45.12.1. 描述
1.45.12.2. 参数
1.45.12.2.1. 路径参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
id | X | null |
1.45.12.2.2. 正文参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
正文(body) | X |
1.45.12.3. 返回类型
对象
1.45.12.4. 内容类型
- application/json
1.45.12.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 |
|
0 | 意外错误响应。 |
1.45.12.6. Samples
1.45.12.7. 常规对象参考
1.45.12.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.12.7.2. PolicyMitreAttackVectors
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
Tactic | 字符串 | ||||
技术 |
|
1.45.12.7.3. PolicyServicePutPolicyBody
Next tag: 28
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | 策略的名称。必须是唯一的。 | |||
description | 字符串 | 此策略的自由格式文本描述。 | |||
rationale | 字符串 | ||||
补救 | 字符串 | 描述如何修复此策略的违反情况。 | |||
disabled | 布尔值 | 切换此策略是否正在执行并主动触发警报。 | |||
类别 |
| 此策略属于的类别列表。类别名称必须已存在于 Central 中。 | |||
lifecycleStages | 描述此策略应用到哪些策略生命周期阶段。选择是 DEPLOY、BUILD 和 RUNTIME。 | ||||
eventSource | NOT_APPLICABLE, DEPLOYMENT_EVENT, AUDIT_LOG_EVENT, | ||||
排除 | 定义应排除在此策略中的部署或镜像。 | ||||
scope | 定义此策略中包含的集群、命名空间和部署。未定义的范围包括所有内容。 | ||||
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
enforcementActions | 只有在将准入控制 Webhook 配置为对象创建/更新时,FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 才会生效。只有在启用了准入控制 Webhook 来侦听 exec 和 port-forward 事件时,FAIL_KUBE_REQUEST_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_POD_ENFORCEMENT, FAIL_BUILD_ENFORCEMENT,FAILS_DEPLOYMENT_UPDATE_ENFORCEMENT. | ||||
通知程序 |
| 确定此策略时应触发的通知程序 ID 列表。ID 应为 UUID 的形式,并通过 Central API 找到。 | |||
lastUpdated | Date | date-time | |||
sORTName | 字符串 | 仅供内部使用。 | |||
SORTLifecycleStage | 字符串 | 仅供内部使用。 | |||
SORTEnforcement | 布尔值 | 仅供内部使用。 | |||
policyVersion | 字符串 | ||||
policySections | PolicySections 定义此策略的违反标准。 | ||||
mitreAttackVectors | |||||
criteriaLocked | 布尔值 | 只读字段。如果为 true,策略的条件字段会以只读方式呈现。 | |||
mitreVectorsLocked | 布尔值 | 只读字段。如果为 true,则策略的 MITRE ATT&CK 字段以只读方式呈现。 | |||
isDefault | 布尔值 | 只读字段。如果为 false,表示策略是默认策略,如果为 false,则表示策略为默认策略。 | |||
source | 需要的声明, |
1.45.12.7.4. 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.45.12.7.4.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 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.12.7.5. StorageBooleanOperator
Enum 值 |
---|
或者 |
和 |
1.45.12.7.6. StorageEnforcementAction
- FAIL_KUBE_REQUEST_ENFORCEMENT: FAIL_KUBE_REQUEST_ENFORCEMENT 仅在启用了准入控制 webhook 来侦听 exec 和 port-forward 事件时生效。
- FAIL_DEPLOYMENT_CREATE_ENFORCEMENT: FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 仅在将准入控制 webhook 配置为在对象上创建时生效。
- FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT: FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT 仅在将准入控制 webhook 配置为强制实施对象更新时才会生效。
Enum 值 |
---|
SET_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 |
1.45.12.7.7. StorageEventSource
Enum 值 |
---|
NOT_APPLICABLE |
DEPLOYMENT_EVENT |
AUDIT_LOG_EVENT |
1.45.12.7.8. StorageExclusion
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
部署 | |||||
image | |||||
过期 | Date | date-time |
1.45.12.7.9. StorageExclusionDeployment
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
scope |
1.45.12.7.10. StorageExclusionImage
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 |
1.45.12.7.11. StorageLifecycleStage
Enum 值 |
---|
DEPLOY |
BUILD |
RUNTIME |
1.45.12.7.12. StoragePolicyGroup
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
fieldName | 字符串 | 定义此 PolicyGroup 评估的部署或镜像上的哪个字段。有关可能值的完整列表,请参阅 https://docs.openshift.com/acs/operating/manage-security-policies.html#policy-criteria_manage-security-policies。 | |||
booleanOperator | 或者,以及. | ||||
negate | 布尔值 | 确定此 PolicyGroup 的评估是否被否定。默认值为 false。 | |||
values |
1.45.12.7.13. StoragePolicySection
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
sectionName | 字符串 | ||||
policyGroups | 组成本节的策略组集合。每个组都可以被视为单独的条件。 |
1.45.12.7.14. StoragePolicySource
Enum 值 |
---|
IMPERATIVE |
DECLARATIVE |
1.45.12.7.15. StoragePolicyValue
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
value | 字符串 |
1.45.12.7.16. StorageScope
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
cluster | 字符串 | ||||
namespace | 字符串 | ||||
label |
1.45.12.7.17. StorageScopeLabel
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
1.45.12.7.18. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.45.13. ImportPolicies
POST /v1/policies/import
ImportPolicies 接受策略列表并返回无法导入的策略列表
1.45.13.1. 描述
1.45.13.2. 参数
1.45.13.2.1. 正文参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
正文(body) | X |
1.45.13.3. 返回类型
1.45.13.4. 内容类型
- application/json
1.45.13.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 | |
0 | 意外错误响应。 |
1.45.13.6. Samples
1.45.13.7. 常规对象参考
1.45.13.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.13.7.2. PolicyMitreAttackVectors
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
Tactic | 字符串 | ||||
技术 |
|
1.45.13.7.3. 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.45.13.7.3.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 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.13.7.4. StorageBooleanOperator
Enum 值 |
---|
或者 |
和 |
1.45.13.7.5. StorageEnforcementAction
- FAIL_KUBE_REQUEST_ENFORCEMENT: FAIL_KUBE_REQUEST_ENFORCEMENT 仅在启用了准入控制 webhook 来侦听 exec 和 port-forward 事件时生效。
- FAIL_DEPLOYMENT_CREATE_ENFORCEMENT: FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 仅在将准入控制 webhook 配置为在对象上创建时生效。
- FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT: FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT 仅在将准入控制 webhook 配置为强制实施对象更新时才会生效。
Enum 值 |
---|
SET_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 |
1.45.13.7.6. StorageEventSource
Enum 值 |
---|
NOT_APPLICABLE |
DEPLOYMENT_EVENT |
AUDIT_LOG_EVENT |
1.45.13.7.7. StorageExclusion
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
部署 | |||||
image | |||||
过期 | Date | date-time |
1.45.13.7.8. StorageExclusionDeployment
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
scope |
1.45.13.7.9. StorageExclusionImage
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 |
1.45.13.7.10. StorageLifecycleStage
Enum 值 |
---|
DEPLOY |
BUILD |
RUNTIME |
1.45.13.7.11. StoragePolicy
Next tag: 28
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
name | 字符串 | 策略的名称。必须是唯一的。 | |||
description | 字符串 | 此策略的自由格式文本描述。 | |||
rationale | 字符串 | ||||
补救 | 字符串 | 描述如何修复此策略的违反情况。 | |||
disabled | 布尔值 | 切换此策略是否正在执行并主动触发警报。 | |||
类别 |
| 此策略属于的类别列表。类别名称必须已存在于 Central 中。 | |||
lifecycleStages | 描述此策略应用到哪些策略生命周期阶段。选择是 DEPLOY、BUILD 和 RUNTIME。 | ||||
eventSource | NOT_APPLICABLE, DEPLOYMENT_EVENT, AUDIT_LOG_EVENT, | ||||
排除 | 定义应排除在此策略中的部署或镜像。 | ||||
scope | 定义此策略中包含的集群、命名空间和部署。未定义的范围包括所有内容。 | ||||
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
enforcementActions | 只有在将准入控制 Webhook 配置为对象创建/更新时,FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 才会生效。只有在启用了准入控制 Webhook 来侦听 exec 和 port-forward 事件时,FAIL_KUBE_REQUEST_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_POD_ENFORCEMENT, FAIL_BUILD_ENFORCEMENT,FAILS_DEPLOYMENT_UPDATE_ENFORCEMENT. | ||||
通知程序 |
| 确定此策略时应触发的通知程序 ID 列表。ID 应为 UUID 的形式,并通过 Central API 找到。 | |||
lastUpdated | Date | date-time | |||
sORTName | 字符串 | 仅供内部使用。 | |||
SORTLifecycleStage | 字符串 | 仅供内部使用。 | |||
SORTEnforcement | 布尔值 | 仅供内部使用。 | |||
policyVersion | 字符串 | ||||
policySections | PolicySections 定义此策略的违反标准。 | ||||
mitreAttackVectors | |||||
criteriaLocked | 布尔值 | 只读字段。如果为 true,策略的条件字段会以只读方式呈现。 | |||
mitreVectorsLocked | 布尔值 | 只读字段。如果为 true,则策略的 MITRE ATT&CK 字段以只读方式呈现。 | |||
isDefault | 布尔值 | 只读字段。如果为 false,表示策略是默认策略,如果为 false,则表示策略为默认策略。 | |||
source | 需要的声明, |
1.45.13.7.12. StoragePolicyGroup
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
fieldName | 字符串 | 定义此 PolicyGroup 评估的部署或镜像上的哪个字段。有关可能值的完整列表,请参阅 https://docs.openshift.com/acs/operating/manage-security-policies.html#policy-criteria_manage-security-policies。 | |||
booleanOperator | 或者,以及. | ||||
negate | 布尔值 | 确定此 PolicyGroup 的评估是否被否定。默认值为 false。 | |||
values |
1.45.13.7.13. StoragePolicySection
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
sectionName | 字符串 | ||||
policyGroups | 组成本节的策略组集合。每个组都可以被视为单独的条件。 |
1.45.13.7.14. StoragePolicySource
Enum 值 |
---|
IMPERATIVE |
DECLARATIVE |
1.45.13.7.15. StoragePolicyValue
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
value | 字符串 |
1.45.13.7.16. StorageScope
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
cluster | 字符串 | ||||
namespace | 字符串 | ||||
label |
1.45.13.7.17. StorageScopeLabel
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
1.45.13.7.18. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.45.13.7.19. V1ImportPoliciesMetadata
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
覆盖 | 布尔值 |
1.45.13.7.20. V1ImportPoliciesRequest
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
metadata | |||||
policies |
1.45.13.7.21. V1ImportPoliciesResponse
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
响应 | |||||
allSucceeded | 布尔值 |
1.45.13.7.22. V1ImportPolicyError
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
message | 字符串 | ||||
type | 字符串 | ||||
duplicateName | 字符串 | ||||
validationError | 字符串 |
1.45.13.7.23. V1ImportPolicyResponse
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
succeeded | 布尔值 | ||||
policy | |||||
errors |
1.45.14. EnableDisablePolicyNotification
PATCH /v1/policies/{policyId}/notifiers
EnableDisablePolicyNotification 根据 ID 启用或禁用策略通知。
1.45.14.1. 描述
1.45.14.2. 参数
1.45.14.2.1. 路径参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
policyId | X | null |
1.45.14.2.2. 正文参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
正文(body) | X |
1.45.14.3. 返回类型
对象
1.45.14.4. 内容类型
- application/json
1.45.14.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 |
|
0 | 意外错误响应。 |
1.45.14.6. Samples
1.45.14.7. 常规对象参考
1.45.14.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.14.7.2. PolicyServiceEnableDisablePolicyNotificationBody
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
notifierIds |
| ||||
disable | 布尔值 |
1.45.14.7.3. 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.45.14.7.3.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 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.15. PostPolicy
POST /v1/policies
PostPolicy 会创建一个新策略。
1.45.15.1. 描述
1.45.15.2. 参数
1.45.15.2.1. 正文参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
policy | X |
1.45.15.2.2. 查询参数
Name | 描述 | 必填 | default | pattern |
---|---|---|---|---|
enableStrictValidation | - | null |
1.45.15.3. 返回类型
1.45.15.4. 内容类型
- application/json
1.45.15.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 | |
0 | 意外错误响应。 |
1.45.15.6. Samples
1.45.15.7. 常规对象参考
1.45.15.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.15.7.2. PolicyMitreAttackVectors
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
Tactic | 字符串 | ||||
技术 |
|
1.45.15.7.3. 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.45.15.7.3.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 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.15.7.4. StorageBooleanOperator
Enum 值 |
---|
或者 |
和 |
1.45.15.7.5. StorageEnforcementAction
- FAIL_KUBE_REQUEST_ENFORCEMENT: FAIL_KUBE_REQUEST_ENFORCEMENT 仅在启用了准入控制 webhook 来侦听 exec 和 port-forward 事件时生效。
- FAIL_DEPLOYMENT_CREATE_ENFORCEMENT: FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 仅在将准入控制 webhook 配置为在对象上创建时生效。
- FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT: FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT 仅在将准入控制 webhook 配置为强制实施对象更新时才会生效。
Enum 值 |
---|
SET_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 |
1.45.15.7.6. StorageEventSource
Enum 值 |
---|
NOT_APPLICABLE |
DEPLOYMENT_EVENT |
AUDIT_LOG_EVENT |
1.45.15.7.7. StorageExclusion
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
部署 | |||||
image | |||||
过期 | Date | date-time |
1.45.15.7.8. StorageExclusionDeployment
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 | ||||
scope |
1.45.15.7.9. StorageExclusionImage
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
name | 字符串 |
1.45.15.7.10. StorageLifecycleStage
Enum 值 |
---|
DEPLOY |
BUILD |
RUNTIME |
1.45.15.7.11. StoragePolicy
Next tag: 28
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id | 字符串 | ||||
name | 字符串 | 策略的名称。必须是唯一的。 | |||
description | 字符串 | 此策略的自由格式文本描述。 | |||
rationale | 字符串 | ||||
补救 | 字符串 | 描述如何修复此策略的违反情况。 | |||
disabled | 布尔值 | 切换此策略是否正在执行并主动触发警报。 | |||
类别 |
| 此策略属于的类别列表。类别名称必须已存在于 Central 中。 | |||
lifecycleStages | 描述此策略应用到哪些策略生命周期阶段。选择是 DEPLOY、BUILD 和 RUNTIME。 | ||||
eventSource | NOT_APPLICABLE, DEPLOYMENT_EVENT, AUDIT_LOG_EVENT, | ||||
排除 | 定义应排除在此策略中的部署或镜像。 | ||||
scope | 定义此策略中包含的集群、命名空间和部署。未定义的范围包括所有内容。 | ||||
严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
enforcementActions | 只有在将准入控制 Webhook 配置为对象创建/更新时,FAIL_DEPLOYMENT_CREATE_ENFORCEMENT 才会生效。只有在启用了准入控制 Webhook 来侦听 exec 和 port-forward 事件时,FAIL_KUBE_REQUEST_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_POD_ENFORCEMENT, FAIL_BUILD_ENFORCEMENT,FAILS_DEPLOYMENT_UPDATE_ENFORCEMENT. | ||||
通知程序 |
| 确定此策略时应触发的通知程序 ID 列表。ID 应为 UUID 的形式,并通过 Central API 找到。 | |||
lastUpdated | Date | date-time | |||
sORTName | 字符串 | 仅供内部使用。 | |||
SORTLifecycleStage | 字符串 | 仅供内部使用。 | |||
SORTEnforcement | 布尔值 | 仅供内部使用。 | |||
policyVersion | 字符串 | ||||
policySections | PolicySections 定义此策略的违反标准。 | ||||
mitreAttackVectors | |||||
criteriaLocked | 布尔值 | 只读字段。如果为 true,策略的条件字段会以只读方式呈现。 | |||
mitreVectorsLocked | 布尔值 | 只读字段。如果为 true,则策略的 MITRE ATT&CK 字段以只读方式呈现。 | |||
isDefault | 布尔值 | 只读字段。如果为 false,表示策略是默认策略,如果为 false,则表示策略为默认策略。 | |||
source | 需要的声明, |
1.45.15.7.12. StoragePolicyGroup
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
fieldName | 字符串 | 定义此 PolicyGroup 评估的部署或镜像上的哪个字段。有关可能值的完整列表,请参阅 https://docs.openshift.com/acs/operating/manage-security-policies.html#policy-criteria_manage-security-policies。 | |||
booleanOperator | 或者,以及. | ||||
negate | 布尔值 | 确定此 PolicyGroup 的评估是否被否定。默认值为 false。 | |||
values |
1.45.15.7.13. StoragePolicySection
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
sectionName | 字符串 | ||||
policyGroups | 组成本节的策略组集合。每个组都可以被视为单独的条件。 |
1.45.15.7.14. StoragePolicySource
Enum 值 |
---|
IMPERATIVE |
DECLARATIVE |
1.45.15.7.15. StoragePolicyValue
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
value | 字符串 |
1.45.15.7.16. StorageScope
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
cluster | 字符串 | ||||
namespace | 字符串 | ||||
label |
1.45.15.7.17. StorageScopeLabel
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
key | 字符串 | ||||
value | 字符串 |
1.45.15.7.18. StorageSeverity
Enum 值 |
---|
SET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
1.45.16. ReassessPolicies
POST /v1/policies/reassess
ReassessPolicies 重新评估所有策略。
1.45.16.1. 描述
1.45.16.2. 参数
1.45.16.3. 返回类型
对象
1.45.16.4. 内容类型
- application/json
1.45.16.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 |
|
0 | 意外错误响应。 |
1.45.16.6. Samples
1.45.16.7. 常规对象参考
1.45.16.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.16.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.45.16.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 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.17. GetPolicyCategories
GET /v1/policyCategories
GetPolicyCategories 返回策略类别。
1.45.17.1. 描述
1.45.17.2. 参数
1.45.17.3. 返回类型
1.45.17.4. 内容类型
- application/json
1.45.17.5. 响应
代码 | 消息 | datatype |
---|---|---|
200 | 成功响应。 | |
0 | 意外错误响应。 |
1.45.17.6. Samples
1.45.17.7. 常规对象参考
1.45.17.7.1. GooglerpcStatus
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code | 整数 | int32 | |||
message | 字符串 | ||||
详情 |
1.45.17.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.45.17.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 路径的最后一部分必须代表类型的完全限定名称(如 |
1.45.17.7.3. V1PolicyCategoriesResponse
字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
类别 |
|