14.5. Probe [monitoring.coreos.com/v1]
- Description
- プローブは、一連の静的ターゲットまたは入力の監視を定義します。
- タイプ
-
object
- 必須
-
spec
-
14.5.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
プロパティー | タイプ | 説明 |
---|---|---|
|
| APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これを更新することはできません。CamelCase詳細については、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| Prometheus によるターゲット発見のための望ましいイングレス選択の仕様。 |
14.5.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- Description
- Prometheus によるターゲット発見のための望ましいイングレス選択の仕様。
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
|
| このエンドポイントの承認セクション |
|
| BasicAuth を使用すると、エンドポイントは基本認証を介して認証できます。詳細: https://prometheus.io/docs/operating/configuration/#endpoint |
|
| ターゲットをスクレイピングするためのベアラトークンを読み取るためにマウントする秘密。シークレットは、プローブと同じ名前空間にあり、PrometheusOperator からアクセスできる必要があります。 |
|
| 設定されたプローバーを使用してターゲットがプローブされる間隔。指定しない場合、Prometheus のグローバルスクレイプ間隔が使用されます。 |
|
| デフォルトでスクレイプされたメトリックに割り当てられたジョブ名。 |
|
| サンプルに受け入れられるラベルの数のスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。 |
|
| サンプルで受け入れられるラベル名の長さのスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。 |
|
| サンプルに受け入れられるラベル値の長さのスクレープごとの制限。Prometheus バージョン 2.27.0 以降でのみ有効です。 |
|
| 取り込み前にサンプルに適用する MetricRelabelConfigs。 |
|
|
RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の |
|
| ターゲットをプローブする方法を指定するプローブに使用するモジュール。ブラックボックスエクスポーターでのモジュール設定の例: https://github.com/prometheus/blackbox_exporter/blob/master/example.yml |
|
| URL の OAuth2。Prometheus バージョン 2.27.0 以降でのみ有効です。 |
|
| ターゲットのプロービングに使用するプローバーの仕様。prober.URL パラメーターは必須です。空のままにすると、ターゲットをプローブできません。 |
|
| SampleLimit は、受け入れられるスクレイプされたサンプルの数に対するスクレイプごとの制限を定義します。 |
|
| Prometheus エクスポーターからメトリックをスクレイピングするためのタイムアウト。 |
|
| TargetLimit は、受け入れられるスクレイプされたターゲットの数の制限を定義します。 |
|
| ターゲットは、プローバーを使用してプローブされる静的および/または動的に検出されたターゲットのセットを定義します。 |
|
| エンドポイントをスクレイピングするときに使用する TLS 設定。 |
14.5.1.2. .spec.authorization リンクのコピーリンクがクリップボードにコピーされました!
- Description
- このエンドポイントの承認セクション
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
|
| リクエストのクレデンシャルを含むシークレットのキー |
|
| 認証タイプを設定します。デフォルトは Bearer で、Basic はエラーを引き起こします |
14.5.1.3. .spec.authorization.credentials リンクのコピーリンクがクリップボードにコピーされました!
- Description
- リクエストのクレデンシャルを含むシークレットのキー
- タイプ
-
object
- 必須
-
key
-
プロパティー | タイプ | Description |
---|---|---|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
14.5.1.4. .spec.basicAuth リンクのコピーリンクがクリップボードにコピーされました!
- Description
- BasicAuth を使用すると、エンドポイントは基本認証を介して認証できます。詳細: https://prometheus.io/docs/operating/configuration/#endpoint
- タイプ
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| 認証用のパスワードを含むサービスモニター名前空間のシークレット。 |
|
| 認証用のユーザー名を含むサービスモニター名前空間のシークレット。 |
14.5.1.5. .spec.basicAuth.password リンクのコピーリンクがクリップボードにコピーされました!
- Description
- 認証用のパスワードを含むサービスモニター名前空間のシークレット。
- タイプ
-
object
- 必須
-
key
-
プロパティー | タイプ | Description |
---|---|---|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
14.5.1.6. .spec.basicAuth.username リンクのコピーリンクがクリップボードにコピーされました!
- Description
- 認証用のユーザー名を含むサービスモニター名前空間のシークレット。
- タイプ
-
object
- 必須
-
key
-
プロパティー | タイプ | Description |
---|---|---|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
14.5.1.7. .spec.bearerTokenSecret リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ターゲットをスクレイピングするためのベアラトークンを読み取るためにマウントする秘密。シークレットは、プローブと同じ名前空間にあり、PrometheusOperator からアクセスできる必要があります。
- タイプ
-
object
- 必須
-
key
-
プロパティー | タイプ | Description |
---|---|---|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
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
プロパティー | タイプ | Description |
---|---|---|
|
| 正規表現のマッチングに基づいて実行するアクション。デフォルトは置換です |
|
| ソースラベル値のハッシュを取得するためのモジュラス。 |
|
| 抽出された値が一致する正規表現。デフォルトは (.*) です。 |
|
| 正規表現が一致する場合に正規表現置換が実行される置換値。正規表現キャプチャグループが利用可能です。デフォルトは $1 です。 |
|
| 連結されたソースラベル値の間に配置されたセパレータ。デフォルトは ';' です。 |
|
| ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレーターを使用して連結され、置換、保持、および削除アクションの設定された正規表現と照合されます。 |
|
| 結果の値が置換アクションで書き込まれるラベル。置換アクションには必須です。正規表現キャプチャグループが利用可能です。 |
14.5.1.10. .spec.oauth2 リンクのコピーリンクがクリップボードにコピーされました!
- Description
- URL の OAuth2。Prometheus バージョン 2.27.0 以降でのみ有効です。
- タイプ
-
object
- 必須
-
clientId
-
clientSecret
-
tokenUrl
-
プロパティー | タイプ | Description |
---|---|---|
|
| OAuth2 クライアント ID を含むシークレットまたは設定マップ |
|
| OAuth2 クライアントシークレットを含むシークレット |
|
| トークン URL に追加するパラメーター |
|
| トークンリクエストに使用される OAuth2 スコープ |
|
| トークンをフェッチする URL |
14.5.1.11. .spec.oauth2.clientId リンクのコピーリンクがクリップボードにコピーされました!
- Description
- OAuth2 クライアント ID を含むシークレットまたは設定マップ
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
|
| ターゲットに使用するデータを含む ConfigMap。 |
|
| ターゲットに使用するデータを含むシークレット。 |
14.5.1.12. .spec.oauth2.clientId.configMap リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ターゲットに使用するデータを含む ConfigMap。
- タイプ
-
object
- 必須
-
key
-
プロパティー | タイプ | Description |
---|---|---|
|
| 選択するキー。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| ConfigMap かそのキーを定義する必要があるかどうかを指定します。 |
14.5.1.13. .spec.oauth2.clientId.secret リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ターゲットに使用するデータを含むシークレット。
- タイプ
-
object
- 必須
-
key
-
プロパティー | タイプ | Description |
---|---|---|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
14.5.1.14. .spec.oauth2.clientSecret リンクのコピーリンクがクリップボードにコピーされました!
- Description
- OAuth2 クライアントシークレットを含むシークレット
- タイプ
-
object
- 必須
-
key
-
プロパティー | タイプ | Description |
---|---|---|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
14.5.1.15. .spec.prober リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ターゲットのプロービングに使用するプローバーの仕様。prober.URL パラメーターは必須です。空のままにすると、ターゲットをプローブできません。
- タイプ
-
object
- 必須
-
url
-
プロパティー | タイプ | Description |
---|---|---|
|
|
メトリックを収集するためのパス。デフォルトは |
|
| オプションの ProxyURL。 |
|
|
スクレイピングに使用する HTTP スキーム。デフォルトは |
|
| プローバーの必須 URL。 |
14.5.1.16. .spec.targets リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ターゲットは、プローバーを使用してプローブされる静的および/または動的に検出されたターゲットのセットを定義します。
- タイプ
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| Ingress は、ホストがプロービングの対象と見なされる動的に検出されたイングレスオブジェクトのセットを定義します。 |
|
| StaticConfig は、プロービングの対象となる静的ターゲットを定義します。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#statuc_config |
14.5.1.17. .spec.targets.ingress リンクのコピーリンクがクリップボードにコピーされました!
- Description
- Ingress は、ホストがプロービングの対象と見なされる動的に検出されたイングレスオブジェクトのセットを定義します。
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
|
| 名前空間で Ingress オブジェクトを選択します。 |
|
| 取り込み前にサンプルに適用する RelabelConfigs。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config |
|
|
RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の |
|
| ラベルで入力オブジェクトを選択します。 |
14.5.1.18. .spec.targets.ingress.namespaceSelector リンクのコピーリンクがクリップボードにコピーされました!
- Description
- 名前空間で Ingress オブジェクトを選択します。
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
|
| それらを制限するリストとは対照的に、すべての名前空間が選択されているかどうかを説明するブール値。 |
|
| 名前空間名のリスト。 |
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
プロパティー | タイプ | Description |
---|---|---|
|
| 正規表現のマッチングに基づいて実行するアクション。デフォルトは置換です |
|
| ソースラベル値のハッシュを取得するためのモジュラス。 |
|
| 抽出された値が一致する正規表現。デフォルトは (.*) です。 |
|
| 正規表現が一致する場合に正規表現置換が実行される置換値。正規表現キャプチャグループが利用可能です。デフォルトは $1 です。 |
|
| 連結されたソースラベル値の間に配置されたセパレータ。デフォルトは ';' です。 |
|
| ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレーターを使用して連結され、置換、保持、および削除アクションの設定された正規表現と照合されます。 |
|
| 結果の値が置換アクションで書き込まれるラベル。置換アクションには必須です。正規表現キャプチャグループが利用可能です。 |
14.5.1.21. .spec.targets.ingress.selector リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ラベルで入力オブジェクトを選択します。
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
|
| matchExpressions はラベルセレクターの要件の一覧です。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| 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
-
プロパティー | タイプ | Description |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| 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
プロパティー | タイプ | Description |
---|---|---|
|
| ターゲットからスクレイプされたすべてのメトリックに割り当てられたラベル。 |
|
| 取り込み前にサンプルに適用する RelabelConfigs。詳細: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config |
|
|
RelabelConfig を使用すると、取り込み前にサンプルに適用されたラベルセットの動的な書き換えが可能になります。Prometheus 設定の |
|
| ターゲットは、設定されたプローバーを使用してプロービングする 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
プロパティー | タイプ | Description |
---|---|---|
|
| 正規表現のマッチングに基づいて実行するアクション。デフォルトは置換です |
|
| ソースラベル値のハッシュを取得するためのモジュラス。 |
|
| 抽出された値が一致する正規表現。デフォルトは (.*) です。 |
|
| 正規表現が一致する場合に正規表現置換が実行される置換値。正規表現キャプチャグループが利用可能です。デフォルトは $1 です。 |
|
| 連結されたソースラベル値の間に配置されたセパレータ。デフォルトは ';' です。 |
|
| ソースラベルは、既存のラベルから値を選択します。それらのコンテンツは、設定されたセパレーターを使用して連結され、置換、保持、および削除アクションの設定された正規表現と照合されます。 |
|
| 結果の値が置換アクションで書き込まれるラベル。置換アクションには必須です。正規表現キャプチャグループが利用可能です。 |
14.5.1.27. .spec.tlsConfig リンクのコピーリンクがクリップボードにコピーされました!
- Description
- エンドポイントをスクレイピングするときに使用する TLS 設定。
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
|
| ターゲットに使用する CA 証明書を含む構造体。 |
|
| ターゲットのクライアント証明書ファイルを含む構造体。 |
|
| ターゲット証明書の検証を無効にします。 |
|
| ターゲットのクライアントキーファイルを含むシークレット。 |
|
| ターゲットのホスト名を確認するために使用されます。 |
14.5.1.28. .spec.tlsConfig.ca リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ターゲットに使用する CA 証明書を含む構造体。
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
|
| ターゲットに使用するデータを含む ConfigMap。 |
|
| ターゲットに使用するデータを含むシークレット。 |
14.5.1.29. .spec.tlsConfig.ca.configMap リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ターゲットに使用するデータを含む ConfigMap。
- タイプ
-
object
- 必須
-
key
-
プロパティー | タイプ | Description |
---|---|---|
|
| 選択するキー。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| ConfigMap かそのキーを定義する必要があるかどうかを指定します。 |
14.5.1.30. .spec.tlsConfig.ca.secret リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ターゲットに使用するデータを含むシークレット。
- タイプ
-
object
- 必須
-
key
-
プロパティー | タイプ | Description |
---|---|---|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
14.5.1.31. .spec.tlsConfig.cert リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ターゲットのクライアント証明書ファイルを含む構造体。
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
|
| ターゲットに使用するデータを含む ConfigMap。 |
|
| ターゲットに使用するデータを含むシークレット。 |
14.5.1.32. .spec.tlsConfig.cert.configMap リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ターゲットに使用するデータを含む ConfigMap。
- タイプ
-
object
- 必須
-
key
-
プロパティー | タイプ | Description |
---|---|---|
|
| 選択するキー。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| ConfigMap かそのキーを定義する必要があるかどうかを指定します。 |
14.5.1.33. .spec.tlsConfig.cert.secret リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ターゲットに使用するデータを含むシークレット。
- タイプ
-
object
- 必須
-
key
-
プロパティー | タイプ | Description |
---|---|---|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
14.5.1.34. .spec.tlsConfig.keySecret リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ターゲットのクライアントキーファイルを含むシークレット。
- タイプ
-
object
- 必須
-
key
-
プロパティー | タイプ | Description |
---|---|---|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
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 リンクのコピーリンクがクリップボードにコピーされました!
パラメーター | タイプ | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 'true' の場合、出力はきれいに印刷されます。 |
|
| resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
| リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。 |
|
| 説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- Description
- 種類のオブジェクトを一覧表示するプローブ
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.5.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes リンクのコピーリンクがクリップボードにコピーされました!
パラメーター | タイプ | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | タイプ | 説明 |
---|---|---|
|
| 'true' の場合、出力はきれいに印刷されます。 |
- HTTP メソッド
-
DELETE
- Description
- プローブのコレクションを削除する
パラメーター | タイプ | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
| リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。 |
|
| 説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- Description
- 種類のオブジェクトを一覧表示するプローブ
パラメーター | タイプ | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
| リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。 |
|
| 説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- Description
- プローブを作成する
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
14.5.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/probes/{name} リンクのコピーリンクがクリップボードにコピーされました!
パラメーター | タイプ | 説明 |
---|---|---|
|
| プローブの名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | タイプ | 説明 |
---|---|---|
|
| 'true' の場合、出力はきれいに印刷されます。 |
- HTTP メソッド
-
DELETE
- Description
- プローブを削除する
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
| 非推奨: PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、孤立したファイナライザーがオブジェクトのファイナライザー一覧で追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定することはできません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシー。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- Description
- 指定されたプローブを読み取る
パラメーター | タイプ | 説明 |
---|---|---|
|
| resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- Description
- 指定されたプローブを部分的に更新します
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- Description
- 指定されたプローブを交換してください
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|