10.2. HorizontalPodAutoscaler [autoscaling/v2]

behavior

object

horizontalPodAutoscalerBehavior は、上方向と下方向の両方のターゲットのスケーリング動作を設定します (それぞれ、scaleUp フィールドと scaleDown フィールド)。

maxReplicas

integer

maxReplicas は、Autoscaler がスケールアップできるレプリカの数の上限です。minReplicas の数より少なくすることはできません。

metrics

array

metrics には、必要なレプリカ数を計算するために使用する仕様が含まれています (すべてのメトリックでの最大レプリカ数が使用されます)。必要なレプリカ数は、ターゲット値と現在の値の比率に現在の Pod 数を乗算して計算されます。したがって、Pod 数が増加すると、使用されるメトリックを減らす必要があります。またその逆も同様です。各タイプのメトリックがどのように応答する必要があるかについては、個々のメトリックソースタイプを参照してください。設定されていない場合、デフォルトのメトリックは平均 CPU 使用率 80% に設定されます。

metrics[]

object

MetricSpec は、単一のメトリックに基づいてスケーリングする方法を指定します (一度に設定できるのは、type と他の 1 つの一致フィールドのみです)。

minReplicas

integer

minReplicas は、オートスケーラーがスケールダウンできるレプリカの数の下限です。デフォルトは 1Pod です。アルファ機能ゲート HPAScaleToZero が有効で、少なくとも 1 つのオブジェクトまたは外部メトリックが設定されている場合、minReplicas は 0 になります。スケーリングは、少なくとも 1 つのメトリック値が使用可能である限りアクティブです。

scaleTargetRef

object

CrossVersionObjectReference には、参照されたリソースを識別できるようにするための十分な情報が含まれています。

scaleDown

object

HPAScalingRules は、一方向のスケーリング動作を設定します。これらのルールは、HPA のメトリクスから DesiredReplicas を計算した後に適用されます。スケーリングポリシーを指定することで、スケーリング速度を制限できます。安定化ウィンドウを指定してフラッピングを防ぐことができ、レプリカの数が即座に設定されるのではなく、固定化ウィンドウから最も安全な値が選択されます。

scaleUp

object

HPAScalingRules は、一方向のスケーリング動作を設定します。これらのルールは、HPA のメトリクスから DesiredReplicas を計算した後に適用されます。スケーリングポリシーを指定することで、スケーリング速度を制限できます。安定化ウィンドウを指定してフラッピングを防ぐことができ、レプリカの数が即座に設定されるのではなく、固定化ウィンドウから最も安全な値が選択されます。

policies

array

ポリシーは、スケーリング中に使用できる潜在的なスケーリングポリシーのリストです。少なくとも 1 つのポリシーを指定する必要があります。指定しない場合、HPAScalingRules は無効として破棄されます。

policies[]

object

HPAScalingPolicy は、指定された過去の期間にわたって合致する必要がある単一のポリシーです。

selectPolicy

string

selectPolicy は、どのポリシーを使用するかを指定するために使用されます。設定されていない場合は、デフォルト値の Max が使用されます。

stabilizationWindowSeconds

integer

StabilizationWindowSeconds は、スケールアップまたはスケールダウン中に過去の推奨事項を考慮する必要がある時間 (秒) です。StabilizationWindowSeconds は、0 以上 3600 (1 時間) 以下である必要があります。設定されていない場合は、デフォルト値を使用します。- スケールアップの場合: 0 (固定化なし)。- スケールダウンの場合: 300 (固定化ウィンドウの長さは 300 秒です)。

periodSeconds

integer

periodSeconds は、ポリシーが適用される時間枠を指定します。PeriodSeconds は、0 より大きく、1800 (30 分) 以下である必要があります。

type

string

type はスケーリングポリシーを指定するために使用されます。

value

integer

value には、ポリシーによって許可されている変更量が含まれます。ゼロより大きくなければなりません

policies

array

ポリシーは、スケーリング中に使用できる潜在的なスケーリングポリシーのリストです。少なくとも 1 つのポリシーを指定する必要があります。指定しない場合、HPAScalingRules は無効として破棄されます。

policies[]

object

HPAScalingPolicy は、指定された過去の期間にわたって合致する必要がある単一のポリシーです。

selectPolicy

string

selectPolicy は、どのポリシーを使用するかを指定するために使用されます。設定されていない場合は、デフォルト値の Max が使用されます。

stabilizationWindowSeconds

integer

StabilizationWindowSeconds は、スケールアップまたはスケールダウン中に過去の推奨事項を考慮する必要がある時間 (秒) です。StabilizationWindowSeconds は、0 以上 3600 (1 時間) 以下である必要があります。設定されていない場合は、デフォルト値を使用します。- スケールアップの場合: 0 (固定化なし)。- スケールダウンの場合: 300 (固定化ウィンドウの長さは 300 秒です)。

periodSeconds

integer

periodSeconds は、ポリシーが適用される時間枠を指定します。PeriodSeconds は、0 より大きく、1800 (30 分) 以下である必要があります。

type

string

type はスケーリングポリシーを指定するために使用されます。

value

integer

value には、ポリシーによって許可されている変更量が含まれます。ゼロより大きくなければなりません

containerResource

object

ContainerResourceMetricSource は、リクエストと制限で指定されているように、Kubernetes で認識されているリソースメトリックに基づいてスケーリングする方法を示します。各 Pod は、現在のスケールターゲット (CPU やメモリーなど) で記述します。値はターゲットと比較される前に平均化されます。このようなメトリックは Kubernetes に組み込まれており、Pod ソースを使用する通常の Pod ごとのメトリックに利用可能なオプションに加えて、特別なスケーリングオプションがあります。1 つの target タイプのみを設定する必要があります。

external

object

ExternalMetricSource は、Kubernetes オブジェクトに関連付けられていないメトリック (クラウドメッセージングサービスのキューの長さ、クラスターの外部で実行されているロードバランサーからの QPS など) に基づいてスケールする方法を示します。

object

object

ObjectMetricSource は、kubernetes オブジェクトを記述するメトリック (例: Ingress オブジェクトの 1 秒あたりのヒット数) をスケールする方法を示します。

pods

object

PodsMetricSource は、現在のスケールターゲットで各 Pod を記述するメトリック (例:1 秒あたりのトランザクション処理数) に基づいてスケールする方法を示します。値はターゲット値と比較される前に平均化されます。

resource

object

ResourceMetricSource は、リクエストと制限で指定されているように、Kubernetes で認識されているリソースメトリックに基づいてスケーリングする方法を示します。各 Pod は、現在のスケールターゲット (CPU やメモリーなど) で記述します。値はターゲットと比較される前に平均化されます。このようなメトリックは Kubernetes に組み込まれており、Pod ソースを使用する通常の Pod ごとのメトリックに利用可能なオプションに加えて、特別なスケーリングオプションがあります。1 つの target タイプのみを設定する必要があります。

type

string

type はメトリックソースのタイプです。これは、ContainerResource、外部、オブジェクト、Pod、またはリソースのいずれかである必要があり、それぞれがオブジェクト内の一致するフィールドにマッピングされます。注: ContainerResource タイプは、フィーチャーゲート HPAContainerMetrics が有効になっている場合に使用できます。

container

string

container は、スケーリングターゲットの Pod にあるコンテナーの名前です。

name

string

name は、対象のリソースの名前です。

target

object

MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。

averageUtilization

integer

averageUtilization は、関連する全 Pod のリソースメトリクスの平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。現在、Resource metric source type に対してのみ有効です

averageValue

Quantity

AverageValue は、関連するすべての Pod にわたるメトリックの平均ターゲット値 (数量) です。

type

string

type は、メトリックタイプが使用率、値、平均値のいずれであるかを表します。

value

Quantity

value は、メトリックの目標値 (数量として) です。

メトリクス

object

MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。

target

object

MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。

name

string

name は、指定されたメトリクスの名前です。

selector

LabelSelector

selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricsName のみがメトリクスの収集に使用されます。

averageUtilization

integer

averageUtilization は、関連する全 Pod のリソースメトリクスの平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。現在、Resource metric source type に対してのみ有効です

averageValue

Quantity

AverageValue は、関連するすべての Pod にわたるメトリックの平均ターゲット値 (数量) です。

type

string

type は、メトリックタイプが使用率、値、平均値のいずれであるかを表します。

value

Quantity

value は、メトリックの目標値 (数量として) です。

describedObject

object

CrossVersionObjectReference には、参照されたリソースを識別できるようにするための十分な情報が含まれています。

メトリクス

object

MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。

target

object

MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。

apiVersion

string

apiVersion は参照先の API バージョンです。

kind

string

kind は指示対象の種類です。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

name は指示対象の名前です。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

name

string

name は、指定されたメトリクスの名前です。

selector

LabelSelector

selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricsName のみがメトリクスの収集に使用されます。

averageUtilization

integer

averageUtilization は、関連する全 Pod のリソースメトリクスの平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。現在、Resource metric source type に対してのみ有効です

averageValue

Quantity

AverageValue は、関連するすべての Pod にわたるメトリックの平均ターゲット値 (数量) です。

type

string

type は、メトリックタイプが使用率、値、平均値のいずれであるかを表します。

value

Quantity

value は、メトリックの目標値 (数量として) です。

メトリクス

object

MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。

target

object

MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。

name

string

name は、指定されたメトリクスの名前です。

selector

LabelSelector

selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricsName のみがメトリクスの収集に使用されます。

averageUtilization

integer

averageUtilization は、関連する全 Pod のリソースメトリクスの平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。現在、Resource metric source type に対してのみ有効です

averageValue

Quantity

AverageValue は、関連するすべての Pod にわたるメトリックの平均ターゲット値 (数量) です。

type

string

type は、メトリックタイプが使用率、値、平均値のいずれであるかを表します。

value

Quantity

value は、メトリックの目標値 (数量として) です。

name

string

name は、対象のリソースの名前です。

target

object

MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。

averageUtilization

integer

averageUtilization は、関連する全 Pod のリソースメトリクスの平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。現在、Resource metric source type に対してのみ有効です

averageValue

Quantity

AverageValue は、関連するすべての Pod にわたるメトリックの平均ターゲット値 (数量) です。

type

string

type は、メトリックタイプが使用率、値、平均値のいずれであるかを表します。

value

Quantity

value は、メトリックの目標値 (数量として) です。

apiVersion

string

apiVersion は参照先の API バージョンです。

kind

string

kind は指示対象の種類です。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

name は指示対象の名前です。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

conditions

array

conditions は、このオートスケーラーがターゲットをスケーリングするために必要な一連の条件であり、それらの条件が満たされているかどうかを示します。

conditions[]

object

HorizontalPodAutoscalerCondition は、特定の時点での HorizontalPodAutoscaler の状態を記述します。

currentMetrics

array

currentMetrics は、このオートスケーラーによって使用されるメトリクスの最後の読み取り状態です。

currentMetrics[]

object

MetricStatus は、単一メトリックの最後に読み取られた状態を表します。

currentReplicas

integer

currentReplicas は、オートスケーラーが管理する Pod のレプリカ数で、オートスケーラーが最後に確認した数値です。

desiredReplicas

integer

desiredReplicas は、オートスケーラーが管理する Pod の任意のレプリカ数で、オートスケーラーが最後に計算した数値です。

lastScaleTime

Time

lastScaleTime は、horizontalPodAutoscaler が Pod の数を最後にスケーリングした時間であり、オートスケーラーが Pod の数を変更する頻度を制御するために使用されます。

observedGeneration

integer

observedGeneration は、このオートスケーラーによって確認された最新の世代です。

lastTransitionTime

Time

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

message

string

message は、遷移の詳細を含む、人間が判読できる説明です。

reason

string

reason は、条件の最後の遷移の理由です。

status

string

status は条件のステータス (True、False、Unknown) です。

type

string

type は現在の状態を表します

containerResource

object

ContainerResourceMetricStatus は、リクエストと制限で指定されているように、Kubernetes で認識されているリソースメトリックの現在値を示し、現在のスケールターゲット (CPU やメモリーなど) で、各 Pod に含まれる単一のコンテナーを記述します。このようなメトリックは Kubernetes に組み込まれており、Pod ソースを使用する通常の Pod ごとのメトリックに利用可能なオプションに加えて、特別なスケーリングオプションがあります。

external

object

ExternalMetricStatus は、Kubernetes オブジェクトに関連付けられていないグローバルメトリクスの現在の値を示します。

object

object

ObjectMetricStatus は、kubernetes オブジェクトを説明するメトリックの現在の値 (例: Ingress オブジェクトの 1 秒あたりのヒット数) を示します。

pods

object

PodsMetricStatus は、現在のスケールターゲット内の各 Pod を説明するメトリックの現在の値 (例: 1 秒あたりのトランザクション処理数) を示します。

resource

object

ResourceMetricStatus は、リクエストと制限で指定されているように、Kubernetes に認識されているリソースメトリックの現在の値を示し、現在のスケールターゲット (CPU やメモリーなど) で各 Pod を記述します。このようなメトリックは Kubernetes に組み込まれており、Pod ソースを使用する通常の Pod ごとのメトリックに利用可能なオプションに加えて、特別なスケーリングオプションがあります。

type

string

type はメトリックソースのタイプです。これは ContainerResource、外部、オブジェクト、Pod、またはリソースのいずれかであり、それぞれがオブジェクト内の一致するフィールドに対応します。注: ContainerResource タイプは、フィーチャーゲート HPAContainerMetrics が有効になっている場合に使用できます。

container

string

container は、スケーリングターゲットの Pod にあるコンテナーの名前です。

current

object

MetricValueStatus は、メトリクスの現在の値を保持します

name

string

name は、対象のリソースの名前です。

averageUtilization

integer

curentAverageUtilization は、関連する全 Pod のリソースメトリクスの現在における平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。

averageValue

Quantity

AverageValue は、関連するすべての Pod にわたるメトリックの現在における平均値です (数量)。

value

Quantity

value は、メトリックの現在における平均値 (数量) です。

current

object

MetricValueStatus は、メトリクスの現在の値を保持します

メトリクス

object

MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。

averageUtilization

integer

curentAverageUtilization は、関連する全 Pod のリソースメトリクスの現在における平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。

averageValue

Quantity

AverageValue は、関連するすべての Pod にわたるメトリックの現在における平均値です (数量)。

value

Quantity

value は、メトリックの現在における平均値 (数量) です。

name

string

name は、指定されたメトリクスの名前です。

selector

LabelSelector

selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricsName のみがメトリクスの収集に使用されます。

current

object

MetricValueStatus は、メトリクスの現在の値を保持します

describedObject

object

CrossVersionObjectReference には、参照されたリソースを識別できるようにするための十分な情報が含まれています。

メトリクス

object

MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。

averageUtilization

integer

curentAverageUtilization は、関連する全 Pod のリソースメトリクスの現在における平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。

averageValue

Quantity

AverageValue は、関連するすべての Pod にわたるメトリックの現在における平均値です (数量)。

value

Quantity

value は、メトリックの現在における平均値 (数量) です。

apiVersion

string

apiVersion は参照先の API バージョンです。

kind

string

kind は指示対象の種類です。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

string

name は指示対象の名前です。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

name

string

name は、指定されたメトリクスの名前です。

selector

LabelSelector

selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricsName のみがメトリクスの収集に使用されます。

current

object

MetricValueStatus は、メトリクスの現在の値を保持します

メトリクス

object

MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。

averageUtilization

integer

curentAverageUtilization は、関連する全 Pod のリソースメトリクスの現在における平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。

averageValue

Quantity

AverageValue は、関連するすべての Pod にわたるメトリックの現在における平均値です (数量)。

value

Quantity

value は、メトリックの現在における平均値 (数量) です。

name

string

name は、指定されたメトリクスの名前です。

selector

LabelSelector

selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricsName のみがメトリクスの収集に使用されます。

current

object

MetricValueStatus は、メトリクスの現在の値を保持します

name

string

name は、対象のリソースの名前です。

averageUtilization

integer

curentAverageUtilization は、関連する全 Pod のリソースメトリクスの現在における平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。

averageValue

Quantity

AverageValue は、関連するすべての Pod にわたるメトリックの現在における平均値です (数量)。

value

Quantity

value は、メトリックの現在における平均値 (数量) です。

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

pretty

string

true の場合は、出力が整形表示 (Pretty-print) されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

sendInitialEvents

boolean

`sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。

'sendInitialEvents' オプションが設定されている場合、resourceVersionMatch オプションも設定する必要があります。監視リクエストのセマンティクスとして、`resourceVersionMatch` = NotOlderThan は、最低でも、指定された `resourceVersion` と同程度に新しいデータとして解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい `resourceVersion` に同期される場合にブックバークイベントが送信されます。 `resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。

`resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

200 - OK

HorizontalPodAutoscalerList スキーマ

401 - Unauthorized

Empty

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

pretty

string

true の場合は、出力が整形表示 (Pretty-print) されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

sendInitialEvents

boolean

`sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。

'sendInitialEvents' オプションが設定されている場合、resourceVersionMatch オプションも設定する必要があります。監視リクエストのセマンティクスとして、`resourceVersionMatch` = NotOlderThan は、最低でも、指定された `resourceVersion` と同程度に新しいデータとして解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい `resourceVersion` に同期される場合にブックバークイベントが送信されます。 `resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。

`resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

200 - OK

WatchEvent スキーマ

401 - Unauthorized

Empty

namespace

string

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

pretty

string

true の場合は、出力が整形表示 (Pretty-print) されます。

continue

string

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

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

dryRun

string

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

fieldSelector

string

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

gracePeriodSeconds

integer

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

labelSelector

string

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

limit

integer

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

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

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 を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

sendInitialEvents

boolean

`sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。

'sendInitialEvents' オプションが設定されている場合、resourceVersionMatch オプションも設定する必要があります。監視リクエストのセマンティクスとして、`resourceVersionMatch` = NotOlderThan は、最低でも、指定された `resourceVersion` と同程度に新しいデータとして解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい `resourceVersion` に同期される場合にブックバークイベントが送信されます。 `resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。

`resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

body

DeleteOptions スキーマ

200 - OK

Status スキーマ

401 - Unauthorized

空白

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

sendInitialEvents

boolean

`sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。

'sendInitialEvents' オプションが設定されている場合、resourceVersionMatch オプションも設定する必要があります。監視リクエストのセマンティクスとして、`resourceVersionMatch` = NotOlderThan は、最低でも、指定された `resourceVersion` と同程度に新しいデータとして解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい `resourceVersion` に同期される場合にブックバークイベントが送信されます。 `resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。

`resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

200 - OK

HorizontalPodAutoscalerList スキーマ

401 - Unauthorized

空白

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

ボディー

HorizontalPodAutoscaler スキーマ

200 - OK

HorizontalPodAutoscaler スキーマ

201 - Created

HorizontalPodAutoscaler スキーマ

202 - Accepted

HorizontalPodAutoscaler スキーマ

401 - Unauthorized

Empty

namespace

string

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

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

pretty

string

true の場合は、出力が整形表示 (Pretty-print) されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

sendInitialEvents

boolean

`sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。

'sendInitialEvents' オプションが設定されている場合、resourceVersionMatch オプションも設定する必要があります。監視リクエストのセマンティクスとして、`resourceVersionMatch` = NotOlderThan は、最低でも、指定された `resourceVersion` と同程度に新しいデータとして解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい `resourceVersion` に同期される場合にブックバークイベントが送信されます。 `resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。

`resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

200 - OK

WatchEvent スキーマ

401 - Unauthorized

Empty

name

string

HorizontalPodAutoscaler の名前

namespace

string

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

pretty

string

true の場合は、出力が整形表示 (Pretty-print) されます。

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

body

DeleteOptions スキーマ

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

200 - OK

HorizontalPodAutoscaler スキーマ

401 - Unauthorized

空白

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

force

boolean

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

body

Patch スキーマ

200 - OK

HorizontalPodAutoscaler スキーマ

201 - Created

HorizontalPodAutoscaler スキーマ

401 - Unauthorized

空白

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

ボディー

HorizontalPodAutoscaler スキーマ

200 - OK

HorizontalPodAutoscaler スキーマ

201 - Created

HorizontalPodAutoscaler スキーマ

401 - Unauthorized

Empty

name

string

HorizontalPodAutoscaler の名前

namespace

string

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

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

pretty

string

true の場合は、出力が整形表示 (Pretty-print) されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

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

デフォルトは unset です。

sendInitialEvents

boolean

`sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。

'sendInitialEvents' オプションが設定されている場合、resourceVersionMatch オプションも設定する必要があります。監視リクエストのセマンティクスとして、`resourceVersionMatch` = NotOlderThan は、最低でも、指定された `resourceVersion` と同程度に新しいデータとして解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい `resourceVersion` に同期される場合にブックバークイベントが送信されます。 `resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。

`resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

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

200 - OK

WatchEvent スキーマ

401 - Unauthorized

Empty

name

string

HorizontalPodAutoscaler の名前

namespace

string

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

pretty

string

true の場合は、出力が整形表示 (Pretty-print) されます。

200 - OK

HorizontalPodAutoscaler スキーマ

401 - Unauthorized

空白

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

force

boolean

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

body

Patch スキーマ

200 - OK

HorizontalPodAutoscaler スキーマ

201 - Created

HorizontalPodAutoscaler スキーマ

401 - Unauthorized

空白

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

ボディー

HorizontalPodAutoscaler スキーマ

200 - OK

HorizontalPodAutoscaler スキーマ

201 - Created

HorizontalPodAutoscaler スキーマ

401 - Unauthorized

空白