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


Description
プローブは、一連の静的ターゲットまたは入力の監視を定義します。
タイプ
object
必須
  • spec

14.5.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

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

object

Prometheus によるターゲット発見のための望ましいイングレス選択の仕様。

14.5.1.1. .spec

Description
Prometheus によるターゲット発見のための望ましいイングレス選択の仕様。
タイプ
object
Expand
プロパティータイプDescription

認可

object

このエンドポイントの承認セクション

basicAuth

object

BasicAuth を使用すると、エンドポイントは基本認証を介して認証できます。詳細: https://prometheus.io/docs/operating/configuration/#endpoint

bearerTokenSecret

object

ターゲットをスクレイピングするためのベアラトークンを読み取るためにマウントする秘密。シークレットは、プローブと同じ名前空間にあり、PrometheusOperator からアクセスできる必要があります。

interval

string

設定されたプローバーを使用してターゲットがプローブされる間隔。指定しない場合、Prometheus のグローバルスクレイプ間隔が使用されます。

jobName

string

デフォルトでスクレイプされたメトリックに割り当てられたジョブ名。

labelLimit

integer

サンプルに受け入れられるラベルの数のスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。

labelNameLengthLimit

integer

サンプルで受け入れられるラベル名の長さのスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。

labelValueLengthLimit

integer

サンプルに受け入れられるラベル値の長さのスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。

metricRelabelings

array

取り込み前にサンプルに適用する MetricRelabelConfigs。

metricRelabelings[]

object

RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

module

string

ターゲットをプローブする方法を指定するプローブに使用するモジュール。ブラックボックスエクスポーターでのモジュール設定の例: https://github.com/prometheus/blackbox_exporter/blob/master/example.yml

oauth2

object

URL の OAuth2。Prometheus バージョン 2.27.0 以降でのみ有効です。

prober

object

ターゲットのプロービングに使用するプローバーの仕様。prober.URL パラメーターは必須です。空のままにすると、ターゲットをプローブできません。

sampleLimit

integer

SampleLimit は、受け入れられるスクレイプされたサンプルの数に対するスクレイプごとの制限を定義します。

scrapeTimeout

string

Prometheus エクスポーターからメトリックをスクレイピングするためのタイムアウト。

targetLimit

integer

TargetLimit は、受け入れられるスクレイプされたターゲットの数の制限を定義します。

ターゲット

object

ターゲットは、プローバーを使用してプローブされる静的および/または動的に検出されたターゲットのセットを定義します。

tlsConfig

object

エンドポイントをスクレイピングするときに使用する TLS 設定。

14.5.1.2. .spec.authorization

Description
このエンドポイントの承認セクション
タイプ
object
Expand
プロパティータイプDescription

credentials

object

リクエストのクレデンシャルを含むシークレットのキー

type

string

認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします

14.5.1.3. .spec.authorization.credentials

Description
リクエストのクレデンシャルを含むシークレットのキー
タイプ
object
必須
  • key
Expand
プロパティータイプDescription

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

14.5.1.4. .spec.basicAuth

Description
BasicAuth を使用すると、エンドポイントは基本認証を介して認証できます。詳細: https://prometheus.io/docs/operating/configuration/#endpoint
タイプ
object
Expand
プロパティータイプ説明

password

object

認証用のパスワードを含むサービスモニター名前空間のシークレット。

username

object

認証用のユーザー名を含むサービスモニター名前空間のシークレット。

14.5.1.5. .spec.basicAuth.password

Description
認証用のパスワードを含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティータイプDescription

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

14.5.1.6. .spec.basicAuth.username

Description
認証用のユーザー名を含むサービスモニター名前空間のシークレット。
タイプ
object
必須
  • key
Expand
プロパティータイプDescription

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

14.5.1.7. .spec.bearerTokenSecret

Description
ターゲットをスクレイピングするためのベアラトークンを読み取るためにマウントする秘密。シークレットは、プローブと同じ名前空間にあり、PrometheusOperator からアクセスできる必要があります。
タイプ
object
必須
  • key
Expand
プロパティータイプDescription

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

14.5.1.8. .spec.metricRelabelings

Description
取り込み前にサンプルに適用する MetricRelabelConfigs。
タイプ
array

14.5.1.9. .spec.metricRelabelings[]

Description
RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
タイプ
object
Expand
プロパティータイプDescription

action

string

正規表現のマッチングに基づいて実行するアクション。デフォルトは置換です

modulus

integer

ソースラベル値のハッシュを取得するためのモジュラス。

regex

string

抽出された値が一致する正規表現。デフォルトは (.*) です。

replacement

string

正規表現が一致する場合に正規表現置換が実行される置換値。正規表現キャプチャグループが利用可能です。デフォルトは $1 です。

separator

string

連結されたソースラベル値の間に配置されたセパレータ。デフォルトは ';' です。

sourceLabels

array (string)

ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレーターを使用して連結され、置換、保持、および削除アクションの設定された正規表現と照合されます。

targetLabel

string

結果の値が置換アクションで書き込まれるラベル。置換アクションには必須です。正規表現キャプチャグループが利用可能です。

14.5.1.10. .spec.oauth2

Description
URL の OAuth2。Prometheus バージョン 2.27.0 以降でのみ有効です。
タイプ
object
必須
  • clientId
  • clientSecret
  • tokenUrl
Expand
プロパティータイプDescription

clientId

object

OAuth2 クライアント ID を含むシークレットまたは設定マップ

clientSecret

object

OAuth2 クライアントシークレットを含むシークレット

endpointParams

object (string)

トークン URL に追加するパラメーター

scopes

array (string)

トークンリクエストに使用される OAuth2 スコープ

tokenUrl

string

トークンをフェッチする URL

14.5.1.11. .spec.oauth2.clientId

Description
OAuth2 クライアント ID を含むシークレットまたは設定マップ
タイプ
object
Expand
プロパティータイプDescription

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

14.5.1.12. .spec.oauth2.clientId.configMap

Description
ターゲットに使用するデータを含む ConfigMap。
タイプ
object
必須
  • key
Expand
プロパティータイプDescription

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

14.5.1.13. .spec.oauth2.clientId.secret

Description
ターゲットに使用するデータを含むシークレット。
タイプ
object
必須
  • key
Expand
プロパティータイプDescription

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

14.5.1.14. .spec.oauth2.clientSecret

Description
OAuth2 クライアントシークレットを含むシークレット
タイプ
object
必須
  • key
Expand
プロパティータイプDescription

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

14.5.1.15. .spec.prober

Description
ターゲットのプロービングに使用するプローバーの仕様。prober.URL パラメーターは必須です。空のままにすると、ターゲットをプローブできません。
タイプ
object
必須
  • url
Expand
プロパティータイプDescription

path

string

メトリックを収集するためのパス。デフォルトは /probe です。

proxyUrl

string

オプションの ProxyURL。

scheme

string

スクレイピングに使用する HTTP スキーム。デフォルトは http です。

url

string

プローバーの必須 URL。

14.5.1.16. .spec.targets

Description
ターゲットは、プローバーを使用してプローブされる静的および/または動的に検出されたターゲットのセットを定義します。
タイプ
object
Expand
プロパティータイプ説明

ingress

object

Ingress は、ホストがプロービングの対象と見なされる動的に検出されたイングレスオブジェクトのセットを定義します。

staticConfig

object

StaticConfig は、プロービングの対象となる静的ターゲットを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#statuc_config

14.5.1.17. .spec.targets.ingress

Description
Ingress は、ホストがプロービングの対象と見なされる動的に検出されたイングレスオブジェクトのセットを定義します。
タイプ
object
Expand
プロパティータイプDescription

namespaceSelector

object

名前空間で Ingress オブジェクトを選択します。

relabelingConfigs

array

取り込み前にサンプルに適用する RelabelConfigs。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelingConfigs[]

object

RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

selector

object

ラベルで入力オブジェクトを選択します。

14.5.1.18. .spec.targets.ingress.namespaceSelector

Description
名前空間で Ingress オブジェクトを選択します。
タイプ
object
Expand
プロパティータイプDescription

any

ブール値

それらを制限するリストとは対照的に、すべての名前空間が選択されているかどうかを説明するブール値。

matchNames

array (string)

名前空間名のリスト。

14.5.1.19. .spec.targets.ingress.relabelingConfigs

Description
取り込み前にサンプルに適用する RelabelConfigs。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
タイプ
array

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

Description
RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
タイプ
object
Expand
プロパティータイプDescription

action

string

正規表現のマッチングに基づいて実行するアクション。デフォルトは置換です

modulus

integer

ソースラベル値のハッシュを取得するためのモジュラス。

regex

string

抽出された値が一致する正規表現。デフォルトは (.*) です。

replacement

string

正規表現が一致する場合に正規表現置換が実行される置換値。正規表現キャプチャグループが利用可能です。デフォルトは $1 です。

separator

string

連結されたソースラベル値の間に配置されたセパレータ。デフォルトは ';' です。

sourceLabels

array (string)

ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレーターを使用して連結され、置換、保持、および削除アクションの設定された正規表現と照合されます。

targetLabel

string

結果の値が置換アクションで書き込まれるラベル。置換アクションには必須です。正規表現キャプチャグループが利用可能です。

14.5.1.21. .spec.targets.ingress.selector

Description
ラベルで入力オブジェクトを選択します。
タイプ
object
Expand
プロパティータイプDescription

matchExpressions

array

matchExpressions はラベルセレクターの要件の一覧です。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。MatchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには key、演算子には In、値配列には value のみが含まれます。要件は AND で結合されます。

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

Description
matchExpressions はラベルセレクターの要件の一覧です。要件は AND で結合されます。
タイプ
array

14.5.1.23. .spec.targets.ingress.selector.matchExpressions[]

Description
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
タイプ
object
必須
  • key
  • operator
Expand
プロパティータイプDescription

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

14.5.1.24. .spec.targets.staticConfig

Description
StaticConfig は、プロービングの対象となる静的ターゲットを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#statuc_config
タイプ
object
Expand
プロパティータイプDescription

labels

object (string)

ターゲットからスクレイプされたすべてのメトリックに割り当てられたラベル。

relabelingConfigs

array

取り込み前にサンプルに適用する RelabelConfigs。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

relabelingConfigs[]

object

RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs

static

array (string)

ターゲットは、設定されたプローバーを使用してプロービングする URL のリストです。

14.5.1.25. .spec.targets.staticConfig.relabelingConfigs

Description
取り込み前にサンプルに適用する RelabelConfigs。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
タイプ
array

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

Description
RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の <metric_relabel_configs> セクションを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs
タイプ
object
Expand
プロパティータイプDescription

action

string

正規表現のマッチングに基づいて実行するアクション。デフォルトは置換です

modulus

integer

ソースラベル値のハッシュを取得するためのモジュラス。

regex

string

抽出された値が一致する正規表現。デフォルトは (.*) です。

replacement

string

正規表現が一致する場合に正規表現置換が実行される置換値。正規表現キャプチャグループが利用可能です。デフォルトは $1 です。

separator

string

連結されたソースラベル値の間に配置されたセパレータ。デフォルトは ';' です。

sourceLabels

array (string)

ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレーターを使用して連結され、置換、保持、および削除アクションの設定された正規表現と照合されます。

targetLabel

string

結果の値が置換アクションで書き込まれるラベル。置換アクションには必須です。正規表現キャプチャグループが利用可能です。

14.5.1.27. .spec.tlsConfig

Description
エンドポイントをスクレイピングするときに使用する TLS 設定。
タイプ
object
Expand
プロパティータイプDescription

ca

object

ターゲットに使用する CA 証明書を含む構造体。

cert

object

ターゲットのクライアント証明書ファイルを含む構造体。

insecureSkipVerify

ブール値

ターゲット証明書の検証を無効にします。

keySecret

object

ターゲットのクライアントキーファイルを含むシークレット。

serverName

string

ターゲットのホスト名を確認するために使用されます。

14.5.1.28. .spec.tlsConfig.ca

Description
ターゲットに使用する CA 証明書を含む構造体。
タイプ
object
Expand
プロパティータイプDescription

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

14.5.1.29. .spec.tlsConfig.ca.configMap

Description
ターゲットに使用するデータを含む ConfigMap。
タイプ
object
必須
  • key
Expand
プロパティータイプDescription

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

14.5.1.30. .spec.tlsConfig.ca.secret

Description
ターゲットに使用するデータを含むシークレット。
タイプ
object
必須
  • key
Expand
プロパティータイプDescription

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

14.5.1.31. .spec.tlsConfig.cert

Description
ターゲットのクライアント証明書ファイルを含む構造体。
タイプ
object
Expand
プロパティータイプDescription

configMap

object

ターゲットに使用するデータを含む ConfigMap。

secret

object

ターゲットに使用するデータを含むシークレット。

14.5.1.32. .spec.tlsConfig.cert.configMap

Description
ターゲットに使用するデータを含む ConfigMap。
タイプ
object
必須
  • key
Expand
プロパティータイプDescription

key

string

選択するキー。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

ConfigMap かそのキーを定義する必要があるかどうかを指定します。

14.5.1.33. .spec.tlsConfig.cert.secret

Description
ターゲットに使用するデータを含むシークレット。
タイプ
object
必須
  • key
Expand
プロパティータイプDescription

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

14.5.1.34. .spec.tlsConfig.keySecret

Description
ターゲットのクライアントキーファイルを含むシークレット。
タイプ
object
必須
  • key
Expand
プロパティータイプDescription

key

string

選択するシークレットのキー。有効な秘密鍵でなければなりません。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid

任意

boolean

シークレットかそのキーを定義する必要があるかどうかを指定します。

14.5.2. API エンドポイント

以下の API エンドポイントを利用できます。

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

    • GET: プローブの種類のオブジェクトを一覧表示します
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes

    • 削除: プローブのコレクションを削除します
    • GET: プローブの種類のオブジェクトを一覧表示します
    • POST: プローブを作成します
  • /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name}

    • 削除: プローブを削除します
    • GET: 指定されたプローブを読み取ります
    • PATCH: 指定されたプローブを部分的に更新します
    • PUT: 指定されたプローブを交換します

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

Expand
表14.73 グローバルクエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

pretty

string

'true' の場合、出力はきれいに印刷されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

HTTP メソッド
GET
Description
種類のオブジェクトを一覧表示するプローブ
Expand
表14.74 HTTP 応答
HTTP コードレスポンス本文

200 - OK

ProbeList スキーマ

401 - Unauthorized

空白

14.5.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes

Expand
表14.75 グローバルパスパラメーター
パラメータータイプ説明

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

Expand
表14.76 グローバルクエリーパラメーター
パラメータータイプ説明

pretty

string

'true' の場合、出力はきれいに印刷されます。

HTTP メソッド
DELETE
Description
プローブのコレクションを削除する
Expand
表14.77 クエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

Expand
表14.78 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Status_v2 schema

401 - Unauthorized

空白

HTTP メソッド
GET
Description
種類のオブジェクトを一覧表示するプローブ
Expand
表14.79 クエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

Expand
表14.80 HTTP 応答
HTTP コードレスポンス本文

200 - OK

ProbeList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
Description
プローブを作成する
Expand
表14.81 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

Expand
表14.82 ボディパラメーター
パラメータータイプ説明

ボディー

Probe スキーマ

 
Expand
表14.83 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Probe スキーマ

201 - Created

Probe スキーマ

202 - Accepted

Probe スキーマ

401 - Unauthorized

空白

14.5.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name}

Expand
表14.84 グローバルパスパラメーター
パラメータータイプ説明

name

string

プローブの名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

Expand
表14.85 グローバルクエリーパラメーター
パラメータータイプ説明

pretty

string

'true' の場合、出力はきれいに印刷されます。

HTTP メソッド
DELETE
Description
プローブを削除する
Expand
表14.86 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

gracePeriodSeconds

integer

オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。

orphanDependents

boolean

非推奨: PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、孤立したファイナライザーがオブジェクトのファイナライザー一覧で追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。

propagationPolicy

string

ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定することはできません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシー。

Expand
表14.87 ボディパラメーター
パラメータータイプ説明

body

DeleteOptions_v2 schema

 
Expand
表14.88 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Status_v2 schema

202 - Accepted

Status_v2 schema

401 - Unauthorized

空白

HTTP メソッド
GET
Description
指定されたプローブを読み取る
Expand
表14.89 クエリーパラメーター
パラメータータイプ説明

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

Expand
表14.90 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Probe スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
Description
指定されたプローブを部分的に更新します
Expand
表14.91 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

Expand
表14.92 ボディパラメーター
パラメータータイプ説明

body

Patch schema

 
Expand
表14.93 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Probe スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
Description
指定されたプローブを交換してください
Expand
表14.94 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

Expand
表14.95 ボディパラメーター
パラメータータイプ説明

ボディー

Probe スキーマ

 
Expand
表14.96 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Probe スキーマ

201 - Created

Probe スキーマ

401 - Unauthorized

空白

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat