探针 [monitoring.coreos.com/v1]

授权

对象

此端点的授权部分

basicAuth

对象

BasicAuth 允许端点通过基本身份验证进行身份验证。更多信息：https://prometheus.ac.cn/docs/operating/configuration/#endpoint

bearerTokenSecret

对象

要挂载以读取用于抓取目标的 bearer 令牌的密钥。该密钥需要与探测器位于相同的命名空间中，并且 Prometheus Operator 可以访问。

interval

字符串

使用配置的探测器探测目标的间隔。如果未指定，则使用 Prometheus 的全局抓取间隔。

jobName

字符串

默认情况下分配给抓取指标的作业名称。

keepDroppedTargets

整数

每次抓取时，由重新标记丢弃的目标数量的上限将保留在内存中。0 表示无限制。

它需要 Prometheus >= v2.47.0。

labelLimit

整数

每次抓取时，将被接受的样本标签数量的上限。仅在 Prometheus 版本 2.27.0 及更高版本中有效。

labelNameLengthLimit

整数

每次抓取时，将被接受的样本标签名称长度的上限。仅在 Prometheus 版本 2.27.0 及更高版本中有效。

labelValueLengthLimit

整数

每次抓取时，将被接受的样本标签值长度的上限。仅在 Prometheus 版本 2.27.0 及更高版本中有效。

metricRelabelings

数组

在摄取之前应用于样本的 MetricRelabelConfigs。

metricRelabelings[]

对象

RelabelConfig 允许动态重写目标、告警、抓取样本和远程写入样本的标签集。

更多信息：https://prometheus.ac.cn/docs/prometheus/latest/configuration/configuration/#relabel_config

模块

字符串

用于探测的模块，指定如何探测目标。Blackbox exporter 中模块配置示例：https://github.com/prometheus/blackbox_exporter/blob/master/example.yml

OAuth2

对象

用于 URL 的 OAuth2。仅在 Prometheus 2.27.0 及更高版本中有效。

探测器 (prober)

对象

用于探测目标的探测器规范。prober.URL 参数是必需的。如果为空，则无法探测目标。

样本限制 (sampleLimit)

整数

SampleLimit 定义每次抓取可接受的抓取样本数量限制。

抓取类 (scrapeClass)

字符串

要应用的抓取类。

抓取协议 (scrapeProtocols)

数组 (字符串)

scrapeProtocols 定义在抓取期间要协商的协议。它按优先级顺序（从高到低）告知客户端 Prometheus 支持的协议。

如果未设置，Prometheus 将使用其默认值。

需要 Prometheus >= v2.49.0。

抓取超时 (scrapeTimeout)

字符串

从 Prometheus exporter 抓取指标的超时时间。如果未指定，则使用 Prometheus 全局抓取超时时间。

目标限制 (targetLimit)

整数

TargetLimit 定义可接受的已抓取目标数量限制。

目标 (targets)

对象

Targets 定义一组要探测的静态或动态发现的目标。

TLS 配置 (tlsConfig)

对象

抓取端点时使用的 TLS 配置。

凭据 (credentials)

对象

选择命名空间中包含身份验证凭据的 Secret 的键。

类型 (type)

字符串

定义身份验证类型。值不区分大小写。

"Basic" 不是受支持的值。

默认值："Bearer"

键 (key)

字符串

要选择的密钥。必须是有效的密钥。

名称 (name)

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此处为空值的此类型实例几乎肯定是不正确的。TODO：添加其他有用字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names TODO：当 controller-gen 不需要时删除kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

可选 (optional)

布尔值

指定是否必须定义 Secret 或其密钥。

密码 (password)

对象

password 指定包含身份验证密码的 Secret 的键。

用户名 (username)

对象

username 指定包含身份验证用户名的 Secret 的键。

键 (key)

字符串

要选择的密钥。必须是有效的密钥。

名称 (name)

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此处为空值的此类型实例几乎肯定是不正确的。TODO：添加其他有用字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names TODO：当 controller-gen 不需要时删除kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

可选 (optional)

布尔值

指定是否必须定义 Secret 或其密钥。

键 (key)

字符串

要选择的密钥。必须是有效的密钥。

名称 (name)

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此处为空值的此类型实例几乎肯定是不正确的。TODO：添加其他有用字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names TODO：当 controller-gen 不需要时删除kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

可选 (optional)

布尔值

指定是否必须定义 Secret 或其密钥。

键 (key)

字符串

要选择的密钥。必须是有效的密钥。

名称 (name)

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此处为空值的此类型实例几乎肯定是不正确的。TODO：添加其他有用字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names TODO：当 controller-gen 不需要时删除kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

可选 (optional)

布尔值

指定是否必须定义 Secret 或其密钥。

操作 (action)

字符串

基于正则表达式匹配执行的操作。

Uppercase 和 Lowercase 操作需要 Prometheus >= v2.36.0。DropEqual 和 KeepEqual 操作需要 Prometheus >= v2.41.0。

默认值："Replace"

模数 (modulus)

整数

对源标签值的哈希取模。

仅当操作为HashMod时适用。

正则表达式 (regex)

字符串

与提取的值匹配的正则表达式。

替换 (replacement)

字符串

如果正则表达式匹配，则执行 Replace 操作的替换值。

可以使用正则表达式捕获组。

分隔符 (separator)

字符串

分隔符是连接的 SourceLabels 之间的字符串。

源标签 (sourceLabels)

数组 (字符串)

源标签从现有标签中选择值。它们的内容使用配置的分隔符连接，并与配置的正则表达式匹配。

目标标签 (targetLabel)

字符串

将结果字符串写入替换中的标签。

对于Replace、HashMod、Lowercase、Uppercase、KeepEqual 和 DropEqual 操作，它是强制性的。

可以使用正则表达式捕获组。

客户端 ID (clientId)

对象

clientId 指定包含 OAuth2 客户端 ID 的 Secret 或 ConfigMap 的键。

客户端密钥 (clientSecret)

对象

clientSecret 指定包含 OAuth2 客户端密钥的 Secret 的键。

端点参数 (endpointParams)

对象 (字符串)

endpointParams 配置要附加到令牌 URL 的 HTTP 参数。

作用域 (scopes)

数组 (字符串)

scopes 定义用于令牌请求的 OAuth2 作用域。

令牌 URL (tokenUrl)

字符串

tokenURL 配置从中获取令牌的 URL。

ConfigMap

对象

包含要用于目标的数据的 ConfigMap。

Secret

对象

包含要用于目标的数据的 Secret。

键 (key)

字符串

要选择的键。

名称 (name)

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此处为空值的此类型实例几乎肯定是不正确的。TODO：添加其他有用字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names TODO：当 controller-gen 不需要时删除kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

可选 (optional)

布尔值

指定是否必须定义 ConfigMap 或其密钥。

键 (key)

字符串

要选择的密钥。必须是有效的密钥。

名称 (name)

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此处为空值的此类型实例几乎肯定是不正确的。TODO：添加其他有用字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names TODO：当 controller-gen 不需要时删除kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

可选 (optional)

布尔值

指定是否必须定义 Secret 或其密钥。

键 (key)

字符串

要选择的密钥。必须是有效的密钥。

名称 (name)

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此处为空值的此类型实例几乎肯定是不正确的。TODO：添加其他有用字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names TODO：当 controller-gen 不需要时删除kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

可选 (optional)

布尔值

指定是否必须定义 Secret 或其密钥。

路径 (path)

字符串

从中收集指标的路径。默认为/probe。

代理 URL (proxyUrl)

字符串

可选的 ProxyURL。

方案 (scheme)

字符串

用于抓取的 HTTP 方案。除非你通过重新标记重写scheme标签，否则预期值为http和https。如果为空，Prometheus 将使用默认值http。

URL

字符串

探测器的必填 URL。

入口 (ingress)

对象

ingress 定义要探测的 Ingress 对象和重新标记配置。如果也定义了staticConfig，则staticConfig优先。

静态配置 (staticConfig)

对象

staticConfig 定义要探测的目标的静态列表和重新标记配置。如果也定义了ingress，则staticConfig优先。更多信息：https://prometheus.ac.cn/docs/prometheus/latest/configuration/configuration/#static_config。

命名空间选择器 (namespaceSelector)

对象

从中选择 Ingress 对象的命名空间。

重新标记配置 (relabelingConfigs)

数组

在抓取目标之前应用于目标标签集的 RelabelConfigs。原始入口地址可通过tmp_prometheus_ingress_address标签获得。它可用于自定义探测的 URL。原始抓取作业的名称可通过tmp_prometheus_job_name标签获得。更多信息：https://prometheus.ac.cn/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelingConfigs[]

对象

RelabelConfig 允许动态重写目标、告警、抓取样本和远程写入样本的标签集。

更多信息：https://prometheus.ac.cn/docs/prometheus/latest/configuration/configuration/#relabel_config

选择器 (selector)

对象

用于选择 Ingress 对象的选择器。

任意 (any)

布尔值

布尔值，描述是否选择所有命名空间，而不是限制它们的列表。

匹配名称 (matchNames)

数组 (字符串)

要从中选择的命名空间名称列表。

操作 (action)

字符串

基于正则表达式匹配执行的操作。

Uppercase 和 Lowercase 操作需要 Prometheus >= v2.36.0。DropEqual 和 KeepEqual 操作需要 Prometheus >= v2.41.0。

默认值："Replace"

模数 (modulus)

整数

对源标签值的哈希取模。

仅当操作为HashMod时适用。

正则表达式 (regex)

字符串

与提取的值匹配的正则表达式。

替换 (replacement)

字符串

如果正则表达式匹配，则执行 Replace 操作的替换值。

可以使用正则表达式捕获组。

分隔符 (separator)

字符串

分隔符是连接的 SourceLabels 之间的字符串。

源标签 (sourceLabels)

数组 (字符串)

源标签从现有标签中选择值。它们的内容使用配置的分隔符连接，并与配置的正则表达式匹配。

目标标签 (targetLabel)

字符串

将结果字符串写入替换中的标签。

对于Replace、HashMod、Lowercase、Uppercase、KeepEqual 和 DropEqual 操作，它是强制性的。

可以使用正则表达式捕获组。

matchExpressions

数组

matchExpressions 是标签选择器要求的列表。这些要求使用 AND 运算符连接。

matchExpressions[]

对象

标签选择器要求是一个包含值、键和将键和值关联起来的运算符的选择器。

matchLabels

对象 (字符串)

matchLabels 是一个 {key,value} 对的映射。matchLabels 映射中的单个 {key,value} 等效于 matchExpressions 的一个元素，其 key 字段为“key”，运算符为“In”，而 values 数组仅包含“value”。这些要求使用 AND 运算符连接。

键 (key)

字符串

key 是选择器应用到的标签键。

operator

字符串

operator 表示键与一组值之间的关系。有效的运算符为 In、NotIn、Exists 和 DoesNotExist。

values

数组 (字符串)

values 是一个字符串值的数组。如果运算符为 In 或 NotIn，则 values 数组必须非空。如果运算符为 Exists 或 DoesNotExist，则 values 数组必须为空。此数组在策略性合并补丁期间会被替换。

labels

对象 (字符串)

分配给从目标抓取的所有指标的标签。

重新标记配置 (relabelingConfigs)

数组

在目标被抓取之前应用于目标标签集的 RelabelConfigs。更多信息：https://prometheus.ac.cn/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelingConfigs[]

对象

RelabelConfig 允许动态重写目标、告警、抓取样本和远程写入样本的标签集。

更多信息：https://prometheus.ac.cn/docs/prometheus/latest/configuration/configuration/#relabel_config

static

数组 (字符串)

要探测的主机列表。

操作 (action)

字符串

基于正则表达式匹配执行的操作。

Uppercase 和 Lowercase 操作需要 Prometheus >= v2.36.0。DropEqual 和 KeepEqual 操作需要 Prometheus >= v2.41.0。

默认值："Replace"

模数 (modulus)

整数

对源标签值的哈希取模。

仅当操作为HashMod时适用。

正则表达式 (regex)

字符串

与提取的值匹配的正则表达式。

替换 (replacement)

字符串

如果正则表达式匹配，则执行 Replace 操作的替换值。

可以使用正则表达式捕获组。

分隔符 (separator)

字符串

分隔符是连接的 SourceLabels 之间的字符串。

源标签 (sourceLabels)

数组 (字符串)

源标签从现有标签中选择值。它们的内容使用配置的分隔符连接，并与配置的正则表达式匹配。

目标标签 (targetLabel)

字符串

将结果字符串写入替换中的标签。

对于Replace、HashMod、Lowercase、Uppercase、KeepEqual 和 DropEqual 操作，它是强制性的。

可以使用正则表达式捕获组。

ca

对象

验证服务器证书时使用的证书颁发机构。

cert

对象

进行客户端身份验证时要呈现的客户端证书。

insecureSkipVerify

布尔值

禁用目标证书验证。

keySecret

对象

包含目标客户端密钥文件的密钥。

serverName

字符串

用于验证目标的主机名。

ConfigMap

对象

包含要用于目标的数据的 ConfigMap。

Secret

对象

包含要用于目标的数据的 Secret。

键 (key)

字符串

要选择的键。

名称 (name)

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此处为空值的此类型实例几乎肯定是不正确的。TODO：添加其他有用字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names TODO：当 controller-gen 不需要时删除kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

可选 (optional)

布尔值

指定是否必须定义 ConfigMap 或其密钥。

键 (key)

字符串

要选择的密钥。必须是有效的密钥。

名称 (name)

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此处为空值的此类型实例几乎肯定是不正确的。TODO：添加其他有用字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names TODO：当 controller-gen 不需要时删除kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

可选 (optional)

布尔值

指定是否必须定义 Secret 或其密钥。

ConfigMap

对象

包含要用于目标的数据的 ConfigMap。

Secret

对象

包含要用于目标的数据的 Secret。

键 (key)

字符串

要选择的键。

名称 (name)

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此处为空值的此类型实例几乎肯定是不正确的。TODO：添加其他有用字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names TODO：当 controller-gen 不需要时删除kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

可选 (optional)

布尔值

指定是否必须定义 ConfigMap 或其密钥。

键 (key)

字符串

要选择的密钥。必须是有效的密钥。

名称 (name)

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此处为空值的此类型实例几乎肯定是不正确的。TODO：添加其他有用字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names TODO：当 controller-gen 不需要时删除kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

可选 (optional)

布尔值

指定是否必须定义 Secret 或其密钥。

键 (key)

字符串

要选择的密钥。必须是有效的密钥。

名称 (name)

字符串

引用的名称。此字段实际上是必需的，但由于向后兼容性，允许为空。此处为空值的此类型实例几乎肯定是不正确的。TODO：添加其他有用字段。apiVersion、kind、uid？更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names TODO：当 controller-gen 不需要时删除kubebuilder:default https://github.com/kubernetes-sigs/kubebuilder/issues/3896。

可选 (optional)

布尔值

指定是否必须定义 Secret 或其密钥。

200 - OK

ProbeList 模式

401 - 未授权

空

200 - OK

Status 模式

401 - 未授权

空

200 - OK

ProbeList 模式

401 - 未授权

空

dryRun

字符串

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

fieldValidation

字符串

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

body

Probe 模式

200 - OK

Probe 模式

201 - 已创建

Probe 模式

202 - 已接受

Probe 模式

401 - 未授权

空

名称 (name)

字符串

Probe 的名称

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空

200 - OK

Probe 模式

401 - 未授权

空

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

Probe 模式

401 - 未授权

空

dryRun

字符串

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

fieldValidation

字符串

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

body

Probe 模式

200 - OK

Probe 模式

201 - 已创建

Probe 模式

401 - 未授权

空