OpenShift 文档正在迁移，很快将只能在 docs.redhat.com（所有 Red Hat 产品文档的所在地）访问。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

StorageClass [storage.k8s.io/v1]

描述

StorageClass 描述用于可以动态供应 PersistentVolume 的存储类别参数。

StorageClass是非命名空间的；根据 etcd 的存储类名称位于 ObjectMeta.Name 中。

类型

对象

必需

  • provisioner

规范

属性 类型 描述

allowVolumeExpansion

布尔值

allowVolumeExpansion 显示存储类是否允许卷扩展。

allowedTopologies

数组 (TopologySelectorTerm)

allowedTopologies 限制可以动态供应卷的节点拓扑。每个卷插件都定义其自身支持的拓扑规范。空 TopologySelectorTerm 列表表示没有拓扑限制。此字段仅由启用 VolumeScheduling 功能的服务器认可。

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

mountOptions

数组 (字符串)

mountOptions 控制此存储类的动态供应 PersistentVolume 的 mountOptions。例如 ["ro"，"soft"]。未经验证 - 如果一个无效，则 PV 的安装将简单失败。

parameters

对象 (字符串)

parameters 包含应该创建此存储类卷的供应程序的参数。

provisioner

字符串

provisioner 指示供应程序的类型。

reclaimPolicy

字符串

reclaimPolicy 控制此存储类的动态供应 PersistentVolume 的 reclaimPolicy。默认为 Delete。

可能的枚举值：- "Delete" 表示卷将在从其声明中释放时从 Kubernetes 中删除。卷插件必须支持删除。- "Recycle" 表示卷将在从其声明中释放时循环利用回未绑定持久卷的池中。卷插件必须支持回收。- "Retain" 表示卷将保留在其当前阶段（已释放），以便管理员手动回收。默认策略为 Retain。

volumeBindingMode

字符串

volumeBindingMode 指示如何预配和绑定 PersistentVolumeClaims。未设置时，使用 VolumeBindingImmediate。此字段仅由启用 VolumeScheduling 功能的服务器认可。

可能的枚举值：- "Immediate" 表示应立即预配和绑定 PersistentVolumeClaims。这是默认模式。- "WaitForFirstConsumer" 表示只有在创建第一个引用 PeristentVolumeClaim 的 Pod 后，才应预配和绑定 PersistentVolumeClaims。卷预配和绑定将在 Pod 调度期间发生。

API 端点

提供以下 API 端点

  • /apis/storage.k8s.io/v1/storageclasses

    • DELETE：删除 StorageClass 集合

    • GET：列出或监视 StorageClass 对象

    • POST：创建 StorageClass

  • /apis/storage.k8s.io/v1/watch/storageclasses

    • GET：监视 StorageClass 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。

  • /apis/storage.k8s.io/v1/storageclasses/{name}

    • DELETE：删除 StorageClass

    • GET：读取指定的 StorageClass

    • PATCH：部分更新指定的 StorageClass

    • PUT：替换指定的 StorageClass

  • /apis/storage.k8s.io/v1/watch/storageclasses/{name}

    • GET：监视 StorageClass 对象的更改。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数将其过滤为单个项目。

/apis/storage.k8s.io/v1/storageclasses

HTTP 方法

DELETE

描述

删除 StorageClass 集合

表 1. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
表 2. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出或监视 StorageClass 对象

表 3. HTTP 响应
HTTP 代码 响应体

200 - OK

StorageClassList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建 StorageClass

表 4. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略对象中静默删除的任何未知字段，并将忽略解码器遇到的除最后一个重复字段之外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者如果存在任何重复字段，这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 5. 请求体参数
参数 类型 描述

body

StorageClass 模式
表 6. HTTP 响应
HTTP 代码 响应体

200 - OK

StorageClass 模式

201 - 已创建

StorageClass 模式

202 - 已接受

StorageClass 模式

401 - 未授权

空

/apis/storage.k8s.io/v1/watch/storageclasses

HTTP 方法

GET

描述

监视 StorageClass 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。

表 7. HTTP 响应
HTTP 代码 响应体

200 - OK

WatchEvent 模式

401 - 未授权

空

/apis/storage.k8s.io/v1/storageclasses/{name}

表 8. 全局路径参数
参数 类型 描述

name

字符串

StorageClass 的名称
HTTP 方法

DELETE

描述

删除 StorageClass

表 9. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
表 10. HTTP 响应
HTTP 代码 响应体

200 - OK

StorageClass 模式

202 - 已接受

StorageClass 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 StorageClass

表 11. HTTP 响应
HTTP 代码 响应体

200 - OK

StorageClass 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 StorageClass

表 12. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

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

200 - OK

StorageClass 模式

201 - 已创建

StorageClass 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 StorageClass

表 14. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略对象中静默删除的任何未知字段，并将忽略解码器遇到的除最后一个重复字段之外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者如果存在任何重复字段，这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 15. 请求体参数
参数 类型 描述

body

StorageClass 模式
表 16. HTTP 响应
HTTP 代码 响应体

200 - OK

StorageClass 模式

201 - 已创建

StorageClass 模式

401 - 未授权

空

/apis/storage.k8s.io/v1/watch/storageclasses/{name}

表 17. 全局路径参数
参数 类型 描述

name

字符串

StorageClass 的名称
HTTP 方法

GET

描述

监视 StorageClass 对象的更改。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数将其过滤为单个项目。

表 18. HTTP 响应
HTTP 代码 响应体

200 - OK

WatchEvent 模式

401 - 未授权

空