OpenShift 文档正在迁移，不久后将仅在 docs.redhat.com（所有 Red Hat 产品文档的所在地）提供。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

AlertRelabelConfig [monitoring.openshift.io/v1]

规格

属性 类型 描述

apiVersion

字符串

APIVersion 定义了此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从此客户端提交请求的端点推断出此值。无法更新。采用驼峰式命名法。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

spec 描述了此 AlertRelabelConfig 对象的期望状态。

status

对象

status 描述了此 AlertRelabelConfig 对象的当前状态。

.spec

描述

spec 描述了此 AlertRelabelConfig 对象的期望状态。

类型

对象

必需

  • 配置

属性 类型 描述

配置

数组

configs 是一个按顺序计算的告警重标记配置列表。

configs[]

对象

RelabelConfig 允许动态重写告警的标签集。请参阅 Prometheus 文档：- https://prometheus.ac.cn/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs - https://prometheus.ac.cn/docs/prometheus/latest/configuration/configuration/#relabel_config

.spec.configs

描述

configs 是一个按顺序计算的告警重标记配置列表。

类型

数组

.spec.configs[]

描述

RelabelConfig 允许动态重写告警的标签集。请参阅 Prometheus 文档：- https://prometheus.ac.cn/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs - https://prometheus.ac.cn/docs/prometheus/latest/configuration/configuration/#relabel_config

类型

对象

属性 类型 描述

操作

字符串

基于正则表达式匹配执行的操作。必须是以下之一：'Replace'、'Keep'、'Drop'、'HashMod'、'LabelMap'、'LabelDrop' 或 'LabelKeep'。默认为：'Replace'

模数

整数

对源标签值的哈希取模。这可以与 'HashMod' 操作结合使用，将 'target_label' 设置为连接的 'source_labels' 的哈希的 '模数'。只有在 sourceLabels 不为空且 action 不是 'LabelKeep' 或 'LabelDrop' 时才有效。

正则表达式

字符串

提取的值匹配的正则表达式。默认为：'(.*)' 除了 'HashMod' 之外的所有操作都需要正则表达式。

替换值

字符串

如果正则表达式匹配，则执行正则表达式替换的替换值。如果操作是 'Replace' 或 'LabelMap'，则需要此项；对于操作 'LabelKeep' 和 'LabelDrop'，则禁止使用此项。可以使用正则表达式捕获组。默认为：'$1'

分隔符

字符串

连接的源标签值之间放置的分隔符。省略时，Prometheus 将使用其默认值 ';'。

源标签

数组 (字符串)

sourceLabels 从现有标签中选择值。它们的内容使用配置的分隔符连接，并针对 'Replace'、'Keep' 和 'Drop' 操作的配置正则表达式进行匹配。'LabelKeep' 和 'LabelDrop' 操作不允许使用。

目标标签

字符串

在 'Replace' 操作中写入结果值的 targetLabel。'Replace' 和 'HashMod' 操作需要此项，'LabelKeep' 和 'LabelDrop' 操作禁止使用此项。可以使用正则表达式捕获组。

.status

描述

status 描述了此 AlertRelabelConfig 对象的当前状态。

类型

对象

属性 类型 描述

条件

数组

conditions 包含有关 AlertRelabelConfig 状态的详细信息，可能为空。

conditions[]

对象

Condition 包含此 API 资源当前状态的一个方面的详细信息。--- 此结构旨在直接用作字段路径 .status.conditions 的数组。例如，类型 FooStatus struct{ // 表示 foo 当前状态的观察结果。 // 已知的 .status.conditions.type 为：“Available”、“Progressing”和“Degraded” // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 其他字段 }

.status.conditions

描述

conditions 包含有关 AlertRelabelConfig 状态的详细信息，可能为空。

类型

数组

.status.conditions[]

描述

Condition 包含此 API 资源当前状态的一个方面的详细信息。--- 此结构旨在直接用作字段路径 .status.conditions 的数组。例如，类型 FooStatus struct{ // 表示 foo 当前状态的观察结果。 // 已知的 .status.conditions.type 为：“Available”、“Progressing”和“Degraded” // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 其他字段 }

类型

对象

必需

  • 最后一次转换时间

  • 消息

  • 原因

  • status

  • 类型

属性 类型 描述

最后一次转换时间

字符串

lastTransitionTime 是条件从一种状态转换到另一种状态的最后时间。这应该是底层条件更改的时间。如果不知道，则可以使用 API 字段更改的时间。

消息

字符串

message 是一个易于理解的消息，指示有关转换的详细信息。这可能是一个空字符串。

观察到的 Generation

整数

observedGeneration 表示设置条件的 .metadata.generation。例如，如果 .metadata.generation 当前为 12，但 .status.conditions[x].observedGeneration 为 9，则该条件相对于实例的当前状态已过期。

原因

字符串

reason 包含一个程序标识符，指示条件最后一次转换的原因。特定条件类型的生产者可以为此字段定义预期的值和含义，以及是否将这些值视为保证的 API。该值应为驼峰式命名字符串。此字段不能为空。

status

字符串

条件的状态，True、False、Unknown 之一。

类型

字符串

条件的类型，使用驼峰式命名法或 foo.example.com/CamelCase。--- 许多 .condition.type 值在资源之间是一致的，例如 Available，但由于任意条件可能很有用（见 .node.status.conditions），因此消除冲突的能力非常重要。它匹配的正则表达式是 (dns1123SubdomainFmt/)?(qualifiedNameFmt)

API 端点

提供以下 API 端点

  • /apis/monitoring.openshift.io/v1/alertrelabelconfigs

    • GET：列出 AlertRelabelConfig 类型的对象

  • /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs

    • DELETE：删除 AlertRelabelConfig 集合

    • GET：列出 AlertRelabelConfig 类型的对象

    • POST：创建 AlertRelabelConfig

  • /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs/{name}

    • DELETE：删除 AlertRelabelConfig

    • GET：读取指定的 AlertRelabelConfig

    • PATCH：部分更新指定的 AlertRelabelConfig

    • PUT：替换指定的 AlertRelabelConfig

  • /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs/{name}/status

    • GET：读取指定 AlertRelabelConfig 的状态

    • PATCH：部分更新指定 AlertRelabelConfig 的状态

    • PUT：替换指定 AlertRelabelConfig 的状态

/apis/monitoring.openshift.io/v1/alertrelabelconfigs

HTTP 方法

GET

描述

列出 AlertRelabelConfig 类型的对象

表 1. HTTP 响应
HTTP 代码 响应体

200 - OK

AlertRelabelConfigList 模式

401 - 未授权

空

/apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs

HTTP 方法

DELETE

描述

删除 AlertRelabelConfig 集合

表 2. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 AlertRelabelConfig 类型的对象

表 3. HTTP 响应
HTTP 代码 响应体

200 - OK

AlertRelabelConfigList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建 AlertRelabelConfig

表 4. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略对象中被静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为对象中被删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 5. 主体参数
参数 类型 描述

主体

AlertRelabelConfig 模式
表 6. HTTP 响应
HTTP 代码 响应体

200 - OK

AlertRelabelConfig 模式

201 - 已创建

AlertRelabelConfig 模式

202 - 已接受

AlertRelabelConfig 模式

401 - 未授权

空

/apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs/{name}

表 7. 全局路径参数
参数 类型 描述

名称

字符串

AlertRelabelConfig 的名称
HTTP 方法

DELETE

描述

删除 AlertRelabelConfig

表 8. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
表 9. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 AlertRelabelConfig

表 10. HTTP 响应
HTTP 代码 响应体

200 - OK

AlertRelabelConfig 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 AlertRelabelConfig

表 11. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略对象中被静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为对象中被删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 12. HTTP 响应
HTTP 代码 响应体

200 - OK

AlertRelabelConfig 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 AlertRelabelConfig

表 13. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略对象中被静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为对象中被删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 14. 主体参数
参数 类型 描述

主体

AlertRelabelConfig 模式
表 15. HTTP 响应
HTTP 代码 响应体

200 - OK

AlertRelabelConfig 模式

201 - 已创建

AlertRelabelConfig 模式

401 - 未授权

空

/apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs/{name}/status

表 16. 全局路径参数
参数 类型 描述

名称

字符串

AlertRelabelConfig 的名称
HTTP 方法

GET

描述

读取指定 AlertRelabelConfig 的状态

表 17. HTTP 响应
HTTP 代码 响应体

200 - OK

AlertRelabelConfig 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定 AlertRelabelConfig 的状态

表 18. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略对象中被静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为对象中被删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 19. HTTP 响应
HTTP 代码 响应体

200 - OK

AlertRelabelConfig 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定 AlertRelabelConfig 的状态

表 20. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略对象中被静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为对象中被删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 21. 请求体参数
参数 类型 描述

主体

AlertRelabelConfig 模式
表 22. HTTP 响应
HTTP 代码 响应体

200 - OK

AlertRelabelConfig 模式

201 - 已创建

AlertRelabelConfig 模式

401 - 未授权

空