スケジュール API とクォータ API


OpenShift Container Platform 4.16

スケジュールおよびクォータ API のリファレンスガイド

Red Hat OpenShift Documentation Team

概要

このドキュメントでは、OpenShift Container Platform のスケジュールおよびクォータ API オブジェクトとその詳細な仕様を説明します。

第1章 スケジュール API とクォータ API

1.1. AppliedClusterResourceQuota [quota.openshift.io/v1]

説明

AppliedClusterResourceQuota は、プロジェクトに投影するために、プロジェクトスコープで ClusterResourceQuota をミラーリングします。これにより、プロジェクト管理者は、プロジェクトに適用されている ClusterResourceQuotas とそれに関連する使用法を知ることができます。

互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

object

1.2. ClusterResourceQuota [quota.openshift.io/v1]

説明
ClusterResourceQuota は、クラスタースコープで ResourceQuota をミラーリングします。このオブジェクトは、クォータ評価を再利用できるように、合成 ResourceQuota オブジェクトに簡単に変換できます。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
object

1.3. FlowSchema [flowcontrol.apiserver.k8s.io/v1]

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

1.4. LimitRange [v1]

説明
LimitRange は、名前空間内のリソースの種類ごとにリソース使用制限を設定します。
object

1.5. PriorityClass [scheduling.k8s.io/v1]

説明
PriorityClass は、優先度クラス名から優先度整数値へのマッピングを定義します。値は任意の有効な整数にすることができます。
object

1.6. PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1]

説明
PriorityLevelConfiguration は、優先度レベルの設定を表します。
object

1.7. ResourceQuota [v1]

説明
ResourceQuota は、名前空間ごとに適用される集約クォータ制限を設定します
object

第2章 AppliedClusterResourceQuota [quota.openshift.io/v1]

説明

AppliedClusterResourceQuota は、プロジェクトに投影するために、プロジェクトスコープで ClusterResourceQuota をミラーリングします。これにより、プロジェクト管理者は、プロジェクトに適用されている ClusterResourceQuotas とそれに関連する使用法を知ることができます。

互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

object
必須
  • metadata
  • spec

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

ClusterResourceQuotaSpec は、必要なクォータ制限を定義します

status

object

ClusterResourceQuotaStatus は、実際に適用されるクォータとその現在の使用量を定義します

2.1.1. .spec

説明
ClusterResourceQuotaSpec は、必要なクォータ制限を定義します
object
必須
  • selector
  • quota
Expand
プロパティー説明

quota

ResourceQuotaSpec

クォータは、必要なクォータを定義します

selector

object

ClusterResourceQuotaSelector は、プロジェクトを選択するために使用されます。LabelSelector または AnnotationSelector の少なくとも 1 つが存在する必要があります。1 つだけが存在する場合、それが唯一の選択基準です。両方を指定する場合、プロジェクトは両方の制限に一致する必要があります。

2.1.2. .spec.selector

説明
ClusterResourceQuotaSelector は、プロジェクトを選択するために使用されます。LabelSelector または AnnotationSelector の少なくとも 1 つが存在する必要があります。1 つだけが存在する場合、それが唯一の選択基準です。両方を指定する場合、プロジェクトは両方の制限に一致する必要があります。
object
Expand
プロパティー説明

annotations

object (string)

AnnotationSelector は、アノテーションによってプロジェクトを選択するために使用されます。

labels

labelSelector

LabelSelector は、ラベルごとにプロジェクトを選択するために使用されます。

2.1.3. .status

説明
ClusterResourceQuotaStatus は、実際に適用されるクォータとその現在の使用量を定義します
object
必須
  • total
Expand
プロパティー説明

namespace

array

名前空間は、プロジェクトごとに使用量をスライスします。この分割により、すべてのプロジェクト間で再計算を行うことなく、単一のプロジェクト内での削除調整を迅速に解決できます。これは、特定のプロジェクトのデルタをプルするために使用できます。

namespaces[]

object

ResourceQuotaStatusByNamespace は、特定のプロジェクトのステータスを提供します

total

ResourceQuotaStatus

Total は、すべてのプロジェクトで実際に適用される割り当てとその現在の使用量を定義します

2.1.4. .status.namespaces

説明
名前空間は、プロジェクトごとに使用量をスライスします。この分割により、すべてのプロジェクト間で再計算を行うことなく、単一のプロジェクト内での削除調整を迅速に解決できます。これは、特定のプロジェクトのデルタをプルするために使用できます。
array

2.1.5. .status.namespaces[]

説明
ResourceQuotaStatusByNamespace は、特定のプロジェクトのステータスを提供します
object
必須
  • namespace
  • status
Expand
プロパティー説明

namespace

string

このステータスが適用されるプロジェクトの名前空間

status

ResourceQuotaStatus

ステータスは、このプロジェクトによって消費されたリソースの数を示します

2.2. API エンドポイント

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

  • /apis/quota.openshift.io/v1/appliedclusterresourcequotas

    • GET: 種類のオブジェクトをリスト表示する AppliedClusterResourceQuota
  • /apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas

    • GET: 種類のオブジェクトをリスト表示する AppliedClusterResourceQuota
  • /apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas/{name}

    • GET: 指定された AppliedClusterResourceQuota を読み取ります

2.2.1. /apis/quota.openshift.io/v1/appliedclusterresourcequotas

HTTP メソッド
GET
説明
AppliedClusterResourceQuota の種類のオブジェクトをリスト表示します
Expand
表2.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

AppliedClusterResourceQuotaList schema

401 - Unauthorized

空白

2.2.2. /apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas

HTTP メソッド
GET
説明
AppliedClusterResourceQuota の種類のオブジェクトをリスト表示します
Expand
表2.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

AppliedClusterResourceQuotaList schema

401 - Unauthorized

空白

2.2.3. /apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas/{name}

Expand
表2.3 グローバルパスパラメーター
パラメーター説明

name

string

AppliedClusterResourceQuota の名前

HTTP メソッド
GET
説明
指定された AppliedClusterResourceQuota を読み取ります
Expand
表2.4 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

AppliedClusterResourceQuota schema

401 - Unauthorized

空白

第3章 ClusterResourceQuota [quota.openshift.io/v1]

説明
ClusterResourceQuota は、クラスタースコープで ResourceQuota をミラーリングします。このオブジェクトは、クォータ評価を再利用できるように、合成 ResourceQuota オブジェクトに簡単に変換できます。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
object
必須
  • metadata
  • spec

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

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

spec

object

仕様は、必要なクォータを定義します

status

object

ステータスは、実際に適用される割り当てとその現在の使用量を定義します

3.1.1. .spec

説明
仕様は、必要なクォータを定義します
object
必須
  • quota
  • selector
Expand
プロパティー説明

quota

object

クォータは、必要なクォータを定義します

selector

object

セレクターは、プロジェクトを照合するために使用されるセレクターです。数十の規模でアクティブなプロジェクトのみを選択する必要があります (ただし、アクティブでないプロジェクトをさらに多く選択できます)。これらのプロジェクトは、このリソースを介したオブジェクトの作成をめぐって争います。

3.1.2. .spec.quota

説明
クォータは、必要なクォータを定義します
object
Expand
プロパティー説明

重度

integer-or-string

hard は、名前付きリソースごとに必要なハード制限のセットです。詳細: https://kubernetes.io/docs/concepts/policy/resource-quotas/

scopeSelector

object

scopeSelector も、スコープと同じようなフィルターのコレクションであり、クォータで追跡されるが ScopeSelectorOperator を使用して表現される各オブジェクトに一致する必要があります。リソースを一致させるには、スコープと scopeSelector (spec で指定されている場合) の両方が一致する必要があります。

scopes

array (string)

クォータで追跡される各オブジェクトに一致する必要があるフィルターのコレクション。指定されていない場合、クォータはすべてのオブジェクトと一致します。

3.1.3. .spec.quota.scopeSelector

説明
scopeSelector も、スコープと同じようなフィルターのコレクションであり、クォータで追跡されるが ScopeSelectorOperator を使用して表現される各オブジェクトに一致する必要があります。リソースを一致させるには、スコープと scopeSelector (spec で指定されている場合) の両方が一致する必要があります。
object
Expand
プロパティー説明

matchExpressions

array

リソースのスコープごとのスコープセレクター要件のリスト。

matchExpressions[]

object

スコープ付きリソースセレクター要件は、値、スコープ名、およびスコープ名と値を関連付ける Operator を含むセレクターです。

3.1.4. .spec.quota.scopeSelector.matchExpressions

説明
リソースのスコープごとのスコープセレクター要件のリスト。
array

3.1.5. .spec.quota.scopeSelector.matchExpressions[]

説明
スコープ付きリソースセレクター要件は、値、スコープ名、およびスコープ名と値を関連付ける Operator を含むセレクターです。
object
必須
  • operator
  • scopeName
Expand
プロパティー説明

operator

string

一連の値に対するスコープの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。

scopeName

string

セレクターが適用されるスコープの名前。

values

array (string)

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

3.1.6. .spec.selector

説明
セレクターは、プロジェクトを照合するために使用されるセレクターです。数十の規模でアクティブなプロジェクトのみを選択する必要があります (ただし、アクティブでないプロジェクトをさらに多く選択できます)。これらのプロジェクトは、このリソースを介したオブジェクトの作成をめぐって争います。
object
Expand
プロパティー説明

annotations

未定義 (文字列)

AnnotationSelector は、アノテーションによってプロジェクトを選択するために使用されます。

labels

``

LabelSelector は、ラベルごとにプロジェクトを選択するために使用されます。

3.1.7. .status

説明
ステータスは、実際に適用される割り当てとその現在の使用量を定義します
object
必須
  • total
Expand
プロパティー説明

namespace

``

名前空間は、プロジェクトごとに使用量をスライスします。この分割により、すべてのプロジェクト間で再計算を行うことなく、単一のプロジェクト内での削除調整を迅速に解決できます。これは、特定のプロジェクトのデルタをプルするために使用できます。

total

object

Total は、すべてのプロジェクトで実際に適用される割り当てとその現在の使用量を定義します

3.1.8. .status.total

説明
Total は、すべてのプロジェクトで実際に適用される割り当てとその現在の使用量を定義します
object
Expand
プロパティー説明

重度

integer-or-string

Hard は、各名前付きリソースに強制されたハード制限のセットです。詳細: https://kubernetes.io/docs/concepts/policy/resource-quotas/

used

integer-or-string

namespace 内のリソースの現在確認される使用量の合計です。

3.2. API エンドポイント

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

  • /apis/quota.openshift.io/v1/clusterresourcequotas

    • DELETE:ClusterResourceQuota のコレクションを削除します
    • GET: 種類のオブジェクトをリスト表示する ClusterResourceQuota
    • POST:ClusterResourceQuota を作成します
  • /apis/quota.openshift.io/v1/watch/clusterresourcequotas

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

    • 削除:ClusterResourceQuota を削除します
    • GET: 指定された ClusterResourceQuota を読み取ります
    • PATCH: 指定された ClusterResourceQuota を部分的に更新します
    • PUT: 指定された ClusterResourceQuota を置き換えます
  • /apis/quota.openshift.io/v1/watch/clusterresourcequotas/{name}

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

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

3.2.1. /apis/quota.openshift.io/v1/clusterresourcequotas

HTTP メソッド
DELETE
説明
ClusterResourceQuota のコレクションを削除します
Expand
表3.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
ClusterResourceQuota の種類のオブジェクトをリスト表示します
Expand
表3.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ClusterResourceQuotaList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
ClusterResourceQuota を作成します
Expand
表3.3 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表3.4 ボディーパラメーター
パラメーター説明

body

ClusterResourceQuota スキーマ

 
Expand
表3.5 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ClusterResourceQuota スキーマ

201 - Created

ClusterResourceQuota スキーマ

202 - Accepted

ClusterResourceQuota スキーマ

401 - Unauthorized

空白

3.2.2. /apis/quota.openshift.io/v1/watch/clusterresourcequotas

HTTP メソッド
GET
説明
ClusterResourceQuota のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
Expand
表3.6 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

3.2.3. /apis/quota.openshift.io/v1/clusterresourcequotas/{name}

Expand
表3.7 グローバルパスパラメーター
パラメーター説明

name

string

ClusterResourceQuota の名前

HTTP メソッド
DELETE
説明
ClusterResourceQuota を削除します
Expand
表3.8 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表3.9 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された ClusterResourceQuota を読み取ります
Expand
表3.10 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ClusterResourceQuota スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表3.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterResourceQuota スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表3.14 ボディーパラメーター
パラメーター説明

body

ClusterResourceQuota スキーマ

 
Expand
表3.15 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ClusterResourceQuota スキーマ

201 - Created

ClusterResourceQuota スキーマ

401 - Unauthorized

空白

3.2.4. /apis/quota.openshift.io/v1/watch/clusterresourcequotas/{name}

Expand
表3.16 グローバルパスパラメーター
パラメーター説明

name

string

ClusterResourceQuota の名前

HTTP メソッド
GET
説明
ClusterResourceQuota の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
Expand
表3.17 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

3.2.5. /apis/quota.openshift.io/v1/clusterresourcequotas/{name}/status

Expand
表3.18 グローバルパスパラメーター
パラメーター説明

name

string

ClusterResourceQuota の名前

HTTP メソッド
GET
説明
指定された ClusterResourceQuota のステータスを読み取ります
Expand
表3.19 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ClusterResourceQuota スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表3.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterResourceQuota スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表3.23 ボディーパラメーター
パラメーター説明

body

ClusterResourceQuota スキーマ

 
Expand
表3.24 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ClusterResourceQuota スキーマ

201 - Created

ClusterResourceQuota スキーマ

401 - Unauthorized

空白

第4章 FlowSchema [flowcontrol.apiserver.k8s.io/v1]

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

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 の現在の状態を表します。

4.1.1. .spec

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

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 つのメンバーが要求に一致する場合にのみ、要求に一致します。

4.1.2. .spec.distinguisherMethod

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

type

string

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

4.1.3. .spec.priorityLevelConfiguration

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

name

string

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

4.1.4. .spec.rules

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

4.1.5. .spec.rules[]

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

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) (d1) リクエストで namespace が指定されておらず (つまり、Namespace=="")、clusterScope が true であるか、または (d2) リクエストで namespace が指定されており、namespace の少なくとも 1 つのメンバーがリクエストの namespace と一致する場合にリソースリクエストと一致します。

subjects

array

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

subjects[]

object

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

4.1.6. .spec.rules[].nonResourceRules

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

4.1.7. .spec.rules[].nonResourceRules[]

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

nonResourceURLs

array (string)

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

verbs

array (string)

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

4.1.8. .spec.rules[].resourceRules

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

4.1.9. .spec.rules[].resourceRules[]

説明
ResourcePolicyRule は、一部のリソースリクエストに一致する述語であり、リクエストの動詞とターゲットリソースをテストします。ResourcePolicyRule は、(a) 動詞の少なくとも 1 つのメンバーがリクエストと一致する、(b) apiGroups の少なくとも 1 つのメンバーがリクエストと一致する、(c) リソースの少なくとも 1 つのメンバーがリクエストと一致する場合、または (d) (d1) リクエストで namespace が指定されておらず (つまり、Namespace=="")、clusterScope が true であるか、または (d2) リクエストで namespace が指定されており、namespace の少なくとも 1 つのメンバーがリクエストの namespace と一致する場合にリソースリクエストと一致します。
object
必須
  • verbs
  • apiGroups
  • resources
Expand
プロパティー説明

apiGroups

array (string)

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

clusterScope

boolean

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

namespace

array (string)

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

resources

array (string)

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

verbs

array (string)

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

4.1.10. .spec.rules[].subjects

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

4.1.11. .spec.rules[].subjects[]

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

group

object

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

kind

string

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

serviceAccount

object

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

user

object

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

4.1.12. .spec.rules[].subjects[].group

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

name

string

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

4.1.13. .spec.rules[].subjects[].serviceAccount

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

name

string

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

namespace

string

namespace は、一致する ServiceAccount オブジェクトの namespace です。必須。

4.1.14. .spec.rules[].subjects[].user

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

name

string

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

4.1.15. .status

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

conditions

array

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

conditions[]

object

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

4.1.16. .status.conditions

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

4.1.17. .status.conditions[]

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

lastTransitionTime

time

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

message

string

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

reason

string

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

status

string

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

type

string

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

4.2. API エンドポイント

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

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

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

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

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

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

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

4.2.1. /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表4.2 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
FlowSchema の種類のオブジェクトをリスト表示または監視する
Expand
表4.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

FlowSchemaList スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表4.5 ボディーパラメーター
パラメーター説明

body

FlowSchema スキーマ

 
Expand
表4.6 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

FlowSchema スキーマ

201 - Created

FlowSchema スキーマ

202 - Accepted

FlowSchema スキーマ

401 - Unauthorized

空白

4.2.2. /apis/flowcontrol.apiserver.k8s.io/v1/watch/flowschemas

HTTP メソッド
GET
説明
FlowSchema のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
Expand
表4.7 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

4.2.3. /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}

Expand
表4.8 グローバルパスパラメーター
パラメーター説明

name

string

FlowSchema の名前

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表4.10 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された FlowSchema を読み取ります
Expand
表4.11 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

FlowSchema スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表4.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

FlowSchema スキーマ

201 - Created

FlowSchema スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表4.15 ボディーパラメーター
パラメーター説明

body

FlowSchema スキーマ

 
Expand
表4.16 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

FlowSchema スキーマ

201 - Created

FlowSchema スキーマ

401 - Unauthorized

空白

4.2.4. /apis/flowcontrol.apiserver.k8s.io/v1/watch/flowschemas/{name}

Expand
表4.17 グローバルパスパラメーター
パラメーター説明

name

string

FlowSchema の名前

HTTP メソッド
GET
説明
FlowSchema の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
Expand
表4.18 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

4.2.5. /apis/flowcontrol.apiserver.k8s.io/v1/flowschemas/{name}/status

Expand
表4.19 グローバルパスパラメーター
パラメーター説明

name

string

FlowSchema の名前

HTTP メソッド
GET
説明
指定された FlowSchema のステータスを読み取ります
Expand
表4.20 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

FlowSchema スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表4.22 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

FlowSchema スキーマ

201 - Created

FlowSchema スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表4.24 ボディーパラメーター
パラメーター説明

body

FlowSchema スキーマ

 
Expand
表4.25 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

FlowSchema スキーマ

201 - Created

FlowSchema スキーマ

401 - Unauthorized

空白

第5章 LimitRange [v1]

説明
LimitRange は、名前空間内のリソースの種類ごとにリソース使用制限を設定します。
object

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

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

spec

object

LimitRangeSpec は、種類が一致するリソースの最小/最大使用制限を定義します。

5.1.1. .spec

説明
LimitRangeSpec は、種類が一致するリソースの最小/最大使用制限を定義します。
object
必須
  • limits
Expand
プロパティー説明

limits

array

Limits は、適用される LimitRangeItem オブジェクトのリストです。

limits[]

object

LimitRangeItem は、種類が一致するリソースの最小/最大使用制限を定義します。

5.1.2. .spec.limits

説明
Limits は、適用される LimitRangeItem オブジェクトのリストです。
array

5.1.3. .spec.limits[]

説明
LimitRangeItem は、種類が一致するリソースの最小/最大使用制限を定義します。
object
必須
  • type
Expand
プロパティー説明

default

object (Quantity)

リソース制限が省略されている場合の、リソース名によるデフォルトのリソース要件制限値。

defaultRequest

object (Quantity)

DefaultRequest は、リソース要求が省略された場合の、リソース名によるデフォルトのリソース要件要求値です。

max

object (Quantity)

リソース名によるこの種類の最大使用制限。

maxLimitRequestRatio

object (Quantity)

MaxLimitRequestRatio を指定する場合、指定されたリソースには、両方ともゼロ以外の要求と制限が必要です。制限を要求で割った値が列挙値以下の場合。これは、指定されたリソースの最大バーストを表します。

min

object (Quantity)

リソース名によるこの種類の最小使用制限。

type

string

この制限が適用されるリソースのタイプ。

5.2. API エンドポイント

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

  • /api/v1/limitranges

    • GET:LimitRange の種類のオブジェクトをリスト表示または監視します
  • /api/v1/watch/limitranges

    • GET: LimitRange のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
  • /api/v1/namespaces/{namespace}/limitranges

    • DELETE:LimitRange のコレクションを削除します
    • GET:LimitRange の種類のオブジェクトをリスト表示または監視します
    • POST:LimitRange を作成します
  • /api/v1/watch/namespaces/{namespace}/limitranges

    • GET: LimitRange のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
  • /api/v1/namespaces/{namespace}/limitranges/{name}

    • 削除:LimitRange を削除します
    • GET: 指定された LimitRange を読み取ります
    • PATCH: 指定された LimitRange を部分的に更新します
    • PUT: 指定された LimitRange を置き換えます
  • /api/v1/watch/namespaces/{namespace}/limitranges/{name}

    • GET:LimitRange の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

5.2.1. /api/v1/limitranges

HTTP メソッド
GET
説明
LimitRange の種類のオブジェクトをリスト表示または監視する
Expand
表5.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

LimitRangeList スキーマ

401 - Unauthorized

空白

5.2.2. /api/v1/watch/limitranges

HTTP メソッド
GET
説明
LimitRange のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
Expand
表5.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

5.2.3. /api/v1/namespaces/{namespace}/limitranges

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表5.4 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
LimitRange の種類のオブジェクトをリスト表示または監視する
Expand
表5.5 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

LimitRangeList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
LimitRange を作成します
Expand
表5.6 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表5.7 ボディーパラメーター
パラメーター説明

body

LimitRange スキーマ

 
Expand
表5.8 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

LimitRange スキーマ

201 - Created

LimitRange スキーマ

202 - Accepted

LimitRange スキーマ

401 - Unauthorized

空白

5.2.4. /api/v1/watch/namespaces/{namespace}/limitranges

HTTP メソッド
GET
説明
LimitRange のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
Expand
表5.9 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

5.2.5. /api/v1/namespaces/{namespace}/limitranges/{name}

Expand
表5.10 グローバルパスパラメーター
パラメーター説明

name

string

LimitRange の名前

HTTP メソッド
DELETE
説明
LimitRange を削除します
Expand
表5.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表5.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された LimitRange を読み取ります
Expand
表5.13 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

LimitRange スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表5.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

LimitRange スキーマ

201 - Created

LimitRange スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表5.17 ボディーパラメーター
パラメーター説明

body

LimitRange スキーマ

 
Expand
表5.18 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

LimitRange スキーマ

201 - Created

LimitRange スキーマ

401 - Unauthorized

空白

5.2.6. /api/v1/watch/namespaces/{namespace}/limitranges/{name}

Expand
表5.19 グローバルパスパラメーター
パラメーター説明

name

string

LimitRange の名前

HTTP メソッド
GET
説明
LimitRange の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
Expand
表5.20 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

第6章 PriorityClass [scheduling.k8s.io/v1]

説明
PriorityClass は、優先度クラス名から優先度整数値へのマッピングを定義します。値は任意の有効な整数にすることができます。
object
必須
  • value

6.1. 仕様

Expand
プロパティー説明

apiVersion

string

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

description

string

description は、通常、この優先クラスをいつ使用すべきかのガイドラインを提供する任意の文字列です。

globalDefault

boolean

globalDefault は、この PriorityClass を、優先度クラスを持たない Pod のデフォルトの優先度と見なすかどうかを指定します。globalDefault としてマークできる PriorityClass は 1 つだけです。ただし、globalDefault フィールドが true に設定された PriorityClasses が複数存在する場合、そのようなグローバルなデフォルトの PriorityClasses の最小値がデフォルトの優先度として使用されます。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

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

preemptionPolicy

string

preemptionPolicy は、優先度の低い Pod をプリエンプトするためのポリシーです。Never、PreemptLowerPriority の 1 つ。設定されていない場合、デフォルトは PreemptLowerPriority です。

使用可能な列挙値: - "Never" は Pod が優先順位の低い他の Pod をプリエンプトしないことを意味します。- "PreemptLowerPriority" は Pod が優先順位の低い他の Pod をプリエンプトできることを意味します。

value

integer

value は、この優先度クラスの整数値を表します。これは、Pod 仕様にこのクラスの名前が含まれている場合に Pod が受け取る実際の優先順位です。

6.2. API エンドポイント

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

  • /apis/scheduling.k8s.io/v1/priorityclasses

    • DELETE:PriorityClass のコレクションを削除します
    • GET:PriorityClass の種類のオブジェクトをリスト表示または監視します
    • POST:PriorityClass を作成します
  • /apis/scheduling.k8s.io/v1/watch/priorityclasses

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

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

    • GET:PriorityClass の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

6.2.1. /apis/scheduling.k8s.io/v1/priorityclasses

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表6.2 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
PriorityClass の種類のオブジェクトをリスト表示または監視する
Expand
表6.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PriorityClassList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
PriorityClass を作成する
Expand
表6.4 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表6.5 ボディーパラメーター
パラメーター説明

body

PriorityClass スキーマ

 
Expand
表6.6 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PriorityClass スキーマ

201 - Created

PriorityClass スキーマ

202 - Accepted

PriorityClass スキーマ

401 - Unauthorized

空白

6.2.2. /apis/scheduling.k8s.io/v1/watch/priorityclasses

HTTP メソッド
GET
説明
PriorityClass のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
Expand
表6.7 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

6.2.3. /apis/scheduling.k8s.io/v1/priorityclasses/{name}

Expand
表6.8 グローバルパスパラメーター
パラメーター説明

name

string

PriorityClass の名前

HTTP メソッド
DELETE
説明
PriorityClass を削除します
Expand
表6.9 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表6.10 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された PriorityClass を読み取ります
Expand
表6.11 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PriorityClass スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表6.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PriorityClass スキーマ

201 - Created

PriorityClass スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表6.15 ボディーパラメーター
パラメーター説明

body

PriorityClass スキーマ

 
Expand
表6.16 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PriorityClass スキーマ

201 - Created

PriorityClass スキーマ

401 - Unauthorized

空白

6.2.4. /apis/scheduling.k8s.io/v1/watch/priorityclasses/{name}

Expand
表6.17 グローバルパスパラメーター
パラメーター説明

name

string

PriorityClass の名前

HTTP メソッド
GET
説明
PriorityClass の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
Expand
表6.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

第7章 PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1]

説明
PriorityLevelConfiguration は、優先度レベルの設定を表します。
object

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

PriorityLevelConfigurationSpec は、優先度レベルの設定を指定します。

status

object

PriorityLevelConfigurationStatus は、"request-priority" の現在の状態を表します。

7.1.1. .spec

説明
PriorityLevelConfigurationSpec は、優先度レベルの設定を指定します。
object
必須
  • type
Expand
プロパティー説明

exempt

object

ExemptPriorityLevelConfiguration は、免除要求の処理の設定可能な側面を説明します。必須の免除設定オブジェクトでは、spec の残りの部分とは異なり、ここのフィールドの値は承認されたユーザーによって変更できます。

非常に限定される

object

LimitedPriorityLevelConfiguration は、制限の対象となる要求を処理する方法を指定します。これは、- この優先レベルのリクエストはどのように制限されますか? - 制限を超えたリクエストはどうすればよいですか? という、2 つの問題に対処します。

type

string

type は、この優先度レベルがリクエストの実行に制限を受けるかどうかを示します。"Exempt" の値は、この優先度レベルの要求が制限の対象ではなく (したがって、キューに入れられることはありません)、他の優先度レベルで使用できる容量を損なうことがないことを意味します。"Limited" の値は、(a) この優先度レベルの要求 制限の対象となり、(b) サーバーの制限された容量の一部がこの優先度レベルでのみ使用可能になることを意味します。必須。

7.1.2. .spec.exempt

説明
ExemptPriorityLevelConfiguration は、免除要求の処理の設定可能な側面を説明します。必須の免除設定オブジェクトでは、spec の残りの部分とは異なり、ここのフィールドの値は承認されたユーザーによって変更できます。
object
Expand
プロパティー説明

lendablePercent

integer

lendablePercent は、他の優先レベルで借用できるレベルの NominalCL の割合を規定します。このフィールドの値は、0 から 100 までの値である必要があり、デフォルトは 0 です。他のレベルがこのレベルから借用できるシートの数 (このレベルの LendableConcurrencyLimit (LendableCL) と呼ばれます) は、次のように定義されます。

LendableCL(i) = round( NominalCL(i) * lendablePercent(i)/100.0 )

nominalConcurrencyShares

integer

nominalConcurrencyShares (NCS) は、このレベルの NominalConcurrencyLimit (NominalCL) の計算に寄与します。これは、この優先度レベルに名目上予約されている実行座席の数です。これは、この優先レベルからのディスパッチを制限するものではありませんが、借用メカニズムを通じて他の優先レベルに影響を与えます。サーバーの同時実行制限 (ServerCL) は、NCS 値に比例してすべての優先レベルで分割されます。

NominalCL(i) = ceil( ServerCL * NCS(i) / sum_ncs ) sum_ncs = sum[priority level k] NCS(k)

数値が大きいほど、他のすべての優先レベルを犠牲にして、名目上の同時実行制限が大きくなることを意味します。このフィールドのデフォルト値はゼロです。

7.1.3. .spec.limited

説明
LimitedPriorityLevelConfiguration は、制限の対象となる要求を処理する方法を指定します。これは、- この優先レベルのリクエストはどのように制限されますか? - 制限を超えたリクエストはどうすればよいですか? という、2 つの問題に対処します。
object
Expand
プロパティー説明

borrowingLimitPercent

integer

borrowingLimitPercent が存在する場合、この優先レベルが他の優先レベルから借用できるシート数の制限を設定します。この制限は、このレベルの BorrowingConcurrencyLimit (BorrowingCL) として知られており、このレベルが一度に借用できるシートの合計数の制限です。このフィールドは、名目上、レベルの同時実行制限に対するその制限の比率を保持します。このフィールドが nil 以外の場合は、負ではない整数を保持する必要があり、制限は次のように計算されます。

BorrowingCL(i) = round( NominalCL(i) * borrowingLimitPercent(i)/100.0 )

このフィールドの値は 100 を超える可能性があり、この優先レベルが名目上の独自の同時実行制限 (NominalCL) を超える数のシートを借用できることを意味します。このフィールドが nil のままの場合、制限は事実上無限になります。

lendablePercent

integer

lendablePercent は、他の優先レベルで借用できるレベルの NominalCL の割合を規定します。このフィールドの値は、0 から 100 までの値である必要があり、デフォルトは 0 です。他のレベルがこのレベルから借用できるシートの数 (このレベルの LendableConcurrencyLimit (LendableCL) と呼ばれます) は、次のように定義されます。

LendableCL(i) = round( NominalCL(i) * lendablePercent(i)/100.0 )

limitResponse

object

LimitResponse は、現在実行できないリクエストを処理する方法を定義します。

nominalConcurrencyShares

integer

nominalConcurrencyShares (NCS) は、このレベルの NominalConcurrencyLimit (NominalCL) の計算に寄与します。これは、この優先レベルで利用可能な実行シートの数です。この設定は、この優先レベルからディスパッチされるリクエストと、このレベルからシートを借りて、他の優先レベルからディスパッチされるリクエストの両方に使用されます。サーバーの同時実行制限 (ServerCL) は、NCS 値に比例して制限付き優先度レベルに分割されます。

NominalCL(i) = ceil( ServerCL * NCS(i) / sum_ncs ) sum_ncs = sum[priority level k] NCS(k)

数値が大きいほど、他のすべての優先レベルを犠牲にして、名目上の同時実行制限が大きくなることを意味します。

指定されていないと、このフィールドの値はデフォルトで 30 になります。

このフィールドをゼロに設定すると、この優先度レベルの "jail" の構築がサポートされ、いくつかのリクエストを保持するのに使用されます。

7.1.4. .spec.limited.limitResponse

説明
LimitResponse は、現在実行できないリクエストを処理する方法を定義します。
object
必須
  • type
Expand
プロパティー説明

キューイング

object

QueuingConfiguration は、キューイングの設定パラメーターを保持します

type

string

type は "Queue" または "Reject" です。"Queue" は、到着時に実行できない要求が、実行可能になるか、キュー制限に達するまでキューに保持されることを意味します。"Reject" は、到着時に実行できないリクエストが拒否されることを意味します。必須。

7.1.5. .spec.limited.limitResponse.queuing

説明
QueuingConfiguration は、キューイングの設定パラメーターを保持します
object
Expand
プロパティー説明

handSize

integer

handSize は、キューへの要求のシャッフルシャーディングを設定する小さな正の数です。この優先度レベルでリクエストをキューに入れると、リクエストのフロー識別子 (文字列ペア) がハッシュされ、ハッシュ値を使用してキューのリストがシャッフルされ、ここで指定されたサイズのハンドが処理されます。リクエストは、そのハンドで最も短いキューの 1 つに入れられます。handSizeキュー より大きくてはならず、大幅に小さくする必要があります (これにより、いくつかの大量のフローがほとんどのキューを飽和させないようにします)。このフィールドの設定に関するより詳細なガイダンスは、ユーザー向けのドキュメントを参照してください。このフィールドのデフォルト値は 8 です。

queueLengthLimit

integer

queueLengthLimit は、この優先度レベルの特定のキューで一度に待機できるリクエストの最大数です。超過したリクエストは拒否されます。この値は正である必要があります。指定しない場合、デフォルトで 50 になります。

queues

integer

queues は、この優先度レベルのキューの数です。キューは、各 apiserver に独立して存在します。値は正でなければなりません。これを 1 に設定すると、シャッフルシャーディングが効果的に排除されるため、関連するフロースキーマの識別方法が無関係になります。このフィールドのデフォルト値は 64 です。

7.1.6. .status

説明
PriorityLevelConfigurationStatus は、"request-priority" の現在の状態を表します。
object
Expand
プロパティー説明

conditions

array

conditions は "リクエスト優先" の現状です。

conditions[]

object

PriorityLevelConfigurationCondition は、優先度レベルの条件を定義します。

7.1.7. .status.conditions

説明
conditions は "リクエスト優先" の現状です。
array

7.1.8. .status.conditions[]

説明
PriorityLevelConfigurationCondition は、優先度レベルの条件を定義します。
object
Expand
プロパティー説明

lastTransitionTime

time

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

message

string

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

reason

string

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

status

string

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

type

string

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

7.2. API エンドポイント

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

  • /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations

    • DELETE:PriorityLevelConfiguration のコレクションを削除します
    • GET:PriorityLevelConfiguration の種類のオブジェクトをリスト表示または監視します
    • POST:PriorityLevelConfiguration を作成します
  • /apis/flowcontrol.apiserver.k8s.io/v1/watch/prioritylevelconfigurations

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

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

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

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

7.2.1. /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表7.2 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
PriorityLevelConfiguration の種類のオブジェクトをリスト表示または監視する
Expand
表7.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PriorityLevelConfigurationList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
PriorityLevelConfiguration を作成します
Expand
表7.4 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表7.5 ボディーパラメーター
パラメーター説明

body

PriorityLevelConfiguration スキーマ

 
Expand
表7.6 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PriorityLevelConfiguration スキーマ

201 - Created

PriorityLevelConfiguration スキーマ

202 - Accepted

PriorityLevelConfiguration スキーマ

401 - Unauthorized

空白

7.2.2. /apis/flowcontrol.apiserver.k8s.io/v1/watch/prioritylevelconfigurations

HTTP メソッド
GET
説明
PriorityLevelConfiguration のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
Expand
表7.7 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

7.2.3. /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}

Expand
表7.8 グローバルパスパラメーター
パラメーター説明

name

string

PriorityLevelConfiguration の名前

HTTP メソッド
DELETE
説明
PriorityLevelConfiguration を削除します
Expand
表7.9 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表7.10 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された PriorityLevelConfiguration を読み取ります
Expand
表7.11 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PriorityLevelConfiguration スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表7.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PriorityLevelConfiguration スキーマ

201 - Created

PriorityLevelConfiguration スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表7.15 ボディーパラメーター
パラメーター説明

body

PriorityLevelConfiguration スキーマ

 
Expand
表7.16 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PriorityLevelConfiguration スキーマ

201 - Created

PriorityLevelConfiguration スキーマ

401 - Unauthorized

空白

7.2.4. /apis/flowcontrol.apiserver.k8s.io/v1/watch/prioritylevelconfigurations/{name}

Expand
表7.17 グローバルパスパラメーター
パラメーター説明

name

string

PriorityLevelConfiguration の名前

HTTP メソッド
GET
説明
PriorityLevelConfiguration の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
Expand
表7.18 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

7.2.5. /apis/flowcontrol.apiserver.k8s.io/v1/prioritylevelconfigurations/{name}/status

Expand
表7.19 グローバルパスパラメーター
パラメーター説明

name

string

PriorityLevelConfiguration の名前

HTTP メソッド
GET
説明
指定された PriorityLevelConfiguration のステータスを読み取ります
Expand
表7.20 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PriorityLevelConfiguration スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表7.22 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

PriorityLevelConfiguration スキーマ

201 - Created

PriorityLevelConfiguration スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表7.24 ボディーパラメーター
パラメーター説明

body

PriorityLevelConfiguration スキーマ

 
Expand
表7.25 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PriorityLevelConfiguration スキーマ

201 - Created

PriorityLevelConfiguration スキーマ

401 - Unauthorized

空白

第8章 ResourceQuota [v1]

説明
ResourceQuota は、名前空間ごとに適用される集約クォータ制限を設定します
object

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

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

spec

object

ResourceQuotaSpec は、クォータに適用する必要のあるハード制限を定義します。

status

object

ResourceQuotaStatus は、強制されたハード制限と監視対象の使用を定義します。

8.1.1. .spec

説明
ResourceQuotaSpec は、クォータに適用する必要のあるハード制限を定義します。
object
Expand
プロパティー説明

重度

object (Quantity)

hard は、名前付きリソースごとに必要なハード制限のセットです。詳細: https://kubernetes.io/docs/concepts/policy/resource-quotas/

scopeSelector

object

スコープセレクターは、スコープ付きリソースセレクター要件によって表されるセレクターの AND を表します。

scopes

array (string)

クォータで追跡される各オブジェクトに一致する必要があるフィルターのコレクション。指定されていない場合、クォータはすべてのオブジェクトと一致します。

8.1.2. .spec.scopeSelector

説明
スコープセレクターは、スコープ付きリソースセレクター要件によって表されるセレクターの AND を表します。
object
Expand
プロパティー説明

matchExpressions

array

リソースのスコープごとのスコープセレクター要件のリスト。

matchExpressions[]

object

スコープ付きリソースセレクター要件は、値、スコープ名、およびスコープ名と値を関連付ける Operator を含むセレクターです。

8.1.3. .spec.scopeSelector.matchExpressions

説明
リソースのスコープごとのスコープセレクター要件のリスト。
array

8.1.4. .spec.scopeSelector.matchExpressions[]

説明
スコープ付きリソースセレクター要件は、値、スコープ名、およびスコープ名と値を関連付ける Operator を含むセレクターです。
object
必須
  • scopeName
  • operator
Expand
プロパティー説明

operator

string

一連の値に対するスコープの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。

使用可能な列挙値: - "DoesNotExist" - "Exists" - "In" - "NotIn"

scopeName

string

セレクターが適用されるスコープの名前。

使用可能な列挙値: - "BestEffort" は、QoS がベストエフォートの Pod オブジェクトすべてに一致します。- "CrossNamespacePodAffinity" は、cross-namespace Pod (非) アフィニティーが言及されている Pod オブジェクトすべてに一致します。- "NotBestEffort" は、QoS がベストエフォートではない Pod オブジェクトすべてに一致します。- "NotTerminating" は、spec.activeDeadlineSeconds が nil の Pod オブジェクトすべてに一致します。- "PriorityClass" は、優先クラスが言及されている Pod オブジェクトすべてに一致します。- "Terminating" spec.activeDeadlineSeconds >=0 の Pod オブジェクトすべてに一致します。

values

array (string)

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

8.1.5. .status

説明
ResourceQuotaStatus は、強制されたハード制限と監視対象の使用を定義します。
object
Expand
プロパティー説明

重度

object (Quantity)

Hard は、各名前付きリソースに強制されたハード制限のセットです。詳細: https://kubernetes.io/docs/concepts/policy/resource-quotas/

used

object (Quantity)

namespace 内のリソースの現在確認される使用量の合計です。

8.2. API エンドポイント

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

  • /api/v1/resourcequotas

    • GET:ResourceQuota の種類のオブジェクトをリスト表示または監視します
  • /api/v1/watch/resourcequotas

    • GET:ResourceQuota のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
  • /api/v1/namespaces/{namespace}/resourcequotas

    • DELETE:ResourceQuota のコレクションを削除します
    • GET:ResourceQuota の種類のオブジェクトをリスト表示または監視します
    • POST:ResourceQuota を作成します
  • /api/v1/watch/namespaces/{namespace}/resourcequotas

    • GET:ResourceQuota のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
  • /api/v1/namespaces/{namespace}/resourcequotas/{name}

    • 削除:ResourceQuota を削除します
    • GET: 指定された ResourceQuota を読み取ります
    • PATCH: 指定された ResourceQuota を部分的に更新します
    • PUT: 指定された ResourceQuota を置き換えます
  • /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}

    • GET:ResourceQuota の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
  • /api/v1/namespaces/{namespace}/resourcequotas/{name}/status

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

8.2.1. /api/v1/resourcequotas

HTTP メソッド
GET
説明
ResourceQuota の種類のオブジェクトをリスト表示または監視する
Expand
表8.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ResourceQuotaList スキーマ

401 - Unauthorized

空白

8.2.2. /api/v1/watch/resourcequotas

HTTP メソッド
GET
説明
ResourceQuota のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
Expand
表8.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

8.2.3. /api/v1/namespaces/{namespace}/resourcequotas

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表8.4 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
ResourceQuota の種類のオブジェクトをリスト表示または監視する
Expand
表8.5 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ResourceQuotaList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
ResourceQuota を作成する
Expand
表8.6 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表8.7 ボディーパラメーター
パラメーター説明

body

ResourceQuota スキーマ

 
Expand
表8.8 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ResourceQuota スキーマ

201 - Created

ResourceQuota スキーマ

202 - Accepted

ResourceQuota スキーマ

401 - Unauthorized

空白

8.2.4. /api/v1/watch/namespaces/{namespace}/resourcequotas

HTTP メソッド
GET
説明
ResourceQuota のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
Expand
表8.9 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

8.2.5. /api/v1/namespaces/{namespace}/resourcequotas/{name}

Expand
表8.10 グローバルパスパラメーター
パラメーター説明

name

string

ResourceQuota の名前

HTTP メソッド
DELETE
説明
ResourceQuota を削除します
Expand
表8.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表8.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ResourceQuota スキーマ

202 - Accepted

ResourceQuota スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された ResourceQuota を読み取ります
Expand
表8.13 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ResourceQuota スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表8.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ResourceQuota スキーマ

201 - Created

ResourceQuota スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表8.17 ボディーパラメーター
パラメーター説明

body

ResourceQuota スキーマ

 
Expand
表8.18 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ResourceQuota スキーマ

201 - Created

ResourceQuota スキーマ

401 - Unauthorized

空白

8.2.6. /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}

Expand
表8.19 グローバルパスパラメーター
パラメーター説明

name

string

ResourceQuota の名前

HTTP メソッド
GET
説明
ResourceQuota の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
Expand
表8.20 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

8.2.7. /api/v1/namespaces/{namespace}/resourcequotas/{name}/status

Expand
表8.21 グローバルパスパラメーター
パラメーター説明

name

string

ResourceQuota の名前

HTTP メソッド
GET
説明
指定された ResourceQuota のステータスを読み取ります
Expand
表8.22 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ResourceQuota スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表8.24 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ResourceQuota スキーマ

201 - Created

ResourceQuota スキーマ

401 - Unauthorized

空白

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

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表8.26 ボディーパラメーター
パラメーター説明

body

ResourceQuota スキーマ

 
Expand
表8.27 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ResourceQuota スキーマ

201 - Created

ResourceQuota スキーマ

401 - Unauthorized

空白

Legal Notice

Copyright © 2025 Red Hat

OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).

Modified versions must remove all Red Hat trademarks.

Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat