持久卷声明 [undefined/v1] - 存储 API | API 参考 | OpenShift Container Platform 4.17

规格
API 端点

描述: PersistentVolumeClaim 是用户对持久卷的请求和声明
类型: 对象

规格

属性类型描述

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义了此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从此客户端提交请求的端点推断出此值。不能更新。使用驼峰式大小写。更多信息：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`	`对象`	PersistentVolumeClaimSpec 描述了存储设备的常见属性，并允许为特定于提供程序的属性提供源
`status`	`对象`	PersistentVolumeClaimStatus 是持久卷声明的当前状态。

apiVersion

字符串

APIVersion 定义了此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从此客户端提交请求的端点推断出此值。不能更新。使用驼峰式大小写。更多信息：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

对象

PersistentVolumeClaimSpec 描述了存储设备的常见属性，并允许为特定于提供程序的属性提供源

status

对象

PersistentVolumeClaimStatus 是持久卷声明的当前状态。

.spec

描述: PersistentVolumeClaimSpec 描述了存储设备的常见属性，并允许为特定于提供程序的属性提供源
类型: 对象

属性类型描述

属性	类型	描述
`accessModes`	`数组 (字符串)`	accessModes 包含卷应具有的所需访问模式。更多信息：https://kubernetes.ac.cn/docs/concepts/storage/persistent-volumes#access-modes-1
`dataSource`	`对象`	TypedLocalObjectReference 包含足够的信息，可让您在同一命名空间中找到已引用的类型化对象。
`dataSourceRef`	`对象`	如果需要非空卷，则 `dataSourceRef` 指定用于填充卷数据的对象。这可以是任何非空 API 组（非核心对象）中的对象或 PersistentVolumeClaim 对象。指定此字段后，只有当指定对象的类型与某些已安装的卷填充程序或动态供应程序匹配时，卷绑定才会成功。此字段将替换 `dataSource` 字段的功能，因此，如果这两个字段都非空，则它们必须具有相同的值。为了向后兼容，当 `dataSourceRef` 中未指定命名空间时，如果其中一个字段为空而另一个字段非空，则这两个字段（`dataSource` 和 `dataSourceRef`）将自动设置为相同的值。当在 `dataSourceRef` 中指定命名空间时，`dataSource` 不会设置为相同的值，并且必须为空。`dataSource` 和 `dataSourceRef` 之间存在三个重要区别：* `dataSource` 只允许两种特定类型的对象，而 `dataSourceRef` 允许任何非核心对象以及 PersistentVolumeClaim 对象。* `dataSource` 会忽略不允许的值（将其丢弃），而 `dataSourceRef` 会保留所有值，并在指定不允许的值时生成错误。* `dataSource` 只允许本地对象，而 `dataSourceRef` 允许任何命名空间中的对象。（Beta）使用此字段需要启用 AnyVolumeDataSource 功能门。（Alpha）使用 `dataSourceRef` 的命名空间字段需要启用 CrossNamespaceVolumeDataSource 功能门。
`资源`	`对象`	VolumeResourceRequirements 描述卷的存储资源需求。
`选择器`	`标签选择器`	selector 是对要考虑用于绑定的卷的标签查询。
`存储类名`	`字符串`	storageClassName 是声明所需的 StorageClass 的名称。更多信息：https://kubernetes.ac.cn/docs/concepts/storage/persistent-volumes#class-1
`卷属性类名`	`字符串`	volumeAttributesClassName 可用于设置此声明使用的 VolumeAttributesClass。如果指定，CSI 驱动程序将使用相应 VolumeAttributesClass 中定义的属性创建或更新卷。这与 storageClassName 的目的不同，它可以在声明创建后更改。空字符串值表示不会将任何 VolumeAttributesClass 应用于声明，但一旦设置，就不允许将此字段重置为空字符串。如果未指定并且 PersistentVolumeClaim 未绑定，则如果存在，持久卷控制器将设置默认的 VolumeAttributesClass。如果 volumeAttributesClass 引用的资源不存在，则此 PersistentVolumeClaim 将设置为 Pending 状态（如 modifyVolumeStatus 字段所示），直到此类资源存在为止。更多信息：https://kubernetes.ac.cn/docs/concepts/storage/volume-attributes-classes/（Alpha）使用此字段需要启用 VolumeAttributesClass 功能门。
`卷模式`	`字符串`	volumeMode 定义声明所需的卷类型。如果声明规范中未包含，则隐含 Filesystem 值。可能的枚举值：- `“Block”` 表示卷不会使用文件系统进行格式化，并将保持为原始块设备。- `“Filesystem”` 表示卷将使用文件系统进行格式化或已使用文件系统进行格式化。
`卷名`	`字符串`	volumeName 是对支持此声明的 PersistentVolume 的绑定引用。

accessModes

数组 (字符串)

accessModes 包含卷应具有的所需访问模式。更多信息：https://kubernetes.ac.cn/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

对象

TypedLocalObjectReference 包含足够的信息，可让您在同一命名空间中找到已引用的类型化对象。

dataSourceRef

对象

如果需要非空卷，则 `dataSourceRef` 指定用于填充卷数据的对象。这可以是任何非空 API 组（非核心对象）中的对象或 PersistentVolumeClaim 对象。指定此字段后，只有当指定对象的类型与某些已安装的卷填充程序或动态供应程序匹配时，卷绑定才会成功。此字段将替换 `dataSource` 字段的功能，因此，如果这两个字段都非空，则它们必须具有相同的值。为了向后兼容，当 `dataSourceRef` 中未指定命名空间时，如果其中一个字段为空而另一个字段非空，则这两个字段（`dataSource` 和 `dataSourceRef`）将自动设置为相同的值。当在 `dataSourceRef` 中指定命名空间时，`dataSource` 不会设置为相同的值，并且必须为空。`dataSource` 和 `dataSourceRef` 之间存在三个重要区别：* `dataSource` 只允许两种特定类型的对象，而 `dataSourceRef` 允许任何非核心对象以及 PersistentVolumeClaim 对象。* `dataSource` 会忽略不允许的值（将其丢弃），而 `dataSourceRef` 会保留所有值，并在指定不允许的值时生成错误。* `dataSource` 只允许本地对象，而 `dataSourceRef` 允许任何命名空间中的对象。（Beta）使用此字段需要启用 AnyVolumeDataSource 功能门。（Alpha）使用 `dataSourceRef` 的命名空间字段需要启用 CrossNamespaceVolumeDataSource 功能门。

资源

对象

VolumeResourceRequirements 描述卷的存储资源需求。

选择器

标签选择器

selector 是对要考虑用于绑定的卷的标签查询。

存储类名

字符串

storageClassName 是声明所需的 StorageClass 的名称。更多信息：https://kubernetes.ac.cn/docs/concepts/storage/persistent-volumes#class-1

卷属性类名

字符串

volumeAttributesClassName 可用于设置此声明使用的 VolumeAttributesClass。如果指定，CSI 驱动程序将使用相应 VolumeAttributesClass 中定义的属性创建或更新卷。这与 storageClassName 的目的不同，它可以在声明创建后更改。空字符串值表示不会将任何 VolumeAttributesClass 应用于声明，但一旦设置，就不允许将此字段重置为空字符串。如果未指定并且 PersistentVolumeClaim 未绑定，则如果存在，持久卷控制器将设置默认的 VolumeAttributesClass。如果 volumeAttributesClass 引用的资源不存在，则此 PersistentVolumeClaim 将设置为 Pending 状态（如 modifyVolumeStatus 字段所示），直到此类资源存在为止。更多信息：https://kubernetes.ac.cn/docs/concepts/storage/volume-attributes-classes/（Alpha）使用此字段需要启用 VolumeAttributesClass 功能门。

卷模式

字符串

volumeMode 定义声明所需的卷类型。如果声明规范中未包含，则隐含 Filesystem 值。

可能的枚举值：- `“Block”` 表示卷不会使用文件系统进行格式化，并将保持为原始块设备。- `“Filesystem”` 表示卷将使用文件系统进行格式化或已使用文件系统进行格式化。

卷名

字符串

volumeName 是对支持此声明的 PersistentVolume 的绑定引用。

.spec.dataSource

描述

TypedLocalObjectReference 包含足够的信息，可让您在同一命名空间中找到已引用的类型化对象。

类型

对象

必需

kind
名称

属性类型描述

属性	类型	描述
`API组`	`字符串`	APIGroup 是正在引用的资源的组。如果未指定 APIGroup，则指定的 Kind 必须位于核心 API 组中。对于任何其他第三方类型，都需要 APIGroup。
`kind`	`字符串`	Kind 是正在引用的资源的类型
`名称`	`字符串`	Name 是正在引用的资源的名称

API组

字符串

APIGroup 是正在引用的资源的组。如果未指定 APIGroup，则指定的 Kind 必须位于核心 API 组中。对于任何其他第三方类型，都需要 APIGroup。

kind

字符串

Kind 是正在引用的资源的类型

名称

字符串

Name 是正在引用的资源的名称

.spec.dataSourceRef

描述

类型

对象

必需

kind
名称

属性类型描述

属性	类型	描述
`API组`	`字符串`	APIGroup 是正在引用的资源的组。如果未指定 APIGroup，则指定的 Kind 必须位于核心 API 组中。对于任何其他第三方类型，都需要 APIGroup。
`kind`	`字符串`	Kind 是正在引用的资源的类型
`名称`	`字符串`	Name 是正在引用的资源的名称
`命名空间`	`字符串`	Namespace 是正在引用的资源的命名空间。请注意，当指定命名空间时，需要在引用命名空间中使用 gateway.networking.k8s.io/ReferenceGrant 对象来允许该命名空间的所有者接受引用。有关详细信息，请参阅 ReferenceGrant 文档。（Alpha）此字段需要启用 CrossNamespaceVolumeDataSource 功能门。

API组

字符串

APIGroup 是正在引用的资源的组。如果未指定 APIGroup，则指定的 Kind 必须位于核心 API 组中。对于任何其他第三方类型，都需要 APIGroup。

kind

字符串

Kind 是正在引用的资源的类型

名称

字符串

Name 是正在引用的资源的名称

命名空间

字符串

Namespace 是正在引用的资源的命名空间。请注意，当指定命名空间时，需要在引用命名空间中使用 gateway.networking.k8s.io/ReferenceGrant 对象来允许该命名空间的所有者接受引用。有关详细信息，请参阅 ReferenceGrant 文档。（Alpha）此字段需要启用 CrossNamespaceVolumeDataSource 功能门。

.spec.resources

描述: VolumeResourceRequirements 描述卷的存储资源需求。
类型: 对象

属性类型描述

属性	类型	描述
`限制`	`对象 (数量)`	Limits 描述允许的最大计算资源量。更多信息：https://kubernetes.ac.cn/docs/concepts/configuration/manage-resources-containers/
`请求`	`对象 (数量)`	Requests 描述所需的最小计算资源量。如果容器省略 Requests，则如果显式指定 Limits，则默认为 Limits，否则默认为实现定义的值。Requests 不能超过 Limits。更多信息：https://kubernetes.ac.cn/docs/concepts/configuration/manage-resources-containers/

限制

对象 (数量)

Limits 描述允许的最大计算资源量。更多信息：https://kubernetes.ac.cn/docs/concepts/configuration/manage-resources-containers/

请求

对象 (数量)

Requests 描述所需的最小计算资源量。如果容器省略 Requests，则如果显式指定 Limits，则默认为 Limits，否则默认为实现定义的值。Requests 不能超过 Limits。更多信息：https://kubernetes.ac.cn/docs/concepts/configuration/manage-resources-containers/

.status

描述: PersistentVolumeClaimStatus 是持久卷声明的当前状态。
类型: 对象

属性类型描述

属性	类型	描述
`accessModes`	`数组 (字符串)`	accessModes 包含支持 PVC 的卷的实际访问模式。更多信息：https://kubernetes.ac.cn/docs/concepts/storage/persistent-volumes#access-modes-1
`已分配资源状态`	`对象 (字符串)`	allocatedResourceStatuses 存储为给定 PVC 调整大小的资源的状态。键名遵循标准 Kubernetes 标签语法。有效值为：* 无前缀的键：- storage - 卷的容量。* 自定义资源必须使用实现定义的前缀名称，例如“example.com/my-custom-resource”。除了上述值之外，无前缀或具有 kubernetes.io 前缀的键被视为保留键，因此不能使用。 ClaimResourceStatus 可以处于以下任何状态：- ControllerResizeInProgress：当调整大小控制器开始在控制平面调整卷大小时设置的状态。- ControllerResizeFailed：当调整大小在调整大小控制器中因最终错误而失败时设置的状态。- NodeResizePending：当调整大小控制器已完成卷大小调整但节点上需要进一步调整卷大小时设置的状态。- NodeResizeInProgress：当 kubelet 开始调整卷大小时设置的状态。- NodeResizeFailed：当调整大小在 kubelet 中因最终错误而失败时设置的状态。瞬态错误不会设置 NodeResizeFailed。例如：如果扩展 PVC 以获得更多容量 - 此字段可以是以下状态之一：- pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed" 当未设置此字段时，表示对于给定的 PVC，没有调整大小操作正在进行。接收具有先前未知 resourceName 或 ClaimResourceStatus 的 PVC 更新的控制器应忽略为其设计目的的更新。例如，仅负责调整卷容量的控制器应忽略更改与 PVC 关联的其他有效资源的 PVC 更新。这是一个 alpha 字段，需要启用 RecoverVolumeExpansionFailure 功能。
`已分配资源`	`对象 (数量)`	allocatedResources 跟踪分配给 PVC 的资源，包括其容量。键名遵循标准 Kubernetes 标签语法。有效值为：* 无前缀的键：- storage - 卷的容量。* 自定义资源必须使用实现定义的前缀名称，例如“example.com/my-custom-resource”。除了上述值之外，无前缀或具有 kubernetes.io 前缀的键被视为保留键，因此不能使用。此处报告的容量在请求卷扩展操作时可能大于实际容量。对于存储配额，使用 `allocatedResources` 和 `PVC.spec.resources` 中较大的值。如果未设置 `allocatedResources`，则仅使用 `PVC.spec.resources` 进行配额计算。如果降低了卷扩展容量请求，则只有在没有扩展操作正在进行并且实际卷容量等于或小于请求容量的情况下，才会降低 `allocatedResources`。接收带有先前未知 `resourceName` 的 PVC 更新的控制器应忽略该更新的预期用途。例如，仅负责调整卷大小的控制器应忽略更改与 PVC 关联的其他有效资源的 PVC 更新。这是一个 alpha 字段，需要启用 RecoverVolumeExpansionFailure 功能。
`容量`	`对象 (数量)`	capacity 表示底层卷的实际资源。
`状态`	`数组`	conditions 是持久卷声明的当前状态。如果底层持久卷正在调整大小，则状态将设置为“Resizing”。
`conditions[]`	`对象`	PersistentVolumeClaimCondition 包含有关 pvc 状态的详细信息。
`currentVolumeAttributesClassName`	`字符串`	currentVolumeAttributesClassName 是 PVC 当前使用的 VolumeAttributesClass 的名称。未设置时，表示没有 VolumeAttributeClass 应用于此 PersistentVolumeClaim。这是一个 alpha 字段，需要启用 VolumeAttributesClass 功能。
`modifyVolumeStatus`	`对象`	ModifyVolumeStatus 表示 ControllerModifyVolume 操作的状态对象。
`阶段`	`字符串`	phase 表示 PersistentVolumeClaim 的当前阶段。可能的枚举值：- `“Bound”` 用于已绑定的 PersistentVolumeClaims - `“Lost”` 用于丢失其底层 PersistentVolume 的 PersistentVolumeClaims。该声明绑定到一个 PersistentVolume，而该卷不再存在，其上的所有数据都丢失了。- `“Pending”` 用于尚未绑定的 PersistentVolumeClaims

accessModes

数组 (字符串)

accessModes 包含支持 PVC 的卷的实际访问模式。更多信息：https://kubernetes.ac.cn/docs/concepts/storage/persistent-volumes#access-modes-1

已分配资源状态

对象 (字符串)

allocatedResourceStatuses 存储为给定 PVC 调整大小的资源的状态。键名遵循标准 Kubernetes 标签语法。有效值为：* 无前缀的键：- storage - 卷的容量。* 自定义资源必须使用实现定义的前缀名称，例如“example.com/my-custom-resource”。除了上述值之外，无前缀或具有 kubernetes.io 前缀的键被视为保留键，因此不能使用。

ClaimResourceStatus 可以处于以下任何状态：- ControllerResizeInProgress：当调整大小控制器开始在控制平面调整卷大小时设置的状态。- ControllerResizeFailed：当调整大小在调整大小控制器中因最终错误而失败时设置的状态。- NodeResizePending：当调整大小控制器已完成卷大小调整但节点上需要进一步调整卷大小时设置的状态。- NodeResizeInProgress：当 kubelet 开始调整卷大小时设置的状态。- NodeResizeFailed：当调整大小在 kubelet 中因最终错误而失败时设置的状态。瞬态错误不会设置 NodeResizeFailed。例如：如果扩展 PVC 以获得更多容量 - 此字段可以是以下状态之一：- pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress" - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed" 当未设置此字段时，表示对于给定的 PVC，没有调整大小操作正在进行。

接收具有先前未知 resourceName 或 ClaimResourceStatus 的 PVC 更新的控制器应忽略为其设计目的的更新。例如，仅负责调整卷容量的控制器应忽略更改与 PVC 关联的其他有效资源的 PVC 更新。

这是一个 alpha 字段，需要启用 RecoverVolumeExpansionFailure 功能。

已分配资源

对象 (数量)

allocatedResources 跟踪分配给 PVC 的资源，包括其容量。键名遵循标准 Kubernetes 标签语法。有效值为：* 无前缀的键：- storage - 卷的容量。* 自定义资源必须使用实现定义的前缀名称，例如“example.com/my-custom-resource”。除了上述值之外，无前缀或具有 kubernetes.io 前缀的键被视为保留键，因此不能使用。

此处报告的容量在请求卷扩展操作时可能大于实际容量。对于存储配额，使用 `allocatedResources` 和 `PVC.spec.resources` 中较大的值。如果未设置 `allocatedResources`，则仅使用 `PVC.spec.resources` 进行配额计算。如果降低了卷扩展容量请求，则只有在没有扩展操作正在进行并且实际卷容量等于或小于请求容量的情况下，才会降低 `allocatedResources`。

接收带有先前未知 `resourceName` 的 PVC 更新的控制器应忽略该更新的预期用途。例如，仅负责调整卷大小的控制器应忽略更改与 PVC 关联的其他有效资源的 PVC 更新。

这是一个 alpha 字段，需要启用 RecoverVolumeExpansionFailure 功能。

容量

对象 (数量)

capacity 表示底层卷的实际资源。

状态

数组

conditions 是持久卷声明的当前状态。如果底层持久卷正在调整大小，则状态将设置为“Resizing”。

conditions[]

对象

PersistentVolumeClaimCondition 包含有关 pvc 状态的详细信息。

currentVolumeAttributesClassName

字符串

currentVolumeAttributesClassName 是 PVC 当前使用的 VolumeAttributesClass 的名称。未设置时，表示没有 VolumeAttributeClass 应用于此 PersistentVolumeClaim。这是一个 alpha 字段，需要启用 VolumeAttributesClass 功能。

modifyVolumeStatus

对象

ModifyVolumeStatus 表示 ControllerModifyVolume 操作的状态对象。

阶段

字符串

phase 表示 PersistentVolumeClaim 的当前阶段。

可能的枚举值：- `“Bound”` 用于已绑定的 PersistentVolumeClaims - `“Lost”` 用于丢失其底层 PersistentVolume 的 PersistentVolumeClaims。该声明绑定到一个 PersistentVolume，而该卷不再存在，其上的所有数据都丢失了。- `“Pending”` 用于尚未绑定的 PersistentVolumeClaims

.status.conditions

描述: conditions 是持久卷声明的当前状态。如果底层持久卷正在调整大小，则状态将设置为“Resizing”。
类型: 数组

.status.conditions[]

描述

PersistentVolumeClaimCondition 包含有关 pvc 状态的详细信息。

类型

对象

必需

类型
status

属性类型描述

属性	类型	描述
`lastProbeTime`	`时间`	lastProbeTime 是我们探测该状态的时间。
`lastTransitionTime`	`时间`	lastTransitionTime 是该状态从一种状态转换到另一种状态的时间。
`消息`	`字符串`	message 是指示上次转换详细信息的人类可读消息。
`原因`	`字符串`	reason 是唯一的，这应该是一个简短的、机器可理解的字符串，它给出条件上次转换的原因。如果它报告“Resizing”，则表示底层持久卷正在调整大小。
`status`	`字符串`
`类型`	`字符串`

lastProbeTime

时间

lastProbeTime 是我们探测该状态的时间。

lastTransitionTime

时间

lastTransitionTime 是该状态从一种状态转换到另一种状态的时间。

消息

字符串

message 是指示上次转换详细信息的人类可读消息。

原因

字符串

reason 是唯一的，这应该是一个简短的、机器可理解的字符串，它给出条件上次转换的原因。如果它报告“Resizing”，则表示底层持久卷正在调整大小。

status

字符串

类型

字符串

.status.modifyVolumeStatus

描述

ModifyVolumeStatus 表示 ControllerModifyVolume 操作的状态对象。

类型

对象

必需

status

属性类型描述

属性	类型	描述
`status`	`字符串`	status 是 ControllerModifyVolume 操作的状态。它可以处于以下任何状态：- Pending Pending 表示由于未满足的要求（例如，指定的 VolumeAttributesClass 不存在）而无法修改 PersistentVolumeClaim。- InProgress InProgress 表示卷正在修改中。- Infeasible Infeasible 表示 CSI 驱动程序已拒绝该请求，因为它无效。要解决此错误，需要指定有效的 VolumeAttributesClass。注意：将来可以添加新的状态。使用者应检查未知状态并适当地失败。可能的枚举值：- `“InProgress”` InProgress 表示卷正在修改中 - `“Infeasible”` Infeasible 表示 CSI 驱动程序已拒绝该请求，因为它无效。要解决此错误，需要指定有效的 VolumeAttributesClass - `“Pending”` Pending 表示由于未满足的要求（例如，指定的 VolumeAttributesClass 不存在）而无法修改 PersistentVolumeClaim
`targetVolumeAttributesClassName`	`字符串`	targetVolumeAttributesClassName 是 PVC 当前正在协调的 VolumeAttributesClass 的名称。

status

字符串

status 是 ControllerModifyVolume 操作的状态。它可以处于以下任何状态：- Pending Pending 表示由于未满足的要求（例如，指定的 VolumeAttributesClass 不存在）而无法修改 PersistentVolumeClaim。- InProgress InProgress 表示卷正在修改中。- Infeasible Infeasible 表示 CSI 驱动程序已拒绝该请求，因为它无效。要解决此错误，需要指定有效的 VolumeAttributesClass。注意：将来可以添加新的状态。使用者应检查未知状态并适当地失败。

可能的枚举值：- `“InProgress”` InProgress 表示卷正在修改中 - `“Infeasible”` Infeasible 表示 CSI 驱动程序已拒绝该请求，因为它无效。要解决此错误，需要指定有效的 VolumeAttributesClass - `“Pending”` Pending 表示由于未满足的要求（例如，指定的 VolumeAttributesClass 不存在）而无法修改 PersistentVolumeClaim

targetVolumeAttributesClassName

字符串

targetVolumeAttributesClassName 是 PVC 当前正在协调的 VolumeAttributesClass 的名称。

API 端点

提供以下 API 端点

/api/v1/persistentvolumeclaims
- GET：列出或监视 PersistentVolumeClaim 类型的对象。
/api/v1/watch/persistentvolumeclaims
- GET：监视对 PersistentVolumeClaim 列表的单个更改。已弃用：改为使用列表操作中的“watch”参数。
/api/v1/namespaces/{namespace}/persistentvolumeclaims
- DELETE：删除 PersistentVolumeClaim 集合。
- GET：列出或监视 PersistentVolumeClaim 类型的对象。
- POST：创建一个 PersistentVolumeClaim。
/api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
- GET：监视对 PersistentVolumeClaim 列表的单个更改。已弃用：改为使用列表操作中的“watch”参数。
/api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
- DELETE：删除一个 PersistentVolumeClaim。
- GET：读取指定的 PersistentVolumeClaim。
- PATCH：部分更新指定的 PersistentVolumeClaim。
- PUT：替换指定的 PersistentVolumeClaim。
/api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
- GET：监视 PersistentVolumeClaim 类型的对象的更改。已弃用：改为使用列表操作中的“watch”参数，并使用“fieldSelector”参数过滤为单个项目。
/api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
- GET：读取指定的 PersistentVolumeClaim 的状态。
- PATCH：部分更新指定的 PersistentVolumeClaim 的状态。
- PUT：替换指定的 PersistentVolumeClaim 的状态。

/api/v1/persistentvolumeclaims

HTTP 方法: GET
描述: 列出或监视 PersistentVolumeClaim 类型的对象。

表 1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PersistentVolumeClaimList` 模式
401 - 未授权	空

/api/v1/watch/persistentvolumeclaims

HTTP 方法: GET
描述: 监视对 PersistentVolumeClaim 列表的单个更改。已弃用：改为使用列表操作中的“watch”参数。

表 2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - 未授权	空

/api/v1/namespaces/{namespace}/persistentvolumeclaims

HTTP 方法: DELETE
描述: 删除 PersistentVolumeClaim 集合。

表 3. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

表 4. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 列出或监视 PersistentVolumeClaim 类型的对象。

表 5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PersistentVolumeClaimList` 模式
401 - 未授权	空

HTTP 方法: POST
描述: 创建一个 PersistentVolumeClaim。

表 6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求（POST/PUT/PATCH）中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象中静默丢弃的未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果任何未知字段将从对象中丢弃，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

表 7. 主体参数
参数	类型	描述
`主体`	`PersistentVolumeClaim` 模式

表 8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PersistentVolumeClaim` 模式
201 - 已创建	`PersistentVolumeClaim` 模式
202 - 已接受	`PersistentVolumeClaim` 模式
401 - 未授权	空

/api/v1/watch/namespaces/{namespace}/persistentvolumeclaims

HTTP 方法: GET
描述: 监视对 PersistentVolumeClaim 列表的单个更改。已弃用：改为使用列表操作中的“watch”参数。

表 9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - 未授权	空

/api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}

表 10. 全局路径参数
参数	类型	描述
`名称`	`字符串`	PersistentVolumeClaim 的名称

HTTP 方法: DELETE
描述: 删除一个 PersistentVolumeClaim。

表 11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

表 12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PersistentVolumeClaim` 模式
202 - 已接受	`PersistentVolumeClaim` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 读取指定的 PersistentVolumeClaim。

表 13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PersistentVolumeClaim` 模式
401 - 未授权	空

HTTP 方法: PATCH
描述: 部分更新指定的 PersistentVolumeClaim。

表 14. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求（POST/PUT/PATCH）中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象中静默丢弃的未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果任何未知字段将从对象中丢弃，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

表 15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PersistentVolumeClaim` 模式
201 - 已创建	`PersistentVolumeClaim` 模式
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定的 PersistentVolumeClaim。

表 16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求（POST/PUT/PATCH）中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象中静默丢弃的未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果任何未知字段将从对象中丢弃，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

表 17. 主体参数
参数	类型	描述
`主体`	`PersistentVolumeClaim` 模式

表 18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PersistentVolumeClaim` 模式
201 - 已创建	`PersistentVolumeClaim` 模式
401 - 未授权	空

/api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}

表 19. 全局路径参数
参数	类型	描述
`名称`	`字符串`	PersistentVolumeClaim 的名称

HTTP 方法: GET
描述: 监控 PersistentVolumeClaim 对象的更改。已弃用：请改用带“watch”参数的列表操作，并使用“fieldSelector”参数过滤为单个项目。

表 20. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - 未授权	空

/api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status

表 21. 全局路径参数
参数	类型	描述
`名称`	`字符串`	PersistentVolumeClaim 的名称

HTTP 方法: GET
描述: 读取指定 PersistentVolumeClaim 的状态

表 22. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PersistentVolumeClaim` 模式
401 - 未授权	空

HTTP 方法: PATCH
描述: 部分更新指定 PersistentVolumeClaim 的状态

表 23. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求（POST/PUT/PATCH）中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象中静默丢弃的未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果任何未知字段将从对象中丢弃，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

表 24. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PersistentVolumeClaim` 模式
201 - 已创建	`PersistentVolumeClaim` 模式
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定 PersistentVolumeClaim 的状态

表 25. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求（POST/PUT/PATCH）中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象中静默丢弃的未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果任何未知字段将从对象中丢弃，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

表 26. 请求体参数
参数	类型	描述
`主体`	`PersistentVolumeClaim` 模式

表 27. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PersistentVolumeClaim` 模式
201 - 已创建	`PersistentVolumeClaim` 模式
401 - 未授权	空

PersistentVolumeClaim [v1]

规格

.spec

.spec.dataSource

.spec.dataSourceRef

.spec.resources

.status

.status.conditions

.status.conditions[]

.status.modifyVolumeStatus

API 端点

/api/v1/persistentvolumeclaims

/api/v1/watch/persistentvolumeclaims

/api/v1/namespaces/{namespace}/persistentvolumeclaims

/api/v1/watch/namespaces/{namespace}/persistentvolumeclaims

/api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}

/api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}

/api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status