OpenShift 文档正在迁移，很快将只能在 docs.redhat.com（所有 Red Hat 产品文档的中心）访问。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

ListAlerts

GET /v1/alerts

列表返回警报的精简列表版本。

描述

参数

查询参数

名称 描述 必填 默认值 模式

查询

-

空

pagination.limit

-

空

pagination.offset

-

空

pagination.sortOption.field

-

空

pagination.sortOption.reversed

-

空

pagination.sortOption.aggregateBy.aggrFunc

-

未设置

pagination.sortOption.aggregateBy.distinct

-

空

返回类型

V1ListAlertsResponse

内容类型

  • application/json

响应

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

200

成功的响应。

V1ListAlertsResponse

0

意外的错误响应。

GooglerpcStatus

示例

常用对象引用

GooglerpcStatus

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

代码

整数

int32

消息

字符串

详情

ProtobufAny 列表

ListAlertCommonEntityInfo

警报可能属于的所有实体的公共字段。

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

集群名称

字符串

命名空间

字符串

集群ID

字符串

命名空间ID

字符串

资源类型

StorageListAlertResourceType

DEPLOYMENT, SECRETS, CONFIGMAPS, CLUSTER_ROLES, CLUSTER_ROLE_BINDINGS, NETWORK_POLICIES, SECURITY_CONTEXT_CONSTRAINTS, EGRESS_FIREWALLS,

ListAlertPolicyDevFields

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

SORTName

字符串

ListAlertResourceEntity

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

name

字符串

ProtobufAny

Any包含任意序列化的协议缓冲区消息以及描述序列化消息类型的URL。

Protobuf库提供支持，以实用函数或Any类型的附加生成方法的形式打包/解包Any值。

示例1：在C++中打包和解包消息。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

示例2：在Java中打包和解包消息。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
Example 3: Pack and unpack a message in Python.
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

Protobuf库提供的打包方法默认使用'type.googleapis.com/full.type.name'作为类型URL，解包方法仅使用类型URL中最后一个'/'后的完全限定类型名称，例如"foo.bar.com/x/y.z"将产生类型名称"y.z"。

JSON表示

Any值的JSON表示使用反序列化的嵌入式消息的常规表示，并附加一个包含类型URL的字段@type。示例

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

如果嵌入式消息类型是众所周知的并且具有自定义JSON表示，则该表示将被嵌入，并添加一个字段value，该字段除了@type字段外还包含自定义JSON。示例（对于消息[google.protobuf.Duration][]）

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
字段名称 必填 可空 类型 描述 格式

@type

字符串

唯一标识序列化协议缓冲区消息类型的URL/资源名称。此字符串必须至少包含一个“/”字符。URL路径的最后一个段必须表示类型的完全限定名称（如path/google.protobuf.Duration）。名称应采用规范形式（例如，不接受前导“.”）。实际上，团队通常会将其预期在Any上下文中使用的所有类型预编译到二进制文件中。但是，对于使用方案http、https或无方案的URL，可以选择设置一个类型服务器，该服务器将类型URL映射到消息定义，如下所示：* 如果未提供方案，则假定为https。* 对URL的HTTP GET必须产生二进制格式的[google.protobuf.Type][]值，或产生错误。* 应用程序允许基于URL缓存查找结果，或将其预编译到二进制文件中以避免任何查找。因此，需要在类型更改时保留二进制兼容性。（使用版本化的类型名称来管理重大更改。）注意：此功能当前在官方protobuf版本中不可用，并且不适用于以type.googleapis.com开头的类型URL。截至2023年5月，没有广泛使用的类型服务器实现，也没有计划实现一个。除http、https（或空方案）之外的其他方案可能与特定于实现的语义一起使用。

StorageEnforcementAction

  • FAIL_KUBE_REQUEST_ENFORCEMENT：只有在启用准入控制Webhook以侦听exec和port-forward事件时，FAIL_KUBE_REQUEST_ENFORCEMENT才有效。

  • FAIL_DEPLOYMENT_CREATE_ENFORCEMENT：只有在配置准入控制Webhook以在对象创建时强制执行时，FAIL_DEPLOYMENT_CREATE_ENFORCEMENT才有效。

  • FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT：只有在配置准入控制Webhook以在对象更新时强制执行时，FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT才有效。

枚举值

UNSET_ENFORCEMENT

SCALE_TO_ZERO_ENFORCEMENT

UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT

KILL_POD_ENFORCEMENT

FAIL_BUILD_ENFORCEMENT

FAIL_KUBE_REQUEST_ENFORCEMENT

FAIL_DEPLOYMENT_CREATE_ENFORCEMENT

FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT

StorageLifecycleStage

枚举值

DEPLOY

BUILD

RUNTIME

StorageListAlert

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

id

字符串

lifecycleStage

StorageLifecycleStage

DEPLOY，BUILD，RUNTIME，

time

日期

日期时间

policy

StorageListAlertPolicy

state

StorageViolationState

ACTIVE，SNOOZED，RESOLVED，ATTEMPTED，

enforcementCount

整数

int32

enforcementAction

StorageEnforcementAction

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

commonEntityInfo

ListAlertCommonEntityInfo

deployment

StorageListAlertDeployment

resource

ListAlertResourceEntity

StorageListAlertDeployment

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

id

字符串

name

字符串

集群名称

字符串

此字段已弃用，可以在CommonEntityInfo中找到。此字段将在未来的版本中从此处删除。此字段已移至CommonEntityInfo

命名空间

字符串

此字段已弃用，可以在CommonEntityInfo中找到。此字段将在未来的版本中从此处删除。此字段已移至CommonEntityInfo

集群ID

字符串

此字段已弃用，可以在CommonEntityInfo中找到。此字段将在未来的版本中从此处删除。此字段已移至CommonEntityInfo

inactive

布尔值

命名空间ID

字符串

此字段已弃用，可以在CommonEntityInfo中找到。此字段将在未来的版本中从此处删除。此字段已移至CommonEntityInfo

deploymentType

字符串

StorageListAlertPolicy

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

id

字符串

name

字符串

severity

StorageSeverity

UNSET_SEVERITY，LOW_SEVERITY，MEDIUM_SEVERITY，HIGH_SEVERITY，CRITICAL_SEVERITY，

description

字符串

categories

string列表

developerInternalFields

ListAlertPolicyDevFields

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)
枚举值

DEPLOYMENT

SECRETS

CONFIGMAPS

CLUSTER_ROLES

CLUSTER_ROLE_BINDINGS

NETWORK_POLICIES

SECURITY_CONTEXT_CONSTRAINTS

EGRESS_FIREWALLS

StorageSeverity

枚举值

UNSET_SEVERITY

LOW_SEVERITY

MEDIUM_SEVERITY

HIGH_SEVERITY

CRITICAL_SEVERITY

StorageViolationState

枚举值

ACTIVE

SNOOZED

RESOLVED

ATTEMPTED

V1ListAlertsResponse

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

alerts

StorageListAlert列表