15.8. 入力 networking.k8s.io/v1
- Description
- Ingress は、インバウンド接続がバックエンドによって定義されたエンドポイントに到達できるようにするルールのコレクションです。Ingress は、サービスに外部から到達可能な URL を提供し、トラフィックの負荷を分散し、SSL を終了し、名前ベースの仮想ホスティングを提供するように設定できます。
- タイプ
-
object
15.8.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 を参照してください。 | |
|
| IngressSpec は、ユーザーが存在したいイングレスを記述します。 |
|
| IngressStatus は、Ingress の現在の状態を記述します。 |
15.8.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- Description
- IngressSpec は、ユーザーが存在したいイングレスを記述します。
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
|
| IngressBackend は、特定のサービスとポートのすべてのエンドポイントを記述します。 |
|
|
IngressClassName は、IngressClass クラスターリソースの名前です。関連する IngressClass は、どのコントローラーがリソースを実装するかを定義します。これは、非推奨の |
|
| 入力の設定に使用されるホストルールのリスト。指定されていない場合、またはルールが一致しない場合、すべてのトラフィックがデフォルトのバックエンドに送信されます。 |
|
| IngressRule は、指定されたホストの下のパスを関連するバックエンドサービスにマッピングするルールを表します。着信リクエストは、最初にホストの一致について評価され、次に一致する IngressRuleValue に関連付けられたバックエンドにルーティングされます。 |
|
| TLS 設定。現在、Ingress は単一の TLS ポート 443 のみをサポートしています。このリストの複数のメンバーが異なるホストを指定する場合、入力を実行する入力コントローラーが SNI をサポートしていれば、SNITLS 拡張を介して指定されたホスト名に従って同じポートで多重化されます。 |
|
| IngressTLS は、Ingress に関連付けられたトランスポート層のセキュリティーについて説明しています。 |
15.8.1.2. .spec.defaultBackend リンクのコピーリンクがクリップボードにコピーされました!
- Description
- IngressBackend は、特定のサービスとポートのすべてのエンドポイントを記述します。
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
| リソースは、Ingress オブジェクトの名前空間にある別の Kubernetes リソースへの ObjectRef です。リソースを指定する場合は、service.Name と service.Port を指定しないでください。これは、サービスとの相互に排他的な設定です。 | |
|
| IngressServiceBackend は、Kubernetes サービスをバックエンドとして参照します。 |
15.8.1.3. .spec.defaultBackend.service リンクのコピーリンクがクリップボードにコピーされました!
- Description
- IngressServiceBackend は、Kubernetes サービスをバックエンドとして参照します。
- タイプ
-
object
- 必須
-
name
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| 名前は参照されるサービスです。サービスは、Ingress オブジェクトと同じ名前空間に存在する必要があります。 |
|
| ServiceBackendPort は、参照されているサービスポートです。 |
15.8.1.4. .spec.defaultBackend.service.port リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ServiceBackendPort は、参照されているサービスポートです。
- タイプ
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| Name は、サービスのポートの名前です。これは、番号との相互に排他的な設定です。 |
|
| Number は、サービスのポート番号 (80 など) の数値です。これは、名前との相互に排他的な設定です。 |
15.8.1.5. .spec.rules リンクのコピーリンクがクリップボードにコピーされました!
- Description
- 入力の設定に使用されるホストルールのリスト。指定されていない場合、またはルールが一致しない場合、すべてのトラフィックがデフォルトのバックエンドに送信されます。
- タイプ
-
array
15.8.1.6. .spec.rules[] リンクのコピーリンクがクリップボードにコピーされました!
- Description
- IngressRule は、指定されたホストの下のパスを関連するバックエンドサービスにマッピングするルールを表します。着信リクエストは、最初にホストの一致について評価され、次に一致する IngressRuleValue に関連付けられたバックエンドにルーティングされます。
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
|
|
Host は、RFC 3986 で定義されている、ネットワークホストの完全修飾ドメイン名です。RFC 3986 で定義されている URI のホスト部分からの次の逸脱に注意してください:1。IP は許可されていません。現在、IngressRuleValue は、親 Ingress の仕様の IP にのみ適用できます。2.ポートが許可されていないため、 ホストは、ネットワークホストの終了ドットのないドメイン名である precise (foo.bar.com など)、または単一のワイルドカードラベルが前に付いたドメイン名である wildcard (.foo.com ")。ワイルドカード文字 '' は、それ自体が最初の DNS ラベルとして表示される必要があり、単一のラベルとのみ一致します。ワイルドカードラベルを単独で使用することはできません (例:Host == "*")。リクエストは、次の方法でホストフィールドと照合されます:1。Host が正確である場合、http host ヘッダーが Host と等しい場合、要求はこのルールに一致します。2.Host がワイルドカードの場合、http ホストヘッダーがワイルドカードルールの接尾辞 (最初のラベルを削除) と等しい場合、リクエストはこのルールに一致します。 |
|
|
HTTPIngressRuleValue は、バックエンドを指す http セレクターのリストです。例 : http://<host>/<path>?<searchpart > |
15.8.1.7. .spec.rules[].http リンクのコピーリンクがクリップボードにコピーされました!
- Description
-
HTTPIngressRuleValue は、バックエンドを指す http セレクターのリストです。例 : http://<host>/<path>?<searchpart >
backend。URL の一部が RFC 3986 に対応する場合、このリソースは最後の/の後、最初の?または # の前にすべて照合するために使用されます。 - タイプ
-
object
- 必須
-
paths
-
プロパティー | タイプ | Description |
---|---|---|
|
| リクエストをバックエンドにマップするパスのコレクション。 |
|
| HTTPIngressPath は、パスをバックエンドに関連付けます。パスに一致する着信 URL はバックエンドに転送されます。 |
15.8.1.8. .spec.rules[].http.paths リンクのコピーリンクがクリップボードにコピーされました!
- Description
- リクエストをバックエンドにマップするパスのコレクション。
- タイプ
-
array
15.8.1.9. .spec.rules[].http.paths[] リンクのコピーリンクがクリップボードにコピーされました!
- Description
- HTTPIngressPath は、パスをバックエンドに関連付けます。パスに一致する着信 URL はバックエンドに転送されます。
- タイプ
-
object
- 必須
-
pathType
-
backend
-
プロパティー | タイプ | Description |
---|---|---|
|
| IngressBackend は、特定のサービスとポートのすべてのエンドポイントを記述します。 |
|
| パスは、着信要求のパスと照合されます。現在、RFC 3986 で定義されているように、URL の従来のパス部分で許可されていない文字を含めることができます。パスは/で始まる必要があり、値が Exact または Prefix の PathType を使用する場合は存在する必要があります。 |
|
| PathType は、パスマッチングの解釈を決定します。PathType は、次のいずれかの値になります。*正確:URL パスと完全に一致します。*接頭辞:/で分割された URL パス接頭辞に基づいて一致します。マッチングは、要素ごとにパス要素で行われます。パス要素参照は、/区切り文字で分割されたパス内のラベルのリストです。すべての p が要求パスの p の要素ごとの接頭辞である場合、要求はパス p と一致します。パスの最後の要素がリクエストパスの最後の要素のサブストリングである場合、一致しないことに注意してください (たとえば、/foo/bar は/foo/bar/baz と一致しますが、/foo/barbaz とは一致しません)。* ImplementationSpecific: パスマッチングの解釈は IngressClass 次第です。実装では、これを個別の PathType として扱うことも、Prefix または Exact パスタイプと同じように扱うこともできます。すべてのパスタイプをサポートするには、実装が必要です。 |
15.8.1.10. .spec.rules[].http.paths[].backend リンクのコピーリンクがクリップボードにコピーされました!
- Description
- IngressBackend は、特定のサービスとポートのすべてのエンドポイントを記述します。
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
| リソースは、Ingress オブジェクトの名前空間にある別の Kubernetes リソースへの ObjectRef です。リソースを指定する場合は、service.Name と service.Port を指定しないでください。これは、サービスとの相互に排他的な設定です。 | |
|
| IngressServiceBackend は、Kubernetes サービスをバックエンドとして参照します。 |
15.8.1.11. .spec.rules[].http.paths[].backend.service リンクのコピーリンクがクリップボードにコピーされました!
- Description
- IngressServiceBackend は、Kubernetes サービスをバックエンドとして参照します。
- タイプ
-
object
- 必須
-
name
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| 名前は参照されるサービスです。サービスは、Ingress オブジェクトと同じ名前空間に存在する必要があります。 |
|
| ServiceBackendPort は、参照されているサービスポートです。 |
15.8.1.12. .spec.rules[].http.paths[].backend.service.port リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ServiceBackendPort は、参照されているサービスポートです。
- タイプ
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| Name は、サービスのポートの名前です。これは、番号との相互に排他的な設定です。 |
|
| Number は、サービスのポート番号 (80 など) の数値です。これは、名前との相互に排他的な設定です。 |
15.8.1.13. .spec.tls リンクのコピーリンクがクリップボードにコピーされました!
- Description
- TLS 設定。現在、Ingress は単一の TLS ポート 443 のみをサポートしています。このリストの複数のメンバーが異なるホストを指定する場合、入力を実行する入力コントローラーが SNI をサポートしていれば、SNITLS 拡張を介して指定されたホスト名に従って同じポートで多重化されます。
- タイプ
-
array
15.8.1.14. .spec.tls[] リンクのコピーリンクがクリップボードにコピーされました!
- Description
- IngressTLS は、Ingress に関連付けられたトランスポート層のセキュリティーについて説明しています。
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
|
| ホストは、TLS 証明書に含まれるホストのリストです。このリストの値は、tlsSecret で使用されている名前と一致する必要があります。指定しない場合、デフォルトで、この入力を満たすロードバランサーコントローラーのワイルドカードホスト設定になります。 |
|
| SecretName は、ポート 443 で TLS トラフィックを終了するために使用されるシークレットの名前です。SNI ホスト名のみに基づく TLS ルーティングを許可するには、フィールドをオプションのままにします。リスナー内の SNI ホストが、IngressRule で使用される Host ヘッダーフィールドと競合する場合、SNI ホストが終了に使用され、Host ヘッダーの値がルーティングに使用されます。 |
15.8.1.15. .status リンクのコピーリンクがクリップボードにコピーされました!
- Description
- IngressStatus は、Ingress の現在の状態を記述します。
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
| LoadBalancer には、ロードバランサーの現在のステータスが含まれます。 |
15.8.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/networking.k8s.io/v1/ingresses
-
GET
:Ingress の種類のオブジェクトを一覧表示または監視します
-
/apis/networking.k8s.io/v1/watch/ingresses
-
GET
: イングレスのリストへの個々の変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用してください。
-
/apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses
-
DELETE
: 入力のコレクションを削除します -
GET
:Ingress の種類のオブジェクトを一覧表示または監視します -
POST
: 入力を作成します
-
/apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses
-
GET
: イングレスのリストへの個々の変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用してください。
-
/apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}
-
削除
: 入力を削除します -
GET
: 指定された入力を読み取ります -
PATCH
: 指定された入力を部分的に更新します -
PUT
: 指定された入力を置き換えます
-
/apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses/{name}
-
GET
:Ingress の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用し、fieldSelector パラメーターで単一の項目にフィルター処理します。
-
/apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status
-
GET
: 指定された入力のステータスを読み取ります -
PATCH
: 指定された入力のステータスを部分的に更新します -
PUT
: 指定された入力のステータスを置き換えます
-
15.8.2.1. /apis/networking.k8s.io/v1/ingresses リンクのコピーリンクがクリップボードにコピーされました!
パラメーター | タイプ | 説明 |
---|---|---|
|
| 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
- Ingress の種類のオブジェクトを一覧表示または監視する
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
15.8.2.2. /apis/networking.k8s.io/v1/watch/ingresses リンクのコピーリンクがクリップボードにコピーされました!
パラメーター | タイプ | 説明 |
---|---|---|
|
| 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
- Ingress のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用してください。
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
15.8.2.3. /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses リンクのコピーリンクがクリップボードにコピーされました!
パラメーター | タイプ | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | タイプ | 説明 |
---|---|---|
|
| 'true' の場合、出力はきれいに印刷されます。 |
- HTTP メソッド
-
DELETE
- Description
- Ingress のコレクションを削除します
パラメーター | タイプ | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。 |
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 非推奨: PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、孤立したファイナライザーがオブジェクトのファイナライザー一覧で追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定することはできません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシー。 |
|
| 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 |
|
| リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- Description
- Ingress の種類のオブジェクトを一覧表示または監視する
パラメーター | タイプ | 説明 |
---|---|---|
|
| 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 で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
15.8.2.4. /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses リンクのコピーリンクがクリップボードにコピーされました!
パラメーター | タイプ | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | タイプ | 説明 |
---|---|---|
|
| 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
- Ingress のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用してください。
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
15.8.2.5. /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{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
- 指定された入力を読み取ります
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- Description
- 指定された入力を部分的に更新します
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、適用要求 (application/apply-patch) には必須ですが、非適用パッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) にはオプションです。 |
|
| Force は Apply リクエストを強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合、強制フラグを設定解除する必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- Description
- 指定された入力を置き換えます
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
15.8.2.6. /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses/{name} リンクのコピーリンクがクリップボードにコピーされました!
パラメーター | タイプ | 説明 |
---|---|---|
|
| イングレスの名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | タイプ | 説明 |
---|---|---|
|
| 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
- Ingress の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用し、fieldSelector パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
15.8.2.7. /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
パラメーター | タイプ | 説明 |
---|---|---|
|
| イングレスの名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | タイプ | 説明 |
---|---|---|
|
| 'true' の場合、出力はきれいに印刷されます。 |
- HTTP メソッド
-
GET
- Description
- 指定された入力のステータスを読み取ります
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- Description
- 指定された入力のステータスを部分的に更新します
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、適用要求 (application/apply-patch) には必須ですが、非適用パッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) にはオプションです。 |
|
| Force は Apply リクエストを強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合、強制フラグを設定解除する必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- Description
- 指定された入力のステータスを置き換えます
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|