14.10. PersistentVolume [v1]


説明
PersistentVolume (PV) は、管理者によってプロビジョニングされたストレージリソースです。これはノードに似ています。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes
タイプ
object

14.10.1. 仕様

プロパティー説明

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

PersistentVolumeSpec は永続ボリュームの仕様です。

status

object

PersistentVolumeStatus は、永続ボリュームの現在のステータスです。

14.10.1.1. .spec

説明
PersistentVolumeSpec は永続ボリュームの仕様です。
タイプ
object
プロパティー説明

accessModes

array (string)

accessModes には、ボリュームのマウント方法がすべて含まれています。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes

awsElasticBlockStore

object

AWS の永続ディスクリソースを表します。

AWS EBS ディスクは、コンテナーにマウントする前に存在している必要があります。また、ディスクは kubelet と同じ AWS ゾーンにある必要があります。AWS EBS ディスクは、読み取り/書き込みとして 1 回だけマウントできます。AWS EBS ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

azureDisk

object

AzureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。

azureFile

object

AzureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。

capacity

object (Quantity)

capacity は、永続ボリュームのリソースおよび容量の説明です。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

cephfs

object

Pod の存続期間中持続する Ceph ファイルシステムマウントを表します。Cephfs ボリュームは所有権管理または SELinux の再ラベル付けをサポートしていません。

cinder

object

Openstack の cinder ボリュームリソースを表します。コンテナーにマウントする前に、Cinder ボリュームが存在している必要があります。ボリュームも、kubelet と同じ領域にある必要があります。Cinder ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

claimRef

object

ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。

csi

object

外部 CSI ボリュームドライバーによって管理されるストレージを表します (ベータ機能)

fc

object

ファイバーチャネルボリュームを表します。ファイバーチャネルボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ファイバーチャネルボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

flexVolume

object

FlexPersistentVolumeSource は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用の永続ボリュームリソースを表します。

flocker

object

Flocker エージェントによってマウントされた Flocker ボリュームを表します。datasetName および datasetUUID の 1 つだけを設定する必要があります。Flocker ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。

gcePersistentDisk

object

Google Compute Engine の永続ディスクリソースを表します。

GCE PD は、コンテナーにマウントする前に存在している必要があります。ディスクは、kubelet と同じ GCE プロジェクトおよびゾーンにある必要もあります。GCE PD は、読み取り/書き込みとして 1 回のみマウントできます。また、読み取り専用としては何度でもマウントできます。GCE PD は、所有権管理および SELinux の再ラベル付けをサポートします。

glusterfs

object

Pod の存続期間中続く Glusterfs マウントを表します。Glusterfs ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。

hostPath

object

Pod にマップされたホストパスを表します。ホストパスボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。

iscsi

object

ISCSIPersistentVolumeSource は、ISCSI ディスクを表します。ISCSI ボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ISCSI ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

local

object

Local は、ノードアフィニティーを備えた直接接続ストレージを表します (ベータ機能)

mountOptions

array (string)

mountOptions はマウントオプションのリストです (例: "ro"、"soft")。検証されていません - 無効な場合、マウントは失敗します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options

nfs

object

Pod の存続期間中続く NFS マウントを表します。NFS ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。

nodeAffinity

object

VolumeNodeAffinity は、このボリュームにアクセスできるノードを制限する制約を定義します。

persistentVolumeReclaimPolicy

string

persistentVolumeReclaimPolicy は、永続ボリュームの要求が解除されたときに永続ボリュームに何が起こるかを定義します。有効なオプションは Retain (手動で作成された PersistentVolumes のデフォルト)、Delete (動的にプロビジョニングされる PersistentVolumes のデフォルト)、および Recycle (非推奨) です。Recycle は、この PersistentVolume の基礎となるボリュームプラグインでサポートされる必要があります。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming

使用可能な列挙値: - "Delete" はボリュームが要求から解放されたときに Kubernetes から削除されることを意味します。ボリュームプラグインは削除をサポートしている必要があります。-"Recycle" は、ボリュームが要求から解放されたときに、バインドされていない永続ボリュームのプールにリサイクルされて戻されることを意味します。ボリュームプラグインは、Recycling をサポートする必要があります。 - "Retain" は、管理者が手動で回収するためにボリュームが現在のフェーズ (Released) に残ることを意味します。デフォルトのポリシーは Retain です。

photonPersistentDisk

object

Photon Controller 永続ディスクリソースを表します。

portworxVolume

object

PortworxVolumeSource は、Portworx ボリュームリソースを表します。

quobyte

object

Pod の存続期間中続く Quobyte マウントを表します。Quobyte ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。

rbd

object

Pod の存続時間中続く Rados Block Device マウントを表します。RBD ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

scaleIO

object

ScaleIOPersistentVolumeSource は、永続的な ScaleIO ボリュームを表します

storageClassName

string

storageClassName は、この永続ボリュームが属する StorageClass の名前です。空の値は、このボリュームが StorageClass に属していないことを意味します。

storageos

object

StorageOS 永続ボリュームリソースを表します。

volumeMode

string

volumeMode は、ボリュームをフォーマットされたファイルシステムで使用するか、または raw ブロック状態のままにするかを定義します。Filesystem の値は、spec に含まれていない場合に暗示されます。

使用可能な列挙値: - "Block" は、ボリュームがファイルシステムでフォーマットされず、生のブロックデバイスのままになります。- "Filesystem" は、ボリュームがファイルシステムでフォーマットされる、またはファイルシステムでフォーマットされます。

vsphereVolume

object

vSphere ボリュームリソースを表します。

14.10.1.2. .spec.awsElasticBlockStore

説明

AWS の永続ディスクリソースを表します。

AWS EBS ディスクは、コンテナーにマウントする前に存在している必要があります。また、ディスクは kubelet と同じ AWS ゾーンにある必要があります。AWS EBS ディスクは、読み取り/書き込みとして 1 回だけマウントできます。AWS EBS ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

タイプ
object
必須
  • volumeID
プロパティー説明

fsType

string

fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

partition

integer

partition は、マウントするボリューム内のパーティションです。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを "1" として指定します。同様に、/dev/sda のボリュームパーティションは "0" です (または、プロパティーを空のままにしておくこともできます)。

readOnly

boolean

readOnly 値 true は、VolumeMounts の readOnly 設定を強制的に実行します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

volumeID

string

volumeID は、AWS の永続ディスクリソースの一意の ID です (Amazon EBS ボリューム)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

14.10.1.3. .spec.azureDisk

説明
AzureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。
タイプ
object
必須
  • diskName
  • diskURI
プロパティー説明

cachingMode

string

cachingMode はホストキャッシュモードです (None, Read Only, Read Write)。

使用可能な列挙値: - "None" - "ReadOnly" - "ReadWrite"

diskName

string

diskName は、Blob ストレージ内のデータディスクの名前です。

diskURI

string

diskURI は、BLOB ストレージ内のデータディスクの URI です

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

kind

string

kind での期待値は、Shared (ストレージアカウントごとに複数のブロブディスク)、Dedicated (ストレージアカウントごとにブロブ 1 つ)、Managed (Azure の管理データディスク (管理対象のアベイラビリティーセットのみ)) です。デフォルトは Shared です。

使用可能な列挙値:- "Dedicated" - "Managed" - "Shared"

readOnly

boolean

readOnly。デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

14.10.1.4. .spec.azureFile

説明
AzureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。
タイプ
object
必須
  • secretName
  • shareName
プロパティー説明

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretName

string

secretName は、Azure ストレージアカウント名とキーを含むシークレットの名前です。

secretNamespace

string

secretNamespace は、Azure Storage Account Name および Key を含むシークレットの namespace で、デフォルトは Pod と同じです。

shareName

string

shareName は Azure 今日有名です。

14.10.1.5. .spec.cephfs

説明
Pod の存続期間中持続する Ceph ファイルシステムマウントを表します。Cephfs ボリュームは所有権管理または SELinux の再ラベル付けをサポートしていません。
タイプ
object
必須
  • monitors
プロパティー説明

monitors

array (string)

monitors は必須: Monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

path

string

パスは任意: 完全な Ceph ツリーではなく、マウントされたルートとして使用されます。デフォルトは / です。

readOnly

boolean

readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretFile

string

secretFile は任意: SecretFile はユーザーのキーリングへのパスです。デフォルトは /etc/ceph/user.secret です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretRef

object

SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。

user

string

user は任意: ユーザーは rados ユーザー名、デフォルトは admin です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

14.10.1.6. .spec.cephfs.secretRef

説明
SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。
タイプ
object
プロパティー説明

name

string

名前は、namespace 内で一意であり、シークレットのリソースを参照します。

namespace

string

namespace は、シークレットの名前が一意でなければならないスペースを定義します。

14.10.1.7. .spec.cinder

説明
Openstack の cinder ボリュームリソースを表します。コンテナーにマウントする前に、Cinder ボリュームが存在している必要があります。ボリュームも、kubelet と同じ領域にある必要があります。Cinder ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
タイプ
object
必須
  • volumeID
プロパティー説明

fsType

string

マウントする fsType ファイルシステムタイプ。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

readOnly

boolean

readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

secretRef

object

SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。

volumeID

string

cinder 内のボリュームを識別するために使用される volumeID。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

14.10.1.8. .spec.cinder.secretRef

説明
SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。
タイプ
object
プロパティー説明

name

string

名前は、namespace 内で一意であり、シークレットのリソースを参照します。

namespace

string

namespace は、シークレットの名前が一意でなければならないスペースを定義します。

14.10.1.9. .spec.claimRef

説明
ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
タイプ
object
プロパティー説明

apiVersion

string

参照先の API バージョン。

fieldPath

string

オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。

kind

string

参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

string

この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

string

参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

14.10.1.10. .spec.csi

説明
外部 CSI ボリュームドライバーによって管理されるストレージを表します (ベータ機能)
タイプ
object
必須
  • driver
  • volumeHandle
プロパティー説明

controllerExpandSecretRef

object

SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。

controllerPublishSecretRef

object

SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。

driver

string

driver は、このボリュームに使用するドライバーの名前です。必須。

fsType

string

マウントする fsType。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。

nodeExpandSecretRef

object

SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。

nodePublishSecretRef

object

SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。

nodeStageSecretRef

object

SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。

readOnly

boolean

ControllerPublishVolumeRequest に渡す readOnly の値。デフォルトは false (読み取り/書き込み) です。

volumeAttributes

object (string)

公開するボリュームの volumeAttributes。

volumeHandle

string

volumeHandle は、CSI ボリュームプラグインの CreateVolume により返される一意のボリューム名であり、後続のすべての呼び出しでボリュームを参照します。必須。

14.10.1.11. .spec.csi.controllerExpandSecretRef

説明
SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。
タイプ
object
プロパティー説明

name

string

名前は、namespace 内で一意であり、シークレットのリソースを参照します。

namespace

string

namespace は、シークレットの名前が一意でなければならないスペースを定義します。

14.10.1.12. .spec.csi.controllerPublishSecretRef

説明
SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。
タイプ
object
プロパティー説明

name

string

名前は、namespace 内で一意であり、シークレットのリソースを参照します。

namespace

string

namespace は、シークレットの名前が一意でなければならないスペースを定義します。

14.10.1.13. .spec.csi.nodeExpandSecretRef

説明
SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。
タイプ
object
プロパティー説明

name

string

名前は、namespace 内で一意であり、シークレットのリソースを参照します。

namespace

string

namespace は、シークレットの名前が一意でなければならないスペースを定義します。

14.10.1.14. .spec.csi.nodePublishSecretRef

説明
SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。
タイプ
object
プロパティー説明

name

string

名前は、namespace 内で一意であり、シークレットのリソースを参照します。

namespace

string

namespace は、シークレットの名前が一意でなければならないスペースを定義します。

14.10.1.15. .spec.csi.nodeStageSecretRef

説明
SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。
タイプ
object
プロパティー説明

name

string

名前は、namespace 内で一意であり、シークレットのリソースを参照します。

namespace

string

namespace は、シークレットの名前が一意でなければならないスペースを定義します。

14.10.1.16. .spec.fc

説明
ファイバーチャネルボリュームを表します。ファイバーチャネルボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ファイバーチャネルボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
タイプ
object
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

lun

integer

LUN は任意: FC ターゲットの LUN 番号

readOnly

boolean

readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

targetWWNs

array (string)

targetWWNs は任意: FC ターゲットのワールドワイド名 (WWN)

wwids

array (string)

wwids は任意: FC ボリュームのワールドワイド ID(wwids)wwids または targetWWN と lun の組み合わせのいずれかを設定する必要がありますが、両方を同時に設定できません。

14.10.1.17. .spec.flexVolume

説明
FlexPersistentVolumeSource は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用の永続ボリュームリソースを表します。
タイプ
object
必須
  • driver
プロパティー説明

driver

string

driver は、このボリュームに使用するドライバーの名前です。

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトのファイルシステムは FlexVolume スクリプトに依存します。

options

object (string)

options は任意: このフィールドには追加のコマンドオプションがあれば保持されます。

readOnly

boolean

readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretRef

object

SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。

14.10.1.18. .spec.flexVolume.secretRef

説明
SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。
タイプ
object
プロパティー説明

name

string

名前は、namespace 内で一意であり、シークレットのリソースを参照します。

namespace

string

namespace は、シークレットの名前が一意でなければならないスペースを定義します。

14.10.1.19. .spec.flocker

説明
Flocker エージェントによってマウントされた Flocker ボリュームを表します。datasetName および datasetUUID の 1 つだけを設定する必要があります。Flocker ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
タイプ
object
プロパティー説明

datasetName

string

datasetName はメタデータとして保存されているデータセットの名前です Flocker のデータセット上の名前は非推奨として扱うようにしてください。

datasetUUID

string

datasetUUID は、データセットの UUID です。これは Flocker データセットの一意の識別子です

14.10.1.20. .spec.gcePersistentDisk

説明

Google Compute Engine の永続ディスクリソースを表します。

GCE PD は、コンテナーにマウントする前に存在している必要があります。ディスクは、kubelet と同じ GCE プロジェクトおよびゾーンにある必要もあります。GCE PD は、読み取り/書き込みとして 1 回のみマウントできます。また、読み取り専用としては何度でもマウントできます。GCE PD は、所有権管理および SELinux の再ラベル付けをサポートします。

タイプ
object
必須
  • pdName
プロパティー説明

fsType

string

fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

partition

integer

partition は、マウントするボリューム内のパーティションです。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを "1" として指定します。同様に、/dev/sda のボリュームパーティションは "0" です (または、プロパティーを空のままにしておくこともできます)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

pdName

string

pdName は、GCE の PD リソースの一意の名前です。GCE でディスクを識別するために使用されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

readOnly

boolean

この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

14.10.1.21. .spec.glusterfs

説明
Pod の存続期間中続く Glusterfs マウントを表します。Glusterfs ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
タイプ
object
必須
  • endpoints
  • path
プロパティー説明

endpoints

string

Endpoints は、Glusterfs トポロジーの詳細を示すエンドポイント名です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

endpointsNamespace

string

endpointsNamespace は、Glusterfs エンドポイントを含む namespace です。このフィールドが空の場合、EndpointNamespace はデフォルトでバインドされた PVC と同じ namespace になります。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

path

string

path は Glusterfs ボリュームパスです。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

readOnly

boolean

この readOnly は、Glusterfs ボリュームを読み取り専用のアクセス権限で強制的にマウントします。デフォルトは false です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

14.10.1.22. .spec.hostPath

説明
Pod にマップされたホストパスを表します。ホストパスボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
タイプ
object
必須
  • path
プロパティー説明

path

string

ホスト上のディレクトリーのパス。パスがシンボリックリンクの場合、実際のパスへのリンクをたどります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

type

string

HostPath ボリュームのデフォルトのタイプは "" です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

使用可能な列挙値: - "" 下位互換性を確保するため、未設定の場合は空のままにします。- "BlockDevice" ブロックデバイスは、指定のパスに配置する必要があります。- "CharDevice" キャラクターデバイスは、指定のパスに配置する必要があります。- "Directory" ディレクトリーは指定のパスに配置する必要があります。 - "DirectoryOrCreate" 指定されたパスに何も存在しない場合、空のディレクトリーが必要に応じてファイルモード 0755 で作成され、Kubelet と同じグループと所有権が指定されます。- "File" ファイルは指定のパスに配置する必要があります。- "FileOrCreate" 指定のパスに何も存在しない場合は、必要に応じて空のファイルがファイルモード 0644 で作成され、Kubelet と同じグループと所有権が指定されます。- "Socket" UNIX ソケットは指定のパスに配置する必要があります。

14.10.1.23. .spec.iscsi

説明
ISCSIPersistentVolumeSource は、ISCSI ディスクを表します。ISCSI ボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ISCSI ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
タイプ
object
必須
  • targetPortal
  • iqn
  • lun
プロパティー説明

chapAuthDiscovery

boolean

chapAuthDiscovery は、iSCSI 検出 CHAP 認証をサポートするかどうかを定義します。

chapAuthSession

boolean

chapAuthSession は、iSCSI セッション CHAP 認証をサポートするかどうかを定義します。

fsType

string

fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#iscsi

initiatorName

string

initiatorName は、カスタムの iSCSI イニシエーター名です。iscsiInterface と同時に initiatorName を指定すると、接続用に新しい iSCSI インターフェイス <target portal>:<volume name> が作成されます。

iqn

string

IQN は、ターゲット iSCSI 修飾名です。

iscsiInterface

string

iscsiInterface は、iSCSI トランスポートを使用するインターフェイス名です。デフォルトは 'default' (tcp) です。

lun

integer

LUN は iSCSI ターゲット Lun 番号です。

portals

array (string)

ポータルは iSCSI ターゲットポータルリストです。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。

readOnly

boolean

この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。

secretRef

object

SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。

targetPortal

string

targetPortal は iSCSI Target Portal です。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。

14.10.1.24. .spec.iscsi.secretRef

説明
SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。
タイプ
object
プロパティー説明

name

string

名前は、namespace 内で一意であり、シークレットのリソースを参照します。

namespace

string

namespace は、シークレットの名前が一意でなければならないスペースを定義します。

14.10.1.25. .spec.local

説明
Local は、ノードアフィニティーを備えた直接接続ストレージを表します (ベータ機能)
タイプ
object
必須
  • path
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。Path がブロックデバイスの場合にのみ適用されます。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルト値は、指定されていないと、ファイルシステムを自動選択します。

path

string

ノード上のボリュームへのフルパス。これは、ディレクトリーまたはブロックデバイス (ディスク、パーティションなど) のいずれかです。

14.10.1.26. .spec.nfs

説明
Pod の存続期間中続く NFS マウントを表します。NFS ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
タイプ
object
必須
  • server
  • path
プロパティー説明

path

string

NFS サーバーがエクスポートしているパス。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

readOnly

boolean

ここで readOnly を指定すると、NFS エクスポートが読み取り専用権限で強制的にマウントされます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

server

string

server は、NFS サーバーのホスト名または IP アドレスです。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

14.10.1.27. .spec.nodeAffinity

説明
VolumeNodeAffinity は、このボリュームにアクセスできるノードを制限する制約を定義します。
タイプ
object
プロパティー説明

required

object

ノードセレクターは、ノードのセットに対する 1 つ以上のラベルクエリーの結果の和集合を表します。つまり、ノードセレクター用語で表されるセレクターの OR を表します。

14.10.1.28. .spec.nodeAffinity.required

説明
ノードセレクターは、ノードのセットに対する 1 つ以上のラベルクエリーの結果の和集合を表します。つまり、ノードセレクター用語で表されるセレクターの OR を表します。
タイプ
object
必須
  • nodeSelectorTerms
プロパティー説明

nodeSelectorTerms

array

必須。ノードセレクター用語のリスト。用語は OR されています。

nodeSelectorTerms[]

object

null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。

14.10.1.29. .spec.nodeAffinity.required.nodeSelectorTerms

説明
必須。ノードセレクター用語のリスト。用語は OR されています。
タイプ
array

14.10.1.30. .spec.nodeAffinity.required.nodeSelectorTerms[]

説明
null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。
タイプ
object
プロパティー説明

matchExpressions

array

ノードのラベルごとのノードセレクター要件のリスト。

matchExpressions[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchFields

array

ノードのフィールドごとのノードセレクター要件のリスト。

matchFields[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

14.10.1.31. .spec.nodeAffinity.required.nodeSelectorTerms[].matchExpressions

説明
ノードのラベルごとのノードセレクター要件のリスト。
タイプ
array

14.10.1.32. .spec.nodeAffinity.required.nodeSelectorTerms[].matchExpressions[]

説明
ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
タイプ
object
必須
  • key
  • operator
プロパティー説明

key

string

セレクターが適用されるラベルキー。

operator

string

キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。

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

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

14.10.1.33. .spec.nodeAffinity.required.nodeSelectorTerms[].matchFields

説明
ノードのフィールドごとのノードセレクター要件のリスト。
タイプ
array

14.10.1.34. .spec.nodeAffinity.required.nodeSelectorTerms[].matchFields[]

説明
ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
タイプ
object
必須
  • key
  • operator
プロパティー説明

key

string

セレクターが適用されるラベルキー。

operator

string

キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。

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

values

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

14.10.1.35. .spec.photonPersistentDisk

説明
Photon Controller 永続ディスクリソースを表します。
タイプ
object
必須
  • pdID
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

pdID

string

pdID は、Photon Controller の永続ディスクを識別する ID です。

14.10.1.36. .spec.portworxVolume

説明
PortworxVolumeSource は、Portworx ボリュームリソースを表します。
タイプ
object
必須
  • volumeID
プロパティー説明

fsType

string

fSType は、マウントするファイルシステムタイプを表します。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

volumeID

string

volumeID は、Portworx ボリュームを一意に識別します

14.10.1.37. .spec.quobyte

説明
Pod の存続期間中続く Quobyte マウントを表します。Quobyte ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
タイプ
object
必須
  • registry
  • ボリューム
プロパティー説明

group

string

アクセスできるボリュームをマップするグループ。デフォルトは no group です。

readOnly

boolean

ここでの readOnly は、Quobyte ボリュームを読み取り専用のアクセス権限で強制的にマウントします。デフォルトは false です。

registry

string

registry は、host:port ペアの文字列として指定された単一または複数の Quobyte Registry サービスを表し (複数のエントリーはコンマで区切る)、ボリュームの中央レジストリーとして機能します。

tenant

string

動的にプロビジョニングされた Quobyte ボリュームで使用されるバックエンドで指定の Quobyte ボリュームを所有するテナント。値はプラグインにより設定されます。

user

string

アクセスできるボリュームをマップするグループ。デフォルトは serivceaccount user です。

volume

string

volume は、すでに作成されているクオバイトボリュームを名前で参照する文字列です。

14.10.1.38. .spec.rbd

説明
Pod の存続時間中続く Rados Block Device マウントを表します。RBD ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
タイプ
object
必須
  • monitors
  • image
プロパティー説明

fsType

string

fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#rbd

image

string

image は rados イメージ名です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

keyring

string

keyring は、RBDUser のキーリングへのパスです。デフォルトは/etc/ceph/keyring です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

monitors

array (string)

monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

pool

string

pool は rados プール名です。デフォルトは rbd です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

readOnly

boolean

この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

secretRef

object

SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。

user

string

user は rados ユーザー名です。これにより、プール内にイメージを作成できます。 デフォルトは admin です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

14.10.1.39. .spec.rbd.secretRef

説明
SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。
タイプ
object
プロパティー説明

name

string

名前は、namespace 内で一意であり、シークレットのリソースを参照します。

namespace

string

namespace は、シークレットの名前が一意でなければならないスペースを定義します。

14.10.1.40. .spec.scaleIO

説明
ScaleIOPersistentVolumeSource は、永続的な ScaleIO ボリュームを表します
タイプ
object
必須
  • gateway
  • system
  • secretRef
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトは "xfs" です。

gateway

string

gateway は、ScaleIO API ゲートウェイのホストアドレスです。

protectionDomain

string

protectionDomain は、設定されたストレージの ScaleIO 保護ドメインの名前です。

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretRef

object

SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。

sslEnabled

boolean

sslEnabled は、ゲートウェイとの SSL 通信を有効/無効にするフラグです。デフォルトは false です

storageMode

string

storageMode は、ボリュームのストレージを ThickProvisioned にするか ThinProvisioned にするかを示します。デフォルトは ThinProvisioned です。

storagePool

string

storagePool は、保護ドメインに関連付けられた ScaleIO ストレージプールです。

system

string

system は、ScaleIO で設定されたストレージシステムの名前です。

volumeName

string

volumeName は、このボリュームソースに関連付けられている、ScaleIO システムですでに作成されているボリュームの名前です。

14.10.1.41. .spec.scaleIO.secretRef

説明
SecretReference は、シークレットリファレンスを表します。namespace でシークレットを取得するのに十分な情報が含まれます。
タイプ
object
プロパティー説明

name

string

名前は、namespace 内で一意であり、シークレットのリソースを参照します。

namespace

string

namespace は、シークレットの名前が一意でなければならないスペースを定義します。

14.10.1.42. .spec.storageos

説明
StorageOS 永続ボリュームリソースを表します。
タイプ
object
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

readOnly

boolean

readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretRef

object

ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。

volumeName

string

volumeName は、人間が判読えきる形式の StorageOS ボリュームの名前です。ボリューム名は、ネームスペース内でのみ一意です。

volumeNamespace

string

volumeNamespace は、StorageOS 内のボリュームのスコープを指定します。名前空間が指定されていない場合は、Pod の名前空間が使用されます。これにより、Kubernetes の名前スコープを StorageOS 内にミラーリングして、より緊密に統合することができます。VolumeName を任意の名前に設定して、デフォルトの動作をオーバーライドします。StorageOS 内で namespace を使用していない場合は、"デフォルト" に設定します。StorageOS 内に事前に存在しない名前空間が作成されます。

14.10.1.43. .spec.storageos.secretRef

説明
ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
タイプ
object
プロパティー説明

apiVersion

string

参照先の API バージョン。

fieldPath

string

オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。

kind

string

参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

string

この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

string

参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

14.10.1.44. .spec.vsphereVolume

説明
vSphere ボリュームリソースを表します。
タイプ
object
必須
  • volumePath
プロパティー説明

fsType

string

fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。

storagePolicyID

string

storagePolicyID は、StoragePolicyName に関連付けられたストレージポリシーベースの管理 (SPBM) プロファイル ID です。

storagePolicyName

string

storagePolicyName は、ストレージポリシーベースの管理 (SPBM) プロファイル名です。

volumePath

string

volumePath は、vSphere ボリューム vmdk を識別するパスです。

14.10.1.45. .status

説明
PersistentVolumeStatus は、永続ボリュームの現在のステータスです。
タイプ
object
プロパティー説明

message

string

message は、ボリュームがこの状態にある理由を示す、人が判読できる形式のメッセージです。

phase

string

phase は、ボリュームが使用可能か、クレームにバインドされているか、またはクレームによってリリースされているかを示します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase

使用可能な列挙値: - Available は、利用可能なボリュームでまだバインドされていない PersistentVolumes に使用します。このボリュームは、バインダーにより保持されていて、PersistentVolumeClaims と一致します。 - "Bound" は、バインドされている PersistentVolumes に使用されます。- "Failed" は、要求から開放されたあとに正しく再利用または削除するのに失敗した PersistentVolumes に使用します。- "Pending" は、利用できない PersistentVolumes に使用します。- "Released" は、バインドされた PersistentVolumeClaim が削除された PersistentVolumes に使用されます。開放されたボリュームは、再度利用可能になる前に再利用する必要があります。このフェーズは、永続ボリューム要求のバインダーが使用し、別のプロセスに対してリソースの再要求ができると信号を送信します。

reason

string

reason は、障害を説明する簡単な CamelCase 文字列であり、CLI でのマシン解析と整理された表示を目的としています。

14.10.2. API エンドポイント

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

  • /api/v1/persistentvolumes

    • DELETE: PersistentVolume のコレクションを削除する
    • GET: PersistentVolume 種類のオブジェクトをリスト表示または監視する
    • POST: PersistentVolume を作成する
  • /api/v1/watch/persistentvolumes

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

    • DELETE: PersistentVolume を削除する
    • GET: 指定された PersistentVolume を読み取る
    • PATCH: 指定された PersistentVolume を部分的に更新する
    • PUT: 指定された PersistentVolume を置き換える
  • /api/v1/watch/persistentvolumes/{name}

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

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

14.10.2.1. /api/v1/persistentvolumes

表14.213 グローバルクエリーパラメーター
パラメーター説明

pretty

string

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

HTTP メソッド
DELETE
説明
PersistentVolume のコレクションを削除する
表14.214 クエリーパラメーター
パラメーター説明

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

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

表14.215 本文パラメーター
パラメーター説明

body

DeleteOptions スキーマ

 
表14.216 HTTP 応答
HTTP コード応答本文

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
PersistentVolume 種類のオブジェクトをリスト表示または監視する
表14.217 クエリーパラメーター
パラメーター説明

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 を指定します。

表14.218 HTTP 応答
HTTP コード応答本文

200 - OK

PersistentVolumeList スキーマ

401 - Unauthorized

空白

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

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 エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表14.220 本文パラメーター
パラメーター説明

body

PersistentVolume スキーマ

 
表14.221 HTTP 応答
HTTP コード応答本文

200 - OK

PersistentVolume スキーマ

201 - Created

PersistentVolume スキーマ

202 - Accepted

PersistentVolume スキーマ

401 - Unauthorized

空白

14.10.2.2. /api/v1/watch/persistentvolumes

表14.222 グローバルクエリーパラメーター
パラメーター説明

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 を指定します。

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

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

14.10.2.3. /api/v1/persistentvolumes/{name}

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

name

string

PersistentVolume の名前

表14.225 グローバルクエリーパラメーター
パラメーター説明

pretty

string

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

HTTP メソッド
DELETE
説明
PersistentVolume を削除する
表14.226 クエリーパラメーター
パラメーター説明

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

表14.227 本文パラメーター
パラメーター説明

body

DeleteOptions スキーマ

 
表14.228 HTTP 応答
HTTP コード応答本文

200 - OK

PersistentVolume スキーマ

202 - Accepted

PersistentVolume スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された PersistentVolume を読み取る
表14.229 HTTP 応答
HTTP コード応答本文

200 - OK

PersistentVolume スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された PersistentVolume を部分的に更新する
表14.230 クエリーパラメーター
パラメーター説明

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

表14.231 本文パラメーター
パラメーター説明

body

Patch スキーマ

 
表14.232 HTTP 応答
HTTP コード応答本文

200 - OK

PersistentVolume スキーマ

201 - Created

PersistentVolume スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された PersistentVolume を置き換える
表14.233 クエリーパラメーター
パラメーター説明

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 エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表14.234 本文パラメーター
パラメーター説明

body

PersistentVolume スキーマ

 
表14.235 HTTP 応答
HTTP コード応答本文

200 - OK

PersistentVolume スキーマ

201 - Created

PersistentVolume スキーマ

401 - Unauthorized

空白

14.10.2.4. /api/v1/watch/persistentvolumes/{name}

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

name

string

PersistentVolume の名前

表14.237 グローバルクエリーパラメーター
パラメーター説明

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 を指定します。

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

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

14.10.2.5. /api/v1/persistentvolumes/{name}/status

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

name

string

PersistentVolume の名前

表14.240 グローバルクエリーパラメーター
パラメーター説明

pretty

string

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

HTTP メソッド
GET
説明
指定された PersistentVolume のステータスを読み取る
表14.241 HTTP 応答
HTTP コード応答本文

200 - OK

PersistentVolume スキーマ

401 - Unauthorized

空白

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

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

表14.243 本文パラメーター
パラメーター説明

body

Patch スキーマ

 
表14.244 HTTP 応答
HTTP コード応答本文

200 - OK

PersistentVolume スキーマ

201 - Created

PersistentVolume スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された PersistentVolume のステータスを置き換える
表14.245 クエリーパラメーター
パラメーター説明

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 エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表14.246 本文パラメーター
パラメーター説明

body

PersistentVolume スキーマ

 
表14.247 HTTP 応答
HTTP コード応答本文

200 - OK

PersistentVolume スキーマ

201 - Created

PersistentVolume スキーマ

401 - Unauthorized

空白

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

© 2024 Red Hat, Inc.