16.2. Node [v1]


Description
ノードは Kubernetes のワーカーノードです。各ノードは、キャッシュ内 (つまり、etcd 内) に一意の識別子を持ちます。
タイプ
object

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

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

spec

object

NodeSpec は、ノードの作成に使用される属性を記述します。

status

object

NodeStatus は、ノードの現在のステータスに関する情報です。

16.2.1.1. .spec

Description
NodeSpec は、ノードの作成に使用される属性を記述します。
タイプ
object
Expand
プロパティータイプDescription

configSource

object

NodeConfigSource は、ノード設定のソースを指定します。正確に 1 つのサブフィールド (メタデータを除く) は nil 以外である必要があります。この API は 1.22 以降非推奨になりました

externalID

string

非推奨。すべての kubelets がこのフィールドを設定するわけではありません。1.13 以降のフィールドを削除します。参照: https://issues.k8s.io/61966

podCIDR

string

PodCIDR は、ノードに割り当てられた PodIP 範囲を表します。

podCIDRs

array (string)

podCIDRs は、そのノードの Pod で使用するためにノードに割り当てられた IP 範囲を表します。このフィールドを指定する場合、0 番目のエントリーは podCIDR フィールドと一致する必要があります。IPv4 と IPv6 のそれぞれに対して最大 1 つの値を含めることができます。

providerID

string

<ProviderName>://<ProviderSpecificNodeID> の形式でクラウドプロバイダーによって割り当てられたノードの ID

taints

array

指定した場合、ノードの汚染。

taints[]

object

この汚染が接続されているノードは、汚染を許容しない Pod に影響を及ぼします。

unschedulable

ブール値

Unschedulable は、新しい Pod のノードのスケジュール可能性を制御します。デフォルトでは、ノードはスケジュール可能です。詳細: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration

16.2.1.2. .spec.configSource

Description
NodeConfigSource は、ノード設定のソースを指定します。正確に 1 つのサブフィールド (メタデータを除く) は nil 以外である必要があります。この API は 1.22 以降非推奨になりました
タイプ
object
Expand
プロパティータイプDescription

configMap

object

ConfigMapNodeConfigSource には、ノードの設定ソースとして ConfigMap を参照するための情報が含まれています。この API は 1.22 以降非推奨になりました: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

16.2.1.3. .spec.configSource.configMap

Description
ConfigMapNodeConfigSource には、ノードの設定ソースとして ConfigMap を参照するための情報が含まれています。この API は 1.22 以降非推奨になりました: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
タイプ
object
必須
  • namespace
  • name
  • kubeletConfigKey
Expand
プロパティータイプDescription

kubeletConfigKey

string

KubeletConfigKey は、参照される ConfigMap のどのキーが KubeletConfiguration 構造に対応するかを宣言します。このフィールドはすべての場合に必須です。

name

string

Name は、参照される ConfigMap の metadata.name です。このフィールドはすべての場合に必須です。

namespace

string

名前空間は、参照される ConfigMap の metadata.namespace です。このフィールドはすべての場合に必須です。

resourceVersion

string

ResourceVersion は、参照される ConfigMap の metadata.ResourceVersion です。このフィールドは Node.Spec では禁止されており、Node.Status では必須です。

uid

string

UID は、参照される ConfigMap の metadata.UID です。このフィールドは Node.Spec では禁止されており、Node.Status では必須です。

16.2.1.4. .spec.taints

Description
指定した場合、ノードの汚染。
タイプ
array

16.2.1.5. .spec.taints[]

Description
この汚染が接続されているノードは、汚染を許容しない Pod に影響を及ぼします。
タイプ
object
必須
  • key
  • effect
Expand
プロパティータイプDescription

effect

string

必須。汚染を許容しない Pod に対する汚染の影響。有効な効果は、NoSchedule、PreferNoSchedule、および NoExecute です。

key

string

必須。ノードに適用される汚染キー。

timeAdded

時間

TimeAdded は、汚染が追加された時刻を表します。NoExecute 汚染のためにのみ書かれています。

value

string

汚染キーに対応する汚染値。

16.2.1.6. .status

Description
NodeStatus は、ノードの現在のステータスに関する情報です。
タイプ
object
Expand
プロパティータイプDescription

addresses

array

ノードに到達可能なアドレスのリスト。可能な場合は、クラウドプロバイダーから照会されます。詳細: https://kubernetes.io/docs/concepts/nodes/node/#addresses 注: このフィールドはマージ可能として宣言されていますが、マージキーは十分に一意ではないため、マージ時にデータが破損する可能性があります。代わりに、呼び出し元は完全置換パッチを使用する必要があります。例については、http://pr.k8s.io/79391 を参照してください。

addresses[]

object

NodeAddress には、ノードのアドレスに関する情報が含まれています。

allocatable

オブジェクト(Quantity)

Allocatable は、スケジューリングに使用できるノードのリソースを表します。デフォルトは容量です。

capacity

オブジェクト(Quantity)

容量は、ノードの合計リソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

conditions

array

条件は、現在観測されているノード条件の配列です。詳細: https://kubernetes.io/docs/concepts/nodes/node/#condition

conditions[]

object

NodeCondition には、ノードの条件情報が含まれています。

config

object

NodeConfigStatus は、Node.Spec.ConfigSource によって割り当てられた設定のステータスを記述します。

daemonEndpoints

object

NodeDaemonEndpoints は、ノードで実行されているデーモンによって開かれたポートを一覧表示します。

images

array

このノードのコンテナーイメージのリスト

images[]

object

コンテナーのイメージを説明する

nodeInfo

object

NodeSystemInfo は、ノードを一意に識別するための ID/UUID のセットです。

phase

string

NodePhase は、ノードの最近観察されたライフサイクルフェーズです。詳細: https://kubernetes.io/docs/concepts/nodes/node/#phase フィールドにデータが入力されることはなく、現在は非推奨になっています。

volumesAttached

array

ノードに接続されているボリュームのリスト。

volumesAttached[]

object

AttachedVolume は、ノードに接続されているボリュームを表します

volumesInUse

array (string)

ノードによって使用中 (マウント済み) の接続可能なボリュームのリスト。

16.2.1.7. .status.addresses

Description
ノードに到達可能なアドレスのリスト。可能な場合は、クラウドプロバイダーから照会されます。詳細: https://kubernetes.io/docs/concepts/nodes/node/#addresses 注: このフィールドはマージ可能として宣言されていますが、マージキーは十分に一意ではないため、マージ時にデータが破損する可能性があります。代わりに、呼び出し元は完全置換パッチを使用する必要があります。例については、http://pr.k8s.io/79391 を参照してください。
タイプ
array

16.2.1.8. .status.addresses[]

Description
NodeAddress には、ノードのアドレスに関する情報が含まれています。
タイプ
object
必須
  • type
  • address
Expand
プロパティータイプ説明

address

string

ノードアドレス。

type

string

ノードアドレスタイプ。ホスト名、ExternalIP、または InternalIP のいずれか。

16.2.1.9. .status.conditions

Description
条件は、現在観測されているノード条件の配列です。詳細: https://kubernetes.io/docs/concepts/nodes/node/#condition
タイプ
array

16.2.1.10. .status.conditions[]

Description
NodeCondition には、ノードの条件情報が含まれています。
タイプ
object
必須
  • type
  • status
Expand
プロパティータイプDescription

lastHeartbeatTime

時間

前回、特定の条件で更新を取得しました。

lastTransitionTime

時間

前回、状態が 1 つのステータスから別のステータスに移行したとき。

message

string

最後にある状態から別の状態に遷移した時間。

reason

string

(簡単な) 条件の最後の遷移の理由。

status

string

状態のステータス、True、False、Unknown のいずれか。

type

string

ノード条件のタイプ。

16.2.1.11. .status.config

Description
NodeConfigStatus は、Node.Spec.ConfigSource によって割り当てられた設定のステータスを記述します。
タイプ
object
Expand
プロパティータイプDescription

active

object

NodeConfigSource は、ノード設定のソースを指定します。正確に 1 つのサブフィールド (メタデータを除く) は nil 以外である必要があります。この API は 1.22 以降非推奨になりました

割り当て済み

object

NodeConfigSource は、ノード設定のソースを指定します。正確に 1 つのサブフィールド (メタデータを除く) は nil 以外である必要があります。この API は 1.22 以降非推奨になりました

error

string

エラーは、Spec.ConfigSource をアクティブな設定に調整する際の問題を示しています。たとえば、Spec.ConfigSource をローカルの Assigned レコードにチェックポイントしようとしたり、Spec.ConfigSource に関連付けられたペイロードをチェックポイントしようとしたり、Assignedconfig をロードまたは検証しようとしたりするなどのエラーが発生する可能性があります。設定の同期中に、さまざまなポイントでエラーが発生する場合があります。以前のエラー (ダウンロードエラーやチェックポイントエラーなど) は、LastKnownGood へのロールバックにはならず、Kubelet の再試行全体で解決される可能性があります。その後のエラー (チェックポイント設定のロードや検証など) は、LastKnownGood へのロールバックになります。後者の場合、通常、Spec.ConfigSource で割り当てられた設定を修正することでエラーを解決できます。Kubelet ログでエラーメッセージを検索すると、デバッグに関する追加情報を見つけることができます。エラーは、人間が読める形式のエラー状態の説明です。マシンはエラーが空であるかどうかをチェックできますが、Kubelet バージョン間でのエラーテキストの安定性に依存するべきではありません。

lastKnownGood

object

NodeConfigSource は、ノード設定のソースを指定します。正確に 1 つのサブフィールド (メタデータを除く) は nil 以外である必要があります。この API は 1.22 以降非推奨になりました

16.2.1.12. .status.config.active

Description
NodeConfigSource は、ノード設定のソースを指定します。正確に 1 つのサブフィールド (メタデータを除く) は nil 以外である必要があります。この API は 1.22 以降非推奨になりました
タイプ
object
Expand
プロパティータイプDescription

configMap

object

ConfigMapNodeConfigSource には、ノードの設定ソースとして ConfigMap を参照するための情報が含まれています。この API は 1.22 以降非推奨になりました: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

16.2.1.13. .status.config.active.configMap

Description
ConfigMapNodeConfigSource には、ノードの設定ソースとして ConfigMap を参照するための情報が含まれています。この API は 1.22 以降非推奨になりました: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
タイプ
object
必須
  • namespace
  • name
  • kubeletConfigKey
Expand
プロパティータイプDescription

kubeletConfigKey

string

KubeletConfigKey は、参照される ConfigMap のどのキーが KubeletConfiguration 構造に対応するかを宣言します。このフィールドはすべての場合に必須です。

name

string

Name は、参照される ConfigMap の metadata.name です。このフィールドはすべての場合に必須です。

namespace

string

名前空間は、参照される ConfigMap の metadata.namespace です。このフィールドはすべての場合に必須です。

resourceVersion

string

ResourceVersion は、参照される ConfigMap の metadata.ResourceVersion です。このフィールドは Node.Spec では禁止されており、Node.Status では必須です。

uid

string

UID は、参照される ConfigMap の metadata.UID です。このフィールドは Node.Spec では禁止されており、Node.Status では必須です。

16.2.1.14. .status.config.assigned

Description
NodeConfigSource は、ノード設定のソースを指定します。正確に 1 つのサブフィールド (メタデータを除く) は nil 以外である必要があります。この API は 1.22 以降非推奨になりました
タイプ
object
Expand
プロパティータイプDescription

configMap

object

ConfigMapNodeConfigSource には、ノードの設定ソースとして ConfigMap を参照するための情報が含まれています。この API は 1.22 以降非推奨になりました: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

16.2.1.15. .status.config.assigned.configMap

Description
ConfigMapNodeConfigSource には、ノードの設定ソースとして ConfigMap を参照するための情報が含まれています。この API は 1.22 以降非推奨になりました: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
タイプ
object
必須
  • namespace
  • name
  • kubeletConfigKey
Expand
プロパティータイプDescription

kubeletConfigKey

string

KubeletConfigKey は、参照される ConfigMap のどのキーが KubeletConfiguration 構造に対応するかを宣言します。このフィールドはすべての場合に必須です。

name

string

Name は、参照される ConfigMap の metadata.name です。このフィールドはすべての場合に必須です。

namespace

string

名前空間は、参照される ConfigMap の metadata.namespace です。このフィールドはすべての場合に必須です。

resourceVersion

string

ResourceVersion は、参照される ConfigMap の metadata.ResourceVersion です。このフィールドは Node.Spec では禁止されており、Node.Status では必須です。

uid

string

UID は、参照される ConfigMap の metadata.UID です。このフィールドは Node.Spec では禁止されており、Node.Status では必須です。

16.2.1.16. .status.config.lastKnownGood

Description
NodeConfigSource は、ノード設定のソースを指定します。正確に 1 つのサブフィールド (メタデータを除く) は nil 以外である必要があります。この API は 1.22 以降非推奨になりました
タイプ
object
Expand
プロパティータイプDescription

configMap

object

ConfigMapNodeConfigSource には、ノードの設定ソースとして ConfigMap を参照するための情報が含まれています。この API は 1.22 以降非推奨になりました: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

16.2.1.17. .status.config.lastKnownGood.configMap

Description
ConfigMapNodeConfigSource には、ノードの設定ソースとして ConfigMap を参照するための情報が含まれています。この API は 1.22 以降非推奨になりました: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
タイプ
object
必須
  • namespace
  • name
  • kubeletConfigKey
Expand
プロパティータイプDescription

kubeletConfigKey

string

KubeletConfigKey は、参照される ConfigMap のどのキーが KubeletConfiguration 構造に対応するかを宣言します。このフィールドはすべての場合に必須です。

name

string

Name は、参照される ConfigMap の metadata.name です。このフィールドはすべての場合に必須です。

namespace

string

名前空間は、参照される ConfigMap の metadata.namespace です。このフィールドはすべての場合に必須です。

resourceVersion

string

ResourceVersion は、参照される ConfigMap の metadata.ResourceVersion です。このフィールドは Node.Spec では禁止されており、Node.Status では必須です。

uid

string

UID は、参照される ConfigMap の metadata.UID です。このフィールドは Node.Spec では禁止されており、Node.Status では必須です。

16.2.1.18. .status.daemonEndpoints

Description
NodeDaemonEndpoints は、ノードで実行されているデーモンによって開かれたポートを一覧表示します。
タイプ
object
Expand
プロパティータイプDescription

kubeletEndpoint

object

DaemonEndpoint には、単一のデーモンエンドポイントに関する情報が含まれています。

16.2.1.19. .status.daemonEndpoints.kubeletEndpoint

Description
DaemonEndpoint には、単一のデーモンエンドポイントに関する情報が含まれています。
タイプ
object
必須
  • Port
Expand
プロパティータイプDescription

Port

integer

指定されたエンドポイントのポート番号。

16.2.1.20. .status.images

Description
このノードのコンテナーイメージのリスト
タイプ
array

16.2.1.21. .status.images[]

Description
コンテナーのイメージを説明する
タイプ
object
Expand
プロパティータイプDescription

names

array (string)

このイメージが知られている名前。例:"k8s.gcr.io/hyperkube:v1.0.7"、"dockerhub.io/google_containers/hyperkube:v1.0.7"

sizeBytes

integer

イメージのサイズ (バイト単位)。

16.2.1.22. .status.nodeInfo

Description
NodeSystemInfo は、ノードを一意に識別するための ID/UUID のセットです。
タイプ
object
必須
  • machineID
  • systemUUID
  • bootID
  • kernelVersion
  • osImage
  • containerRuntimeVersion
  • kubeletVersion
  • kubeProxyVersion
  • operatingSystem
  • アーキテクチャー
Expand
プロパティータイプDescription

アーキテクチャー

string

ノードによって報告されたアーキテクチャー

bootID

string

ノードによって報告されたブート ID。

containerRuntimeVersion

string

ランタイムリモート API(docker://1.5.0 など) を介してノードによって報告される ContainerRuntime バージョン。

kernelVersion

string

'uname -r' からノードによって報告されたカーネルバージョン (例:3.16.0-0.bpo.4-amd64)。

kubeProxyVersion

string

ノードによって報告された KubeProxy バージョン。

kubeletVersion

string

ノードによって報告された Kubelet バージョン。

machineID

string

ノードによって報告された MachineID。クラスター内の一意のマシン識別には、このフィールドが推奨されます。man (5)machine-id の詳細:http: //man7.org/linux/man-pages/man5/machine-id.5.html

operatingSystem

string

ノードによって報告されたオペレーティングシステム

osImage

string

/etc/os-release からノードによって報告された OS イメージ (例:Debian GNU/Linux 7(wheezy))。

systemUUID

string

ノードによって報告された SystemUUID。一意のマシン識別には、MachineID が推奨されます。このフィールドは、Red Hat ホストに固有です https://access.redhat.com/documentation/ja-jp/red_hat_subscription_management/1/html/rhsm/uuid

16.2.1.23. .status.volumesAttached

Description
ノードに接続されているボリュームのリスト。
タイプ
array

16.2.1.24. .status.volumesAttached[]

Description
AttachedVolume は、ノードに接続されているボリュームを表します
タイプ
object
必須
  • name
  • devicePath
Expand
プロパティータイプDescription

devicePath

string

DevicePath は、ボリュームが使用可能である必要があるデバイスパスを表します

name

string

添付ボリュームの名前

16.2.2. API エンドポイント

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

  • /api/v1/nodes

    • DELETE: ノードのコレクションを削除します
    • GET: ノードの種類のオブジェクトを一覧表示または監視する
    • POST: ノードを作成します
  • /api/v1/watch/nodes

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

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

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

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

16.2.2.1. /api/v1/nodes

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

pretty

string

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

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

continue

string

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

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

dryRun

string

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

fieldSelector

string

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

gracePeriodSeconds

integer

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

labelSelector

string

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

limit

integer

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

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

orphanDependents

boolean

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

propagationPolicy

string

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

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

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

Defaults to unset

timeoutSeconds

integer

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

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

body

DeleteOptions スキーマ

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

200 - OK

Status スキーマ

401 - Unauthorized

空白

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

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

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

Defaults to unset

timeoutSeconds

integer

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

watch

boolean

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

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

200 - OK

NodeList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
Description
ノードを作成する
Expand
表16.7 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldManager

string

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

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

ボディー

Node schema

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

200 - OK

Node schema

201 - Created

Node schema

202 - Accepted

Node schema

401 - Unauthorized

空白

16.2.2.2. /api/v1/watch/nodes

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

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

pretty

string

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

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

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

Defaults to unset

timeoutSeconds

integer

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

watch

boolean

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

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

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

16.2.2.3. /api/v1/nodes/{name}

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

name

string

ノードの名前

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

pretty

string

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

HTTP メソッド
DELETE
Description
ノードの削除
Expand
表16.14 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

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

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

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

200 - OK

Node schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

force

boolean

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

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

body

Patch schema

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

200 - OK

Node schema

201 - Created

Node schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

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

ボディー

Node schema

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

200 - OK

Node schema

201 - Created

Node schema

401 - Unauthorized

空白

16.2.2.4. /api/v1/watch/nodes/{name}

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

name

string

ノードの名前

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

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

pretty

string

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

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

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

Defaults to unset

timeoutSeconds

integer

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

watch

boolean

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

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

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

16.2.2.5. /api/v1/nodes/{name}/status

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

name

string

ノードの名前

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

pretty

string

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

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

200 - OK

Node schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

force

boolean

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

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

body

Patch schema

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

200 - OK

Node schema

201 - Created

Node schema

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

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

ボディー

Node schema

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

200 - OK

Node schema

201 - Created

Node schema

401 - Unauthorized

空白

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat