14.5. Probe [monitoring.coreos.com/v1]


描述
探测为一组静态目标或入口定义监控。
类型
对象
必填
  • spec

14.5.1. 规格

Expand
属性类型描述

apiVersion

字符串

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

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta_v2

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

spec

对象

Prometheus 为目标发现所需的 Ingress 选择规格。

14.5.1.1. .spec

描述
Prometheus 为目标发现所需的 Ingress 选择规格。
类型
对象
Expand
属性类型描述

授权

对象

此端点的授权部分

basicAuth

对象

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

bearerTokenSecret

对象

要挂载以读取提取目标的 bearer 令牌的 secret。secret 需要与探测位于同一个命名空间中,并由 Prometheus Operator 访问。

interval

字符串

使用配置的 prober 探测目标的时间间隔。如果没有指定 Prometheus 的全局提取间隔,则使用。

jobName

字符串

默认分配给提取指标的作业名称。

labelLimit

整数

对示例接受的标签数的 per-scrape 限制。仅在 Prometheus 版本 2.27.0 及更新版本中有效。

labelNameLengthLimit

整数

针对示例接受的标签名称长度的 per-scrape 限制。仅在 Prometheus 版本 2.27.0 及更新版本中有效。

labelValueLengthLimit

整数

对示例接受的标签值长度的 per-scrape 限制。仅在 Prometheus 版本 2.27.0 及更新版本中有效。

metricRelabelings

array

在 ingestion 前,要应用到示例的 MetricRelabelConfigs。

metricRelabelings[]

对象

RelabelConfig 允许动态重写标签集,在 ingestion 前应用到样本。它定义了 & lt;metric_relabel_configs> - Prometheus 配置的部分。更多信息: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

module

字符串

用于探测到目标的模块。在 blackbox exporter 中配置的模块示例: https://github.com/prometheus/blackbox_exporter/blob/master/example.yml

oauth2

对象

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

prober

对象

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

sampleLimit

整数

SampleLimit 定义每个接受的提取示例数量。

scrapeTimeout

字符串

从 Prometheus exporter 提取指标的超时。

targetLimit

整数

TargetLimit 定义将被接受的提取目标数量的限制。

目标

对象

目标定义使用探测器探测到的一组静态和/或动态发现的目标。

tlsConfig

对象

提取端点时要使用的 TLS 配置。

14.5.1.2. .spec.authorization

描述
此端点的授权部分
类型
对象
Expand
属性类型描述

credentials

对象

包含请求凭证的 secret 密钥

type

字符串

设置身份验证类型。默认为 Bearer,Basic 将导致错误

14.5.1.3. .spec.authorization.credentials

描述
包含请求凭证的 secret 密钥
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.5.1.4. .spec.basicAuth

描述
basicAuth 允许端点通过基本身份验证进行身份验证。更多信息: https://prometheus.io/docs/operating/configuration/#endpoint
类型
对象
Expand
属性类型描述

password

对象

服务监控命名空间中的 secret,其中包含用于身份验证的密码。

username

对象

服务监控命名空间中的 secret,其中包含用于身份验证的用户名。

14.5.1.5. .spec.basicAuth.password

描述
服务监控命名空间中的 secret,其中包含用于身份验证的密码。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.5.1.6. .spec.basicAuth.username

描述
服务监控命名空间中的 secret,其中包含用于身份验证的用户名。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.5.1.7. .spec.bearerTokenSecret

描述
要挂载以读取提取目标的 bearer 令牌的 secret。secret 需要与探测位于同一个命名空间中,并由 Prometheus Operator 访问。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.5.1.8. .spec.metricRelabelings

描述
在 ingestion 前,要应用到示例的 MetricRelabelConfigs。
类型
array

14.5.1.9. .spec.metricRelabelings[]

描述
RelabelConfig 允许动态重写标签集,在 ingestion 前应用到样本。它定义了 & lt;metric_relabel_configs> - Prometheus 配置的部分。更多信息: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
类型
对象
Expand
属性类型描述

action

字符串

根据正则表达式匹配执行的操作。默认为 'replace'

modulus

整数

modulus 用来获取源标签值的哈希值。

regex

字符串

匹配提取值的正则表达式。默认为 '(DSL)'

替换

字符串

如果正则表达式匹配,则执行 regex replace 的替换值。正则表达式捕获组可用。默认为 '$1'

分隔符

字符串

在串联的源标签值之间放置的分隔符。默认为 ';'。

sourceLabels

数组(字符串)

源标签从现有标签中选择值。它们的内容使用配置的分隔符进行串联,并与替换、保留和丢弃操作配置的正则表达式匹配。

targetLabel

字符串

在 replace 操作中写入结果值的标签。这是替换操作所必需的。正则表达式捕获组可用。

14.5.1.10. .spec.oauth2

描述
用于 URL 的 OAuth2。仅在 Prometheus 版本 2.27.0 及更新版本中有效。
类型
对象
必填
  • clientId
  • clientSecret
  • tokenUrl
Expand
属性类型描述

clientId

对象

包含 OAuth2 客户端 ID 的 secret 或 configmap

clientSecret

对象

包含 OAuth2 客户端 secret 的 secret

endpointParams

对象(字符串)

附加到令牌 URL 的参数

范围

数组(字符串)

用于令牌请求的 OAuth2 范围

tokenUrl

字符串

从中获取令牌的 URL

14.5.1.11. .spec.oauth2.clientId

描述
包含 OAuth2 客户端 ID 的 secret 或 configmap
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

14.5.1.12. .spec.oauth2.clientId.configMap

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.5.1.13. .spec.oauth2.clientId.secret

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.5.1.14. .spec.oauth2.clientSecret

描述
包含 OAuth2 客户端 secret 的 secret
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.5.1.15. .spec.prober

描述
用于探测目标的探测器规格。prober.URL 参数是必需的。如果留空,则无法探测目标。
类型
对象
必填
  • url
Expand
属性类型描述

path

字符串

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

proxyUrl

字符串

可选 ProxyURL。

scheme

字符串

用于提取的 HTTP 方案。默认为 http

url

字符串

探测器的强制 URL。

14.5.1.16. .spec.targets

描述
目标定义使用探测器探测到的一组静态和/或动态发现的目标。
类型
对象
Expand
属性类型描述

ingress

对象

Ingress 定义一组动态发现的入口对象,用于探测主机。

staticConfig

对象

staticConfig 定义用于探测的静态目标。更多信息: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config

14.5.1.17. .spec.targets.ingress

描述
Ingress 定义一组动态发现的入口对象,用于探测主机。
类型
对象
Expand
属性类型描述

namespaceSelector

对象

根据命名空间选择 Ingress 对象。

relabelingConfigs

array

在 ingestion 前,将 relabelConfigs 应用到示例。更多信息: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelingConfigs[]

对象

RelabelConfig 允许动态重写标签集,在 ingestion 前应用到样本。它定义了 & lt;metric_relabel_configs> - Prometheus 配置的部分。更多信息: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

selector

对象

根据标签选择 Ingress 对象。

14.5.1.18. .spec.targets.ingress.namespaceSelector

描述
根据命名空间选择 Ingress 对象。
类型
对象
Expand
属性类型描述

any

布尔值

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

matchNames

数组(字符串)

命名空间名称列表。

14.5.1.19. .spec.targets.ingress.relabelingConfigs

描述
在 ingestion 前,将 relabelConfigs 应用到示例。更多信息: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
类型
array

14.5.1.20. .spec.targets.ingress.relabelingConfigs[]

描述
RelabelConfig 允许动态重写标签集,在 ingestion 前应用到样本。它定义了 & lt;metric_relabel_configs> - Prometheus 配置的部分。更多信息: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
类型
对象
Expand
属性类型描述

action

字符串

根据正则表达式匹配执行的操作。默认为 'replace'

modulus

整数

modulus 用来获取源标签值的哈希值。

regex

字符串

匹配提取值的正则表达式。默认为 '(DSL)'

替换

字符串

如果正则表达式匹配,则执行 regex replace 的替换值。正则表达式捕获组可用。默认为 '$1'

分隔符

字符串

在串联的源标签值之间放置的分隔符。默认为 ';'。

sourceLabels

数组(字符串)

源标签从现有标签中选择值。它们的内容使用配置的分隔符进行串联,并与替换、保留和丢弃操作配置的正则表达式匹配。

targetLabel

字符串

在 replace 操作中写入结果值的标签。这是替换操作所必需的。正则表达式捕获组可用。

14.5.1.21. .spec.targets.ingress.selector

描述
根据标签选择 Ingress 对象。
类型
对象
Expand
属性类型描述

matchExpressions

array

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchExpressions[]

对象

标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

14.5.1.22. .spec.targets.ingress.selector.matchExpressions

描述
matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型
array
描述
标签选择器要求是一个选择器,其中包含与键和值相关的值、键和值。
类型
对象
必填
  • key
  • operator
Expand
属性类型描述

key

字符串

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

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

数组(字符串)

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

14.5.1.24. .spec.targets.staticConfig

描述
staticConfig 定义用于探测的静态目标。更多信息: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config
类型
对象
Expand
属性类型描述

labels

对象(字符串)

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

relabelingConfigs

array

在 ingestion 前,将 relabelConfigs 应用到示例。更多信息: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelingConfigs[]

对象

RelabelConfig 允许动态重写标签集,在 ingestion 前应用到样本。它定义了 & lt;metric_relabel_configs> - Prometheus 配置的部分。更多信息: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

static

数组(字符串)

目标是使用配置的探测器探测的 URL 列表。

14.5.1.25. .spec.targets.staticConfig.relabelingConfigs

描述
在 ingestion 前,将 relabelConfigs 应用到示例。更多信息: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
类型
array

14.5.1.26. .spec.targets.staticConfig.relabelingConfigs[]

描述
RelabelConfig 允许动态重写标签集,在 ingestion 前应用到样本。它定义了 & lt;metric_relabel_configs> - Prometheus 配置的部分。更多信息: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
类型
对象
Expand
属性类型描述

action

字符串

根据正则表达式匹配执行的操作。默认为 'replace'

modulus

整数

modulus 用来获取源标签值的哈希值。

regex

字符串

匹配提取值的正则表达式。默认为 '(DSL)'

替换

字符串

如果正则表达式匹配,则执行 regex replace 的替换值。正则表达式捕获组可用。默认为 '$1'

分隔符

字符串

在串联的源标签值之间放置的分隔符。默认为 ';'。

sourceLabels

数组(字符串)

源标签从现有标签中选择值。它们的内容使用配置的分隔符进行串联,并与替换、保留和丢弃操作配置的正则表达式匹配。

targetLabel

字符串

在 replace 操作中写入结果值的标签。这是替换操作所必需的。正则表达式捕获组可用。

14.5.1.27. .spec.tlsConfig

描述
提取端点时要使用的 TLS 配置。
类型
对象
Expand
属性类型描述

ca

对象

包含用于目标的 CA 证书的结构。

cert

对象

包含目标客户端证书文件的结构。

insecureSkipVerify

布尔值

禁用目标证书验证。

keySecret

对象

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

serverName

字符串

用于验证目标的主机名。

14.5.1.28. .spec.tlsConfig.ca

描述
包含用于目标的 CA 证书的结构。
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

14.5.1.29. .spec.tlsConfig.ca.configMap

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.5.1.30. .spec.tlsConfig.ca.secret

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.5.1.31. .spec.tlsConfig.cert

描述
包含目标客户端证书文件的结构。
类型
对象
Expand
属性类型描述

configMap

对象

包含用于目标数据的 ConfigMap。

secret

对象

包含用于目标的数据的 secret。

14.5.1.32. .spec.tlsConfig.cert.configMap

描述
包含用于目标数据的 ConfigMap。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

14.5.1.33. .spec.tlsConfig.cert.secret

描述
包含用于目标的数据的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.5.1.34. .spec.tlsConfig.keySecret

描述
包含目标客户端密钥文件的 secret。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

14.5.2. API 端点

可用的 API 端点如下:

  • /apis/monitoring.coreos.com/v1/probes

    • GET: 列出探测的对象
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes

    • DELETE :删除探测的集合
    • GET: 列出探测的对象
    • POST :创建探测
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name}

    • DELETE :删除探测
    • GET: 读取指定的探测
    • PATCH :部分更新指定的探测
    • PUT :替换指定的探测

14.5.2.1. /apis/monitoring.coreos.com/v1/probes

Expand
表 14.73. 全局查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。

当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。

pretty

字符串

如果 'true',则输出被用户友善。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

HTTP 方法
GET
描述
列出探测的对象
Expand
表 14.74. HTTP 响应
HTTP 代码响应正文

200 - OK

ProbeList 模式

401 - Unauthorized

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

namespace

字符串

对象名称和身份验证范围,如团队和项目

Expand
表 14.76. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
DELETE
描述
删除探测集合
Expand
表 14.77. 查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。

当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

Expand
表 14.78. HTTP 响应
HTTP 代码响应正文

200 - OK

Status_v2 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出探测的对象
Expand
表 14.79. 查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。

当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

Expand
表 14.80. HTTP 响应
HTTP 代码响应正文

200 - OK

ProbeList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建探测
Expand
表 14.81. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 14.82. 主体参数
参数类型描述

正文(body)

Probe 模式

 
Expand
表 14.83. HTTP 响应
HTTP 代码响应正文

200 - OK

Probe 模式

201 - Created

Probe 模式

202 - Accepted

Probe 模式

401 - Unauthorized

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

name

字符串

探测的名称

namespace

字符串

对象名称和身份验证范围,如团队和项目

Expand
表 14.85. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
DELETE
描述
删除探测
Expand
表 14.86. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

gracePeriodSeconds

整数

应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值是 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。

orphanDependents

布尔值

弃用:请使用 PropagationPolicy,此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false,"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置两者。

propagationPolicy

字符串

是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置,但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为: 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系; 'Foreground' - 一个删除前台所有依赖的级联策略。

Expand
表 14.87. 主体参数
参数类型描述

正文(body)

DeleteOptions_v2 schema

 
Expand
表 14.88. HTTP 响应
HTTP 代码响应正文

200 - OK

Status_v2 模式

202 - Accepted

Status_v2 模式

401 - Unauthorized

HTTP 方法
GET
描述
读取指定的探测
Expand
表 14.89. 查询参数
参数类型描述

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

Expand
表 14.90. HTTP 响应
HTTP 代码响应正文

200 - OK

Probe 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的探测
Expand
表 14.91. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 14.92. 主体参数
参数类型描述

正文(body)

Patch 模式

 
Expand
表 14.93. HTTP 响应
HTTP 代码响应正文

200 - OK

Probe 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的探测
Expand
表 14.94. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 14.95. 主体参数
参数类型描述

正文(body)

Probe 模式

 
Expand
表 14.96. HTTP 响应
HTTP 代码响应正文

200 - OK

Probe 模式

201 - Created

Probe 模式

401 - Unauthorized

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat