This documentation is for a release that is no longer maintained.
You can select a different version or view all RHACS documentation.3.4. GetAlert
GET /v1/alerts/{id}
GetAlert 返回其 id 的警报。
3.4.1. 描述 复制链接链接已复制到粘贴板!
3.4.2. 参数 复制链接链接已复制到粘贴板!
3.4.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| id | X | null |
3.4.3. 返回类型 复制链接链接已复制到粘贴板!
3.4.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
3.4.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
3.4.6. Samples 复制链接链接已复制到粘贴板!
3.4.7. 常规对象参考 复制链接链接已复制到粘贴板!
3.4.7.1. AlertDeploymentContainer 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| image | |||||
| 名称 | 字符串 |
3.4.7.2. AlertEnforcement 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| action | 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_BUILD_ENFORCEMENT, FAIL_KUBE_REQUEST_ | ||||
| message | 字符串 |
3.4.7.3. AlertProcessViolation 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| message | 字符串 | ||||
| 进程 |
3.4.7.4. AlertResourceResourceType 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| UNKNOWN |
| SECRETS |
| CONFIGMAPS |
| CLUSTER_ROLES |
| CLUSTER_ROLE_BINDINGS |
| NETWORK_POLICIES |
| SECURITY_CONTEXT_CONSTRAINTS |
| EGRESS_FIREWALLS |
3.4.7.5. AlertViolation 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| message | 字符串 | ||||
| keyValueAttrs | |||||
| networkFlowInfo | |||||
| type | GENERIC, K8S_EVENT, NETWORK_FLOW, NETWORK_POLICY, | ||||
| time | Date | 表示违反时间。此字段与顶层字段 'time' 不同,代表在出现多个策略警报时警报最后一次发生的时间。从 55.0 开始,此字段只针对 kubernetes 事件违反情况设置,但以后可能不会限制它。 | date-time |
3.4.7.6. AlertViolationType 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| GENERIC |
| K8S_EVENT |
| NETWORK_FLOW |
| NETWORK_POLICY |
3.4.7.7. KeyValueAttrsKeyValueAttr 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| key | 字符串 | ||||
| value | 字符串 |
3.4.7.8. NetworkFlowInfoEntity 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| 名称 | 字符串 | ||||
| entityType | UNKNOWN_TYPE, DEPLOYMENT, INTERNET, LISTEN_ENDPOINT, EXTERNAL_SOURCE, INTERNAL_ENTITIES, | ||||
| deploymentNamespace | 字符串 | ||||
| deploymentType | 字符串 | ||||
| port | 整数 | int32 |
3.4.7.9. PolicyMitreAttackVectors 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| Tactic | 字符串 | ||||
| 技术 |
|
3.4.7.10. ProcessSignalLineageInfo 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| parentUid | Long | int64 | |||
| parentExecFilePath | 字符串 |
3.4.7.11. ProtobufAny 复制链接链接已复制到粘贴板!
any 包含任意序列化协议缓冲区消息,以及一个描述序列化消息的类型的 URL。
protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持,或者对 Any 类型的其他生成的方法提供其他生成的方法。
示例 1: Pack 并在 C++ 中解包信息。
示例 2:打包并解压缩 Java 消息。
Example 3: Pack and unpack a message in Python.
Example 3: Pack and unpack a message in Python.
Example 4: Pack and unpack a message in Go
Example 4: Pack and unpack a message in Go
默认情况下,protobuf 库提供的软件包方法将使用 'type.googleapis.com/full.type.name' 作为类型 URL,解包方法只使用类型 URL 中的完全限定类型名称,如 "foo.bar.com/x/x/y.z"。
3.4.7.11.1. JSON 表示 复制链接链接已复制到粘贴板!
any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示,以及包含类型 URL 的附加字段 @type。Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
如果嵌入式消息类型是知名且具有自定义 JSON 表示法,则该表示将被嵌入一个字段值,该值 除 @type 字段外还包含自定义 JSON。示例(用于消息 [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| typeUrl | 字符串 |
唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 | |||
| value | byte[] | 必须是上述指定类型的有效序列化协议缓冲。 | BYTE |
3.4.7.12. RuntimeError 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| 错误 | 字符串 | ||||
| code | 整数 | int32 | |||
| message | 字符串 | ||||
| 详情 |
3.4.7.13. StorageAlert 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| id | 字符串 | ||||
| policy | |||||
| lifecycleStage | 部署、构建、运行时、 | ||||
| clusterId | 字符串 | ||||
| clusterName | 字符串 | ||||
| namespace | 字符串 | ||||
| namespaceId | 字符串 | ||||
| 部署 | |||||
| image | |||||
| resource | |||||
| 违反情况 | 对于运行时阶段警报,保留最多 40 个违反情况。 | ||||
| processViolation | |||||
| 强制 | |||||
| time | Date | date-time | |||
| firstOccurred | Date | date-time | |||
| resolvedAt | Date | 警报被解决的时间。仅在 ViolationState 为 RESOLVED 时才设置。 | date-time | ||
| state | ACTIVE, SNOOZED, 解析,尝试, | ||||
| snoozeTill | Date | date-time |
3.4.7.14. StorageAlertDeployment 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| id | 字符串 | ||||
| 名称 | 字符串 | ||||
| type | 字符串 | ||||
| namespace | 字符串 | ||||
| namespaceId | 字符串 | ||||
| labels |
| ||||
| clusterId | 字符串 | ||||
| clusterName | 字符串 | ||||
| containers | |||||
| annotations |
| ||||
| Inactive | 布尔值 |
3.4.7.15. StorageAlertResource 复制链接链接已复制到粘贴板!
Represents an alert on a kubernetes resource other than a deployment (configmaps, secrets, etc.)
Represents an alert on a kubernetes resource other than a deployment (configmaps, secrets, etc.)
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| resourceType | UNKNOWN, SECRETS, CONFIGMAPS, CLUSTER_ROLES, CLUSTER_ROLE_BINDINGS, NETWORK_POLICIES, SECURITY_CONTEXT_CONSTRAINTS, EGRESS_FIREWALLS, | ||||
| 名称 | 字符串 | ||||
| clusterId | 字符串 | ||||
| clusterName | 字符串 | ||||
| namespace | 字符串 | ||||
| namespaceId | 字符串 |
3.4.7.16. StorageBooleanOperator 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| 或者 |
| 和 |
3.4.7.17. StorageContainerImage 复制链接链接已复制到粘贴板!
Next tag: 12
Next tag: 12
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| id | 字符串 | ||||
| 名称 | |||||
| notPullable | 布尔值 | ||||
| isClusterLocal | 布尔值 |
3.4.7.18. 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 值 |
|---|
| 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 |
3.4.7.19. StorageEventSource 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| NOT_APPLICABLE |
| DEPLOYMENT_EVENT |
| AUDIT_LOG_EVENT |
3.4.7.20. StorageExclusion 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| 名称 | 字符串 | ||||
| 部署 | |||||
| image | |||||
| 过期 | Date | date-time |
3.4.7.21. StorageExclusionDeployment 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| 名称 | 字符串 | ||||
| scope |
3.4.7.22. StorageExclusionImage 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| 名称 | 字符串 |
3.4.7.23. StorageImageName 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| registry | 字符串 | ||||
| remote | 字符串 | ||||
| tag | 字符串 | ||||
| fullName | 字符串 |
3.4.7.24. StorageL4Protocol 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| L4_PROTOCOL_UNKNOWN |
| L4_PROTOCOL_TCP |
| L4_PROTOCOL_UDP |
| L4_PROTOCOL_ICMP |
| L4_PROTOCOL_RAW |
| L4_PROTOCOL_SCTP |
| L4_PROTOCOL_ANY |
3.4.7.25. StorageLifecycleStage 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| DEPLOY |
| BUILD |
| RUNTIME |
3.4.7.26. StorageNetworkEntityInfoType 复制链接链接已复制到粘贴板!
- INTERNAL_ENTITIES:INTERNAL_ENTITIES 用于在单一网络图形节点下对所有内部实体进行分组
| Enum 值 |
|---|
| UNKNOWN_TYPE |
| 部署 |
| 互联网 |
| LISTEN_ENDPOINT |
| EXTERNAL_SOURCE |
| INTERNAL_ENTITIES |
3.4.7.27. StoragePolicy 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| id | 字符串 | ||||
| 名称 | 字符串 | ||||
| description | 字符串 | ||||
| rationale | 字符串 | ||||
| 补救 | 字符串 | ||||
| disabled | 布尔值 | ||||
| 类别 |
| ||||
| lifecycleStages | |||||
| 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 才会生效。 | ||||
| 通知程序 |
| ||||
| lastUpdated | Date | date-time | |||
| SORTName | 字符串 | 仅供内部使用。 | |||
| SORTLifecycleStage | 字符串 | 仅供内部使用。 | |||
| SORTEnforcement | 布尔值 | 仅供内部使用。 | |||
| policyVersion | 字符串 | ||||
| policySections | |||||
| mitreAttackVectors | |||||
| criteriaLocked | 布尔值 | 只读字段。如果为 true,策略的条件字段会以只读方式呈现。 | |||
| mitreVectorsLocked | 布尔值 | 只读字段。如果为 true,则策略的 MITRE ATT&CK 字段以只读方式呈现。 | |||
| isDefault | 布尔值 | 只读字段。如果为 false,表示策略是默认策略,如果为 false,则表示策略为默认策略。 |
3.4.7.28. StoragePolicyGroup 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| fieldName | 字符串 | ||||
| booleanOperator | 或者,以及. | ||||
| negate | 布尔值 | ||||
| values |
3.4.7.29. StoragePolicySection 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| sectionName | 字符串 | ||||
| policyGroups |
3.4.7.30. StoragePolicyValue 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| value | 字符串 |
3.4.7.31. StorageProcessIndicator 复制链接链接已复制到粘贴板!
Next available tag: 13
Next available tag: 13
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| id | 字符串 | ||||
| deploymentId | 字符串 | ||||
| containerName | 字符串 | ||||
| podId | 字符串 | ||||
| podUid | 字符串 | ||||
| signal | |||||
| clusterId | 字符串 | ||||
| namespace | 字符串 | ||||
| containerStartTime | Date | date-time | |||
| imageId | 字符串 |
3.4.7.32. StorageProcessSignal 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| id | 字符串 | 用于识别消息的唯一 UUID,此处有此此,而不是在顶级,因为我们希望包含每个消息。 | |||
| containerId | 字符串 | ||||
| time | Date | date-time | |||
| 名称 | 字符串 | ||||
| args | 字符串 | ||||
| execFilePath | 字符串 | ||||
| pid | Long | int64 | |||
| uid | Long | int64 | |||
| gid | Long | int64 | |||
| lineage |
| ||||
| scraped | 布尔值 | ||||
| lineageInfo |
3.4.7.33. StorageScope 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| cluster | 字符串 | ||||
| namespace | 字符串 | ||||
| label |
3.4.7.34. StorageScopeLabel 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| key | 字符串 | ||||
| value | 字符串 |
3.4.7.35. StorageSeverity 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| UNSET_SEVERITY |
| LOW_SEVERITY |
| MEDIUM_SEVERITY |
| HIGH_SEVERITY |
| CRITICAL_SEVERITY |
3.4.7.36. StorageViolationState 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| ACTIVE |
| SNOOZED |
| 已解决 |
| ATTEMPTED |
3.4.7.37. ViolationKeyValueAttrs 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| attrs |
3.4.7.38. ViolationNetworkFlowInfo 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| protocol | L4_PROTOCOL_UNKNOWN, L4_PROTOCOL_TCP, L4_PROTOCOL_UDP, L4_PROTOCOL_ICMP, L4_PROTOCOL_RAW, L4_PROTOCOL_SCTP, L4_PROTOCOL_ANY, | ||||
| source | |||||
| 目的地 |