14.10. PersistentVolume [v1]

accessModes

数组（字符串）

accessModes 包含可挂载卷的所有方法。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes

awsElasticBlockStore

object

代表 AWS 中的 Persistent Disk 资源。

挂载到容器前必须存在 AWS EBS 磁盘。磁盘还必须与 kubelet 位于同一个 AWS 区域。AWS EBS 磁盘只能以读写模式挂载。AWS EBS 卷支持所有权管理和 SELinux 重新标记。

azureDisk

对象

azureDisk 代表主机上的 Azure Data Disk 挂载，并绑定到 pod。

azureFile

对象

azureFile 代表主机上的 Azure File Service 挂载，并绑定到 pod。

capacity

对象（数量）

capacity 是持久性卷资源和容量的描述。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

cephfs

object

代表 Ceph 文件系统挂载，最后一个 pod Cephfs 卷的生命周期不支持所有权管理或 SELinux 重新标记。

cinder

object

代表 Openstack 中的 cinder 卷资源。挂载到容器之前必须存在 Cinder 卷。卷还必须与 kubelet 位于同一区域。Cinder 卷支持所有权管理和 SELinux 重新标记。

claimRef

object

ObjectReference 包含足够信息供您检查或修改引用的对象。

csi

object

代表由外部 CSI 卷驱动程序(Beta 功能)管理的存储

fc

object

代表光纤通道卷。Fibre Channel 卷只能以读写模式挂载。Fibre Channel 卷支持所有权管理和 SELinux 重新标记。

flexVolume

object

FlexPersistentVolumeSource 代表使用基于 exec 的插件置备/附加的通用持久性卷资源。

flocker

object

代表由 Flocker 代理挂载的 Flocker 卷。应该只设置其中一个 datasetName 和 datasetUUID。flocker 卷不支持所有权管理或 SELinux 重新标记。

gcePersistentDisk

object

代表 Google Compute Engine 中的 Persistent Disk 资源。

在挂载到容器前，GCE PD 必须已经存在。磁盘还必须与 kubelet 位于同一个 GCE 项目和区。GCE PD 只能以读写一次挂载，或者多次只读。GCE PDs 支持所有权管理和 SELinux 重新标记。

glusterfs

object

代表 pod 生命周期的 Glusterfs 挂载。GlusterFS 卷不支持所有权管理或 SELinux 重新标记。

hostPath

object

代表映射到 pod 的主机路径。主机路径卷不支持所有权管理或 SELinux 重新标记。

iscsi

object

ISCSIPersistentVolumeSource 代表 ISCSI 磁盘。ISCSI 卷只能以读写模式挂载。ISCSI 卷支持所有权管理和 SELinux 重新标记。

local

object

local 代表与节点关联性直接附加的存储(Beta 功能)

mountOptions

数组（字符串）

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 （为手动创建的 PersistentVolume 的默认设置）、Delete （动态置备的 PersistentVolume 的默认）和 Recycle （已弃用）。Recycle 必须被此 PersistentVolume 底层的卷插件支持。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming

可能枚举值： - "Delete" 表示该卷将从其声明中的 Kubernetes 中删除。卷插件必须支持 Deletion。- "Recycle" 意味着卷将被重新回收到其声明中未绑定持久性卷的池。卷插件必须支持 Recycling。- "Retain" 表示该卷将保留在其当前阶段(Released)中，供管理员手动回收。默认策略为 Retain。

photonPersistentDisk

object

代表 Photon Controller 持久磁盘资源。

portworxVolume

object

PortworxVolumeSource 代表一个 Portworx volume 资源。

quobyte

object

代表 pod 的生命周期持续的 Quobyte 挂载。quobyte 卷不支持所有权管理或 SELinux 重新标记。

rbd

object

代表 Rados 块设备挂载，该挂载最后是 pod 的生命周期。RBD 卷支持所有权管理和 SELinux 重新标记。

scaleIO

object

ScaleIOPersistentVolumeSource 代表一个持久的 ScaleIO 卷

storageClassName

string

storageClassName 是这个持久性卷所属的 StorageClass 的名称。空值意味着这个卷不属于任何 StorageClass。

storageos

object

代表 StorageOS 持久性卷资源。

volumeMode

字符串

volumeMode 定义卷是否要与格式化的文件系统一起使用，或者保持在原始块状态。当没有包括在 spec 中时，文件系统的值会被简化。

可能枚举值： - "Block" 表示卷不会被格式化为文件系统，并将保留原始块设备。- "Filesystem" 表示该卷将使用文件系统进行或格式化。

vsphereVolume

object

代表 vSphere 卷资源。

fsType

string

fstype 是您要挂载的卷的文件系统类型。提示： 确保主机操作系统支持文件系统类型。示例："ext4", "xfs", "ntfs"。如果未指定，则隐式推断为"ext4"。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

分区

整数

partition 是您要挂载的卷中的分区。如果省略，则默认为按卷名称挂载。示例：对于卷 /dev/sda1，您可以将分区指定为 "1"。同样，/dev/sda 的卷分区是 "0" （或者您可以将属性留空）。

readOnly

布尔值

readonly 值 true 将强制 VolumeMounts 中的 readOnly 设置。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

volumeID

string

VolumeId 是 AWS (Amazon EBS 卷)中的持久磁盘资源的唯一 ID。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

cachingMode

string

cachingMode 是主机缓存模式： None、Read Only、Read Write。

可能枚举值： - "None" - "ReadOnly" - "ReadWrite"

diskName

string

diskname 是 blob 存储中的数据磁盘的名称

diskURI

string

diskURI 是 blob 存储中数据磁盘的 URI

fsType

string

fstype 是要挂载的 Filesystem 类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定，则隐式推断为"ext4"。

kind

string

kind expected 值是 Shared: multiple blob disk per storage account Managed: azure disk per storage account Managed: azure managed data disk (only in managed availability set)）。默认为 shared

possible enum 值： - "Dedicated" - "Managed" - "Shared"

readOnly

布尔值

只读默认值为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

readOnly

布尔值

只读默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

secretName

string

secretName 是包含 Azure Storage Account Name 和 Key 的 secret 名称

secretNamespace

string

secretNamespace 是包含 Azure Storage Account Name 和 Key default 的 secret 的命名空间与 Pod 相同

shareName

string

sharename 是 azure Share Name

monitor

数组（字符串）

Monitors is Required: Monitor is a collection of Ceph monitors more info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

path

string

路径为可选： 作为挂载的 root 使用，而不是完整的 Ceph 树，默认为 /

readOnly

布尔值

readonly 是可选的：默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。更多信息： https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretFile

string

secretfile 是可选：SecretFile 是 User 的密钥环的路径，默认为 /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretRef

object

secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret

user

string

用户是可选的： User 是 rados 用户名，默认为 admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

name

string

名称在命名空间内是唯一的，以引用 secret 资源。

namespace

string

namespace 定义 secret 名称必须唯一的空间。

fsType

string

要挂载的 fstype Filesystem 类型。必须是主机操作系统支持的文件系统类型。示例："ext4", "xfs", "ntfs"。如果未指定，则隐式推断为"ext4"。更多信息： https://examples.k8s.io/mysql-cinder-pd/README.md

readOnly

布尔值

readonly 是可选的：默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。更多信息： https://examples.k8s.io/mysql-cinder-pd/README.md

secretRef

object

secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret

volumeID

string

用于识别 cinder 中的卷的卷 ID。更多信息： https://examples.k8s.io/mysql-cinder-pd/README.md

name

string

名称在命名空间内是唯一的，以引用 secret 资源。

namespace

string

namespace 定义 secret 名称必须唯一的空间。

apiVersion

字符串

引用的 API 版本。

fieldPath

字符串

如果引用的是对象的一部分而非整个对象，则该字符串应包含有效的 JSON/Go 字段访问声明，如 desiredState.manifest.containers[2]。例如，如果对象引用是一个 pod 中的容器，它应该还以下类似： "spec.containers{name}"（其中 "name" 是指触发事件的容器的名称）,如果不使用容器名称，则应类似于 "spec.containers[2]"（使用此 pod 中索引值为 2 的容器）。选择这个语法的原因是，为了有一些指向对象部分的正确定义方法。

kind

字符串

引用的类型。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

字符串

引用的命名空间。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

字符串

指定构成这个引用的 resourceVersion（如果存在）。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

字符串

引用的 UID。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

controllerExpandSecretRef

object

secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret

controllerPublishSecretRef

object

secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret

driver

string

driver 是要用于此卷的驱动程序名称。必需。

fsType

string

要挂载的 fstype。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".

nodeExpandSecretRef

object

secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret

nodePublishSecretRef

object

secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret

nodeStageSecretRef

object

secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret

readOnly

布尔值

传递给 ControllerPublishVolumeRequest 的 readonly 值。默认为 false （读/写）。

volumeAttributes

对象（字符串）

要发布的卷的 volumeAttributes。

volumeHandle

string

volumeHandle 是 CSI 卷插件的 CreateVolume 返回的唯一卷名称，以在所有后续调用中引用卷。必需。

name

string

名称在命名空间内是唯一的，以引用 secret 资源。

namespace

string

namespace 定义 secret 名称必须唯一的空间。

name

string

名称在命名空间内是唯一的，以引用 secret 资源。

namespace

string

namespace 定义 secret 名称必须唯一的空间。

name

string

名称在命名空间内是唯一的，以引用 secret 资源。

namespace

string

namespace 定义 secret 名称必须唯一的空间。

name

string

名称在命名空间内是唯一的，以引用 secret 资源。

namespace

string

namespace 定义 secret 名称必须唯一的空间。

name

string

名称在命名空间内是唯一的，以引用 secret 资源。

namespace

string

namespace 定义 secret 名称必须唯一的空间。

fsType

string

fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定，则隐式推断为"ext4"。

LUN

整数

LUN 是可选的： FC 目标 lun 号

readOnly

布尔值

readonly 是可选的：默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

targetWWNs

数组（字符串）

targetWWN 可选： FC 目标全球名称(WWN)

wwids

数组（字符串）

wwids 可选：FC 卷全局广泛的标识符(wwids) Either wwids 或 targetWWNs 和 lun 的组合必须同时设置，但不能同时设置。

driver

string

driver 是要用于此卷的驱动程序名称。

fsType

string

fstype 是要挂载的 Filesystem 类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".默认文件系统取决于 FlexVolume 脚本。

options

对象（字符串）

选项是可选的：此字段包含额外的命令选项（若有）。

readOnly

布尔值

readonly 是可选的：默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

secretRef

object

secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret

name

string

名称在命名空间内是唯一的，以引用 secret 资源。

namespace

string

namespace 定义 secret 名称必须唯一的空间。

datasetName

string

datasetName 是存储在 Flocker 的 dataset 的 dataset 的 dataset 的 Name。

datasetUUID

string

datasetUUID 是 dataset 的 UUID。这是 Flocker 数据集的唯一标识符

fsType

string

fstype 是您要挂载的卷的文件系统类型。提示： 确保主机操作系统支持文件系统类型。示例："ext4", "xfs", "ntfs"。如果未指定，则隐式推断为"ext4"。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

分区

整数

partition 是您要挂载的卷中的分区。如果省略，则默认为按卷名称挂载。示例：对于卷 /dev/sda1，您可以将分区指定为 "1"。同样，/dev/sda 的卷分区是 "0" （或者您可以将属性留空）。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

pdName

string

pdName 是 GCE 中的 PD 资源的唯一名称。用于识别 GCE 中的磁盘。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

readOnly

布尔值

此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。默认为false。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

端点

string

Endpoints 是详细信息 Glusterfs 拓扑的端点名称。更多信息： https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

endpointsNamespace

string

endpointsNamespace 是包含 Glusterfs 端点的命名空间。如果此字段为空，则 EndpointNamespace 默认为与绑定 PVC 相同的命名空间。更多信息： 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

布尔值

此处的只读将强制使用只读权限挂载 Glusterfs 卷。默认为false。更多信息： https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

path

string

主机上目录的路径。如果路径是符号链接，它将遵循到实际路径的链接。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#hostpath

type

string

HostPath Volume Defaults 为 "" more info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

可能枚举值：- "" 对于向后兼容，如果未设置 - "BlockDevice" A 块设备必须存在于给定路径 - "CharDevice" A 字符设备必须存在于给定路径上 - "Directory" A 目录必须存在于给定路径 - "DirectoryOrCreate" 中（如果给定路径不存在）， 将根据需要创建一个空目录，且文件模式为 0755，其具有与 Kubelet 相同的组和所有权。- "File" A 文件必须存在于给定路径上 - "FileOrCreate" 如果给定路径上不存在，将根据需要创建一个空文件，该文件与文件模式 0644 具有相同的组和所有权。- "Socket" A UNIX 套接字必须存在于给定路径上。

chapAuthDiscovery

布尔值

chapAuthDiscovery 定义是否支持 iSCSI Discovery CHAP 身份验证

chapAuthSession

布尔值

chapAuthSession 定义是否支持 iSCSI Session 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

整数

LUN 是 iSCSI 目标 Lun 编号。

门户

数组（字符串）

门户是 iSCSI 目标门户列表。如果端口不是默认值（通常是 TCP 端口 860 和 3260），则门户可以是 IP 或 ip_addr:port。

readOnly

布尔值

此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。默认为false。

secretRef

object

secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret

targetPortal

string

targetPortal 是 iSCSI 目标门户。如果端口不是默认值（通常是 TCP 端口 860 和 3260），则门户可以是 IP 或 ip_addr:port。

name

string

名称在命名空间内是唯一的，以引用 secret 资源。

namespace

string

namespace 定义 secret 名称必须唯一的空间。

fsType

string

fstype 是要挂载的文件系统类型。只有在路径是块设备时，它才会应用。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定，则默认值为自动选择文件系统。

path

string

到节点上卷的完整路径的路径。它可以是目录或块设备(disk, partition, …​)。

path

string

NFS 服务器导出的路径。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#nfs

readOnly

布尔值

此处的只读将强制使用只读权限挂载 NFS 导出。默认为false。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#nfs

server

string

server 是 NFS 服务器的主机名或 IP 地址。更多信息： https://kubernetes.io/docs/concepts/storage/volumes#nfs

required

object

节点选择器表示一个或多个对一组节点的标签查询结果的联合；即，它代表节点选择器术语代表的选择器的 OR。

nodeSelectorTerms

array

必需。节点选择器术语列表。条款是 ORed。

nodeSelectorTerms[]

对象

null 或 empty 节点选择器术语不匹配任何对象。它们的要求是 AND。TopologySelectorTerm 类型实现 NodeSelectorTerm 的子集。

matchExpressions

array

节点标签(label)的节点选择器要求列表。

matchExpressions[]

对象

节点选择器要求是一个选择器，其中包含值、键和与键和值关联的操作器。

matchFields

array

节点字段的节点选择器要求列表。

matchFields[]

对象

节点选择器要求是一个选择器，其中包含值、键和与键和值关联的操作器。

key

字符串

选择器应用到的标签键。

operator

字符串

代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt, 和 Lt.

possible enum 值：- "DoesNotExist" - "Exists" - "Gt" - "In" - "Lt" - "NotIn"

values

数组（字符串）

字符串值数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。如果 Operator 是 Gt 或 Lt，则值数组必须具有单个元素，该元素将解释为整数。这个数组会在策略性合并补丁中被替换。

key

字符串

选择器应用到的标签键。

operator

字符串

代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt, 和 Lt.

possible enum 值：- "DoesNotExist" - "Exists" - "Gt" - "In" - "Lt" - "NotIn"

values

数组（字符串）

字符串值数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。如果 Operator 是 Gt 或 Lt，则值数组必须具有单个元素，该元素将解释为整数。这个数组会在策略性合并补丁中被替换。

fsType

string

fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定，则隐式推断为"ext4"。

pdID

string

pdID 是标识 Photon Controller 持久磁盘的 ID

fsType

string

fstype 代表要挂载的文件系统类型，必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs".如果未指定，则隐式推断为"ext4"。

readOnly

布尔值

只读默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

volumeID

string

VolumeId 唯一标识一个 Portworx 卷

group

string

将卷访问映射到 Default 的组没有组

readOnly

布尔值

此处的只读将强制使用只读权限挂载 Quobyte 卷。默认为false。

registry

string

registry 代表一个或多个 Quobyte Registry 服务，作为字符串指定为 host:port 对（多个条目用逗号分隔），后者充当卷的中央 registry

tenant

string

在带有动态置备 Quobyte 卷的后端中拥有给定 Quobyte 卷的租户，值由插件设置

user

string

用户将卷访问权限映射到默认值到 serivceaccount 用户

卷

string

卷是一个字符串，它根据名称引用已创建的 Quobyte 卷。

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

monitor

数组（字符串）

monitor 是 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

布尔值

此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。默认为false。更多信息： https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

secretRef

object

secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret

user

string

user 是 rados 用户名。默认为 admin。更多信息： https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

name

string

名称在命名空间内是唯一的，以引用 secret 资源。

namespace

string

namespace 定义 secret 名称必须唯一的空间。

fsType

string

fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".默认为 "xfs"

gateway

string

gateway 是 ScaleIO API 网关的主机地址。

protectionDomain

string

protectionDomain 是配置的存储的 ScaleIO 保护域的名称。

readOnly

布尔值

只读默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

secretRef

object

secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret

sslEnabled

布尔值

sslEnabled 是启用/禁用与网关的 SSL 通信的标记，默认为 false

storageMode

string

storageMode 指示卷的存储应该是 ThickProvisioned 或 ThinProvisioned。默认为 ThinProvisioned。

storagePool

string

storagePool 是与保护域关联的 ScaleIO 存储池。

system

string

system 是存储系统的名称，如 ScaleIO 中配置。

volumeName

string

volumeName 是在与这个卷源关联的 ScaleIO 系统中创建的卷的名称。

name

string

名称在命名空间内是唯一的，以引用 secret 资源。

namespace

string

namespace 定义 secret 名称必须唯一的空间。

fsType

string

fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定，则隐式推断为"ext4"。

readOnly

布尔值

只读默认为 false （读/写）。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

secretRef

object

ObjectReference 包含足够信息供您检查或修改引用的对象。

volumeName

string

volumeName 是 StorageOS 卷的人类可读名称。卷名称只在命名空间中是唯一的。

volumeNamespace

string

volumeNamespace 指定 StorageOS 中卷的范围。如果没有指定命名空间，则使用 Pod 的命名空间。这允许在 StorageOS 中镜像 Kubernetes 名称范围，以便在更紧密的集成。将 VolumeName 设置为任何名称来覆盖默认的行为。如果没有在 StorageOS 中使用命名空间，则设置为 "default"。将创建在 StorageOS 中没有预先存在的命名空间。

apiVersion

字符串

引用的 API 版本。

fieldPath

字符串

如果引用的是对象的一部分而非整个对象，则该字符串应包含有效的 JSON/Go 字段访问声明，如 desiredState.manifest.containers[2]。例如，如果对象引用是一个 pod 中的容器，它应该还以下类似： "spec.containers{name}"（其中 "name" 是指触发事件的容器的名称）,如果不使用容器名称，则应类似于 "spec.containers[2]"（使用此 pod 中索引值为 2 的容器）。选择这个语法的原因是，为了有一些指向对象部分的正确定义方法。

kind

字符串

引用的类型。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

字符串

引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

字符串

引用的命名空间。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

字符串

指定构成这个引用的 resourceVersion（如果存在）。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

字符串

引用的 UID。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

fsType

string

fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定，则隐式推断为"ext4"。

storagePolicyID

string

StoragePolicyID 是与 StoragePolicyName 关联的存储 Policy Based Management (SPBM)配置集 ID。

storagePolicyName

string

StoragePolicyName 是存储基于策略的管理(SPBM)配置集名称。

volumePath

string

volumePath 是标识 vSphere 卷 vmdk 的路径

message

string

Message 是人类可读的消息，指示卷处于此状态的详细信息。

phase

string

phase 表示卷是否可用、绑定到声明或被声明释放。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase

可能枚举的值： - "Available" 用于尚未绑定的 PersistentVolume，并被 binder 保存，并与 PersistentVolumeClaims - "Bound" 用于绑定的 - "Failed" 用于从其中释放后正确回收或删除的 PersistentVolume。 claim - "Pending" 用于不可用的 PersistentVolume - "Released" 用于 PersistentVolume，其中绑定 PersistentVolumeClaim 被删除了发布的卷，然后必须重新回收该阶段，供持久性卷声明绑定程序用于向另一个进程发出信号，以回收资源

reason

string

reason 是一个简单的 CamelCase 字符串，用于描述任何失败，用于 CLI 中的机器解析和截断显示。

pretty

字符串

如果为 'true'，则输出会经过 pretty print 处理。

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。

当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldSelector

字符串

用于按字段限制返回对象列表的选择器。默认为任何内容。

gracePeriodSeconds

整数

应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。

labelSelector

字符串

一个选择器，用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。

服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。

orphanDependents

布尔值

deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。

propagationPolicy

字符串

是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。

正文（body）

DeleteOptions 模式

200 - OK

Status 模式

401 - Unauthorized

空

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。

当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。

fieldSelector

字符串

用于按字段限制返回对象列表的选择器。默认为任何内容。

labelSelector

字符串

一个选择器，用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。

服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。

watch

布尔值

观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。

200 - OK

PersistentVolumeList 模式

401 - 未授权

空

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

正文（body）

PersistentVolume 模式

200 - OK

PersistentVolume 模式

201 - Created

PersistentVolume 模式

202 - Accepted

PersistentVolume 模式

401 - 未授权

空

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。

当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。

fieldSelector

字符串

用于按字段限制返回对象列表的选择器。默认为任何内容。

labelSelector

字符串

一个选择器，用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。

服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。

pretty

字符串

如果为 'true'，则输出会经过 pretty print 处理。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。

watch

布尔值

观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。

200 - OK

WatchEvent 模式

401 - Unauthorized

空

name

string

PersistentVolume 的名称

pretty

字符串

如果为 'true'，则输出会经过 pretty print 处理。

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

gracePeriodSeconds

整数

应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。

orphanDependents

布尔值

deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。

propagationPolicy

字符串

是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。

正文（body）

DeleteOptions 模式

200 - OK

PersistentVolume 模式

202 - Accepted

PersistentVolume 模式

401 - 未授权

空

200 - OK

PersistentVolume 模式

401 - 未授权

空

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

force

布尔值

强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

正文（body）

Patch 模式

200 - OK

PersistentVolume 模式

201 - Created

PersistentVolume 模式

401 - 未授权

空

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

正文（body）

PersistentVolume 模式

200 - OK

PersistentVolume 模式

201 - Created

PersistentVolume 模式

401 - 未授权

空

name

string

PersistentVolume 的名称

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。

当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。

fieldSelector

字符串

用于按字段限制返回对象列表的选择器。默认为任何内容。

labelSelector

字符串

一个选择器，用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。

服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。

pretty

字符串

如果为 'true'，则输出会经过 pretty print 处理。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。

watch

布尔值

观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。

200 - OK

WatchEvent 模式

401 - Unauthorized

空

name

string

PersistentVolume 的名称

pretty

字符串

如果为 'true'，则输出会经过 pretty print 处理。

200 - OK

PersistentVolume 模式

401 - 未授权

空

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch)，但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

force

布尔值

强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

正文（body）

Patch 模式

200 - OK

PersistentVolume 模式

201 - Created

PersistentVolume 模式

401 - 未授权

空

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

正文（body）

PersistentVolume 模式

200 - OK

PersistentVolume 模式

201 - Created

PersistentVolume 模式

401 - 未授权

空