This documentation is for a release that is no longer maintained.
You can select a different version or view all RHACS documentation.3.3. ListAlerts
GET /v1/alerts
list 返回警报的 slim 列表版本。
3.3.1. 描述 复制链接链接已复制到粘贴板!
3.3.2. 参数 复制链接链接已复制到粘贴板!
3.3.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 |
3.3.3. 返回类型 复制链接链接已复制到粘贴板!
3.3.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
3.3.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
3.3.6. Samples 复制链接链接已复制到粘贴板!
3.3.7. 常规对象参考 复制链接链接已复制到粘贴板!
3.3.7.1. ListAlertCommonEntityInfo 复制链接链接已复制到粘贴板!
警报所属的所有实体通用的字段。
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| clusterName | 字符串 | ||||
| namespace | 字符串 | ||||
| clusterId | 字符串 | ||||
| namespaceId | 字符串 | ||||
| resourceType | DEPLOYMENT, SECRETS, CONFIGMAPS, CLUSTER_ROLES, CLUSTER_ROLE_BINDINGS, NETWORK_POLICIES, SECURITY_CONTEXT_CONSTRAINTS, EGRESS_FIREWALLS, |
3.3.7.2. ListAlertPolicyDevFields 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| SORTName | 字符串 |
3.3.7.3. ListAlertResourceEntity 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| 名称 | 字符串 |
3.3.7.4. 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.3.7.4.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.3.7.5. RuntimeError 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| 错误 | 字符串 | ||||
| code | 整数 | int32 | |||
| message | 字符串 | ||||
| 详情 |
3.3.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 值 |
|---|
| 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.3.7.7. StorageLifecycleStage 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| DEPLOY |
| BUILD |
| RUNTIME |
3.3.7.8. StorageListAlert 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| id | 字符串 | ||||
| lifecycleStage | 部署、构建、运行时、 | ||||
| time | Date | date-time | |||
| policy | |||||
| state | ACTIVE, SNOOZED, 解析,尝试, | ||||
| enforcementCount | 整数 | int32 | |||
| enforcementAction | 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_ | ||||
| commonEntityInfo | |||||
| 部署 | |||||
| resource |
3.3.7.9. StorageListAlertDeployment 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| id | 字符串 | ||||
| 名称 | 字符串 | ||||
| clusterName | 字符串 | 此字段已弃用,可在 CommonEntityInfo 中找到。在以后的发行版本中,它将从这里删除。 | |||
| namespace | 字符串 | 此字段已弃用,可在 CommonEntityInfo 中找到。在以后的发行版本中,它将从这里删除。 | |||
| clusterId | 字符串 | 此字段已弃用,可在 CommonEntityInfo 中找到。在以后的发行版本中,它将从这里删除。 | |||
| Inactive | 布尔值 | ||||
| namespaceId | 字符串 | 此字段已弃用,可在 CommonEntityInfo 中找到。在以后的发行版本中,它将从这里删除。 |
3.3.7.10. StorageListAlertPolicy 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| id | 字符串 | ||||
| 名称 | 字符串 | ||||
| 严重性 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
| description | 字符串 | ||||
| 类别 |
| ||||
| developerInternalFields |
3.3.7.11. StorageListAlertResourceType 复制链接链接已复制到粘贴板!
A special ListAlert-only enumeration of all resource types. Unlike Alert.Resource.ResourceType this also includes deployment as a type This must be kept in sync with Alert.Resource.ResourceType (excluding the deployment value)
A special ListAlert-only enumeration of all resource types. Unlike Alert.Resource.ResourceType this also includes deployment as a type This must be kept in sync with Alert.Resource.ResourceType (excluding the deployment value)
| Enum 值 |
|---|
| 部署 |
| SECRETS |
| CONFIGMAPS |
| CLUSTER_ROLES |
| CLUSTER_ROLE_BINDINGS |
| NETWORK_POLICIES |
| SECURITY_CONTEXT_CONSTRAINTS |
| EGRESS_FIREWALLS |
3.3.7.12. StorageSeverity 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| UNSET_SEVERITY |
| LOW_SEVERITY |
| MEDIUM_SEVERITY |
| HIGH_SEVERITY |
| CRITICAL_SEVERITY |
3.3.7.13. StorageViolationState 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| ACTIVE |
| SNOOZED |
| 已解决 |
| ATTEMPTED |
3.3.7.14. V1ListAlertsResponse 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| alerts |