25.4. FlowSchema [flowcontrol.apiserver.k8s.io/v1beta1]


Description
FlowSchema は、フローのグループのスキーマを定義します。フローは、同様の属性を持つ一連のインバウンド API リクエストで設定されており、FlowSchema の名前とフロー識別子という文字列のペアで識別されることに注意してください。
タイプ
object

25.4.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

metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

spec

object

FlowSchemaSpec は、FlowSchema の仕様がどのように見えるかを記述します。

status

object

FlowSchemaStatus は、FlowSchema の現在の状態を表します。

25.4.1.1. .spec

Description
FlowSchemaSpec は、FlowSchema の仕様がどのように見えるかを記述します。
タイプ
object
必須
  • priorityLevelConfiguration
Expand
プロパティータイプDescription

distinguisherMethod

object

FlowDistinguisherMethod は、フロー識別子のメソッドを指定します。

matchingPrecedence

integer

matchingPrecedence は、特定のリクエストに一致する FlowSchemas から選択するために使用されます。選択された FlowSchema は、MatchingPrecedence が数値的に最も低い (論理的に最も高いと見なされる) ものの 1 つです。各 MatchingPrecedence 値は、1,10000 の範囲である必要があります。優先順位が指定されていない場合、デフォルトで 1000 に設定されることに注意してください。

priorityLevelConfiguration

object

PriorityLevelConfigurationReference には、使用されている request-priority を指す情報が含まれています。

rules

array

ルール は、どのリクエストがこのフロースキーマに一致するかを記述します。この FlowSchema は、ルールの少なくとも 1 つのメンバーが要求に一致する場合にのみ、要求に一致します。空のスライスの場合、FlowSchema に一致するリクエストはありません。

rules[]

object

PolicyRulesWithSubjects は、apiserver へのリクエストに適用されるテストを規定します。テストでは、要求を行っているサブジェクト、要求されている動詞、および実行対象のリソースが考慮されます。この PolicyRulesWithSubjects は、(a) サブジェクトの少なくとも 1 つのメンバーが要求に一致し、(b)resourceRules または nonResourceRules の少なくとも 1 つのメンバーが要求に一致する場合にのみ、要求に一致します。

25.4.1.2. .spec.distinguisherMethod

Description
FlowDistinguisherMethod は、フロー識別子のメソッドを指定します。
タイプ
object
必須
  • type
Expand
プロパティータイプ説明

type

string

type は、フロー識別子メソッドのタイプです。サポートされているタイプは、ByUser と ByNamespace です。必須。

25.4.1.3. .spec.priorityLevelConfiguration

Description
PriorityLevelConfigurationReference には、使用されている request-priority を指す情報が含まれています。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照されている優先度レベルの設定の名前です必須。

25.4.1.4. .spec.rules

Description
ルール は、どのリクエストがこのフロースキーマに一致するかを記述します。この FlowSchema は、ルールの少なくとも 1 つのメンバーが要求に一致する場合にのみ、要求に一致します。空のスライスの場合、FlowSchema に一致するリクエストはありません。
タイプ
array

25.4.1.5. .spec.rules[]

Description
PolicyRulesWithSubjects は、apiserver へのリクエストに適用されるテストを規定します。テストでは、要求を行っているサブジェクト、要求されている動詞、および実行対象のリソースが考慮されます。この PolicyRulesWithSubjects は、(a) サブジェクトの少なくとも 1 つのメンバーが要求に一致し、(b)resourceRules または nonResourceRules の少なくとも 1 つのメンバーが要求に一致する場合にのみ、要求に一致します。
タイプ
object
必須
  • subjects
Expand
プロパティータイプDescription

nonResourceRules

array

nonResourceRules は、動詞とターゲットの非リソース URL に従って一致するリクエストを識別する NonResourcePolicyRules のリストです。

nonResourceRules[]

object

NonResourcePolicyRule は、動詞とターゲットの非リソース URL に従って非リソース要求に一致する述語です。NonResourcePolicyRule は、(a) 動詞の少なくとも 1 つのメンバーが要求に一致し、(b)nonResourceURLs の少なくとも 1 つのメンバーが要求に一致する場合にのみ、要求に一致します。

resourceRules

array

resourceRules は、動詞とターゲットリソースに従って一致するリクエストを識別する ResourcePolicyRules のスライスです。resourceRulesnonResourceRules の少なくとも 1 つは空でない必要があります。

resourceRules[]

object

ResourcePolicyRule は、一部のリソースリクエストに一致する述語であり、リクエストの動詞とターゲットリソースをテストします。ResourcePolicyRule は、次の場合にのみリソース要求に一致します。(a) 動詞の少なくとも 1 つのメンバーが要求に一致する、(b)apiGroups の少なくとも 1 つのメンバーが要求に一致する、(c) リソースの少なくとも 1 つのメンバーが要求に一致する、(d) 名前空間の少なくとも 1 つのメンバーが要求に一致します。

subjects

array

サブジェクトは、このルールが関係する通常のユーザー、サービスアカウント、またはグループのリストです。このスライスには少なくとも 1 つのメンバーが必要です。system:authenticated ユーザーグループと system:unauthenticated ユーザーグループの両方を含むスライスは、すべてのリクエストに一致します。必須。

subjects[]

object

サブジェクトは、リクエスト認証システムによって識別されるように、リクエストの発信者と一致します。発信者を照合する方法は 3 つあります。ユーザー、グループ、またはサービスアカウントごと。

25.4.1.6. .spec.rules[].nonResourceRules

Description
nonResourceRules は、動詞とターゲットの非リソース URL に従って一致するリクエストを識別する NonResourcePolicyRules のリストです。
タイプ
array

25.4.1.7. .spec.rules[].nonResourceRules[]

Description
NonResourcePolicyRule は、動詞とターゲットの非リソース URL に従って非リソース要求に一致する述語です。NonResourcePolicyRule は、(a) 動詞の少なくとも 1 つのメンバーが要求に一致し、(b)nonResourceURLs の少なくとも 1 つのメンバーが要求に一致する場合にのみ、要求に一致します。
タイプ
object
必須
  • verbs
  • nonResourceURLs
Expand
プロパティータイプDescription

nonResourceURLs

array (string)

nonResourceURLs は、ユーザーがアクセスできる必要があり、空であってはならない URL 接頭辞のセットです。例:-/healthz は合法です -/hea*は違法です -/hea は合法ですが何にも一致しません -/hea/も何にも一致しません -/healthz/ はすべてのコンポーネントごとのヘルスチェックに一致します。*はすべての非リソース URL に一致します。存在する場合は、それが唯一のエントリーである必要があります。必須。

verbs

array (string)

動詞 は一致する動詞のリストであり、空にすることはできません。*はすべての動詞に一致します。存在する場合は、それが唯一のエントリーである必要があります。必須。

25.4.1.8. .spec.rules[].resourceRules

Description
resourceRules は、動詞とターゲットリソースに従って一致するリクエストを識別する ResourcePolicyRules のスライスです。resourceRulesnonResourceRules の少なくとも 1 つは空でない必要があります。
タイプ
array

25.4.1.9. .spec.rules[].resourceRules[]

Description
ResourcePolicyRule は、一部のリソースリクエストに一致する述語であり、リクエストの動詞とターゲットリソースをテストします。ResourcePolicyRule は、次の場合にのみリソース要求に一致します。(a) 動詞の少なくとも 1 つのメンバーが要求に一致する、(b)apiGroups の少なくとも 1 つのメンバーが要求に一致する、(c) リソースの少なくとも 1 つのメンバーが要求に一致する、(d) 名前空間の少なくとも 1 つのメンバーが要求に一致します。
タイプ
object
必須
  • verbs
  • apiGroups
  • resources
Expand
プロパティータイプDescription

apiGroups

array (string)

apiGroups は、一致する API グループのリストであり、空ではない場合があります。*はすべての API グループに一致し、存在する場合は唯一のエントリーである必要があります。必須。

clusterScope

ブール値

clusterScope は、名前空間を指定しない要求に一致するかどうかを示します (これは、リソースが名前空間化されていないか、要求がすべての名前空間を対象としているために発生します)。このフィールドが省略されているか false の場合、名前空間 フィールドには空でないリストが含まれている必要があります。

namespace

array (string)

namespaces は、一致を制限するターゲット名前空間のリストです。ターゲット名前空間を指定するリクエストは、(a) このリストにそのターゲット名前空間が含まれている場合、または (b) このリストに"。ご了承ください "" は、指定された名前空間に一致しますが、名前空間 を指定しない 要求には一致しません (詳細については、clusterScope フィールドを参照してください)。このリストは空の場合がありますが、clusterScope が true の場合に限ります。

resources

array (string)

resources は、必要に応じてサブリソースと一致するリソース (小文字と複数形) のリストです。たとえば、"services"、"nodes/status"。このリストは空ではない可能性があります。*はすべてのリソースに一致し、存在する場合は唯一のエントリーである必要があります。必須。

verbs

array (string)

動詞 は一致する動詞のリストであり、空にすることはできません。*はすべての動詞に一致し、存在する場合は唯一のエントリーである必要があります。必須。

25.4.1.10. .spec.rules[].subjects

Description
サブジェクトは、このルールが関係する通常のユーザー、サービスアカウント、またはグループのリストです。このスライスには少なくとも 1 つのメンバーが必要です。system:authenticated ユーザーグループと system:unauthenticated ユーザーグループの両方を含むスライスは、すべてのリクエストに一致します。必須。
タイプ
array

25.4.1.11. .spec.rules[].subjects[]

Description
サブジェクトは、リクエスト認証システムによって識別されるように、リクエストの発信者と一致します。発信者を照合する方法は 3 つあります。ユーザー、グループ、またはサービスアカウントごと。
タイプ
object
必須
  • kind
Expand
プロパティータイプDescription

group

object

GroupSubject は、グループの種類のサブジェクトの詳細情報を保持します。

kind

string

kind は、他のフィールドのどれが空でないかを示します。必須

serviceAccount

object

ServiceAccountSubject は、service-account-kind サブジェクトの詳細情報を保持します。

user

object

UserSubject は、ユーザーの種類のサブジェクトに関する詳細情報を保持します。

25.4.1.12. .spec.rules[].subjects[].group

Description
GroupSubject は、グループの種類のサブジェクトの詳細情報を保持します。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は一致するユーザーグループ、または*はすべてのユーザーグループに一致します。よく知られているグループ名については、https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go を参照してください。必須。

25.4.1.13. .spec.rules[].subjects[].serviceAccount

Description
ServiceAccountSubject は、service-account-kind サブジェクトの詳細情報を保持します。
タイプ
object
必須
  • namespace
  • name
Expand
プロパティータイプ説明

name

string

name は、一致する ServiceAccount オブジェクトの名前、または名前に関係なく一致する*です。必須。

namespace

string

名前空間 は、一致する ServiceAccount オブジェクトの名前空間です。必須。

25.4.1.14. .spec.rules[].subjects[].user

Description
UserSubject は、ユーザーの種類のサブジェクトに関する詳細情報を保持します。
タイプ
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は一致するユーザー名、またはすべてのユーザー名に一致する場合は*です。必須。

25.4.1.15. .status

Description
FlowSchemaStatus は、FlowSchema の現在の状態を表します。
タイプ
object
Expand
プロパティータイプ説明

conditions

array

条件 は、FlowSchema の現在の状態のリストです。

conditions[]

object

FlowSchemaCondition は、FlowSchema の条件を記述します。

25.4.1.16. .status.conditions

Description
条件 は、FlowSchema の現在の状態のリストです。
タイプ
array

25.4.1.17. .status.conditions[]

Description
FlowSchemaCondition は、FlowSchema の条件を記述します。
タイプ
object
Expand
プロパティータイプ説明

lastTransitionTime

時間

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。

message

string

message は、最後の遷移に関する詳細を示す人間が判読できるメッセージです。

reason

string

理由 は、条件の最後の遷移の一意の 1 単語の CamelCase 理由です。

status

string

status は、状態のステータスです。True、False、Unknown の場合があります。必須。

type

string

type は、条件のタイプです。必須。

25.4.2. API エンドポイント

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

  • /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas

    • DELETE:FlowSchema のコレクションを削除します
    • GET: 種類のオブジェクトを一覧表示または監視する FlowSchema
    • POST:FlowSchema を作成します
  • /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/flowschemas

    • GET:FlowSchema のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用してください。
  • /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}

    • 削除:FlowSchema を削除します
    • GET: 指定された FlowSchema を読み取ります
    • PATCH: 指定された FlowSchema を部分的に更新します
    • PUT: 指定された FlowSchema を置き換えます
  • /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/flowschemas/{name}

    • GET: 種類 FlowSchema のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用し、fieldSelector パラメーターで単一の項目にフィルター処理します。
  • /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}/status

    • GET: 指定された FlowSchema のステータスを読み取ります
    • PATCH: 指定された FlowSchema のステータスを部分的に更新します
    • PUT: 指定された FlowSchema のステータスを置き換えます

25.4.2.1. /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas

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

pretty

string

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

HTTP メソッド
DELETE
Description
FlowSchema のコレクションを削除します
Expand
表25.46 クエリーパラメーター
パラメータータイプ説明

continue

string

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

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

dryRun

string

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

fieldSelector

string

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

gracePeriodSeconds

integer

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

labelSelector

string

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

limit

integer

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

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

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

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

body

DeleteOptions スキーマ

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

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
Description
FlowSchema の種類のオブジェクトを一覧表示または監視する
Expand
表25.49 クエリーパラメーター
パラメータータイプ説明

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
表25.50 HTTP 応答
HTTP コードレスポンス本文

200 - OK

FlowSchemaList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
Description
FlowSchema を作成します
Expand
表25.51 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldManager

string

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

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

ボディー

FlowSchema スキーマ

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

200 - OK

FlowSchema スキーマ

201 - Created

FlowSchema スキーマ

202 - Accepted

FlowSchema スキーマ

401 - Unauthorized

空白

25.4.2.2. /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/flowschemas

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

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
FlowSchema のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用してください。
Expand
表25.55 HTTP 応答
HTTP コードレスポンス本文

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

25.4.2.3. /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}

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

name

string

FlowSchema の名前

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

pretty

string

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

HTTP メソッド
DELETE
Description
FlowSchema を削除します
Expand
表25.58 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

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

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
Description
指定された FlowSchema を読み取ります
Expand
表25.61 HTTP 応答
HTTP コードレスポンス本文

200 - OK

FlowSchema スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、適用要求 (application/apply-patch) には必須ですが、非適用パッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) にはオプションです。

force

boolean

Force は Apply リクエストを強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合、強制フラグを設定解除する必要があります。

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

body

Patch schema

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

200 - OK

FlowSchema スキーマ

201 - Created

FlowSchema スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
Description
指定された FlowSchema を置き換えます
Expand
表25.65 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldManager

string

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

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

ボディー

FlowSchema スキーマ

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

200 - OK

FlowSchema スキーマ

201 - Created

FlowSchema スキーマ

401 - Unauthorized

空白

25.4.2.4. /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/flowschemas/{name}

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

name

string

FlowSchema の名前

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

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
FlowSchema の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用し、fieldSelector パラメーターで単一の項目にフィルター処理します。
Expand
表25.70 HTTP 応答
HTTP コードレスポンス本文

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

25.4.2.5. /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}/status

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

name

string

FlowSchema の名前

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

pretty

string

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

HTTP メソッド
GET
Description
指定された FlowSchema のステータスを読み取ります
Expand
表25.73 HTTP 応答
HTTP コードレスポンス本文

200 - OK

FlowSchema スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、適用要求 (application/apply-patch) には必須ですが、非適用パッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) にはオプションです。

force

boolean

Force は Apply リクエストを強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合、強制フラグを設定解除する必要があります。

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

body

Patch schema

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

200 - OK

FlowSchema スキーマ

201 - Created

FlowSchema スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
Description
指定された FlowSchema のステータスを置き換えます
Expand
表25.77 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldManager

string

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

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

ボディー

FlowSchema スキーマ

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

200 - OK

FlowSchema スキーマ

201 - Created

FlowSchema スキーマ

401 - Unauthorized

空白

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat