VolumeSnapshotClass [snapshot.storage.k8s.io/v1] - 存储 API | API 参考 | OpenShift Container Platform 4.17

规范
API端点
- /apis/snapshot.storage.k8s.io/v1/volumesnapshotclasses
- /apis/snapshot.storage.k8s.io/v1/volumesnapshotclasses/{name}

描述

VolumeSnapshotClass指定底层存储系统创建卷快照时使用的参数。通过在VolumeSnapshot对象中指定其名称来使用特定的VolumeSnapshotClass。VolumeSnapshotClasses是非命名空间的。

类型

对象

必需

deletionPolicy
driver

规范

属性类型描述

属性	类型	描述
`apiVersion`	`字符串`	APIVersion定义了对象的此表示形式的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`deletionPolicy`	`字符串`	deletionPolicy确定当绑定其VolumeSnapshot的VolumeSnapshotContent被删除时，通过VolumeSnapshotClass创建的VolumeSnapshotContent是否应被删除。支持的值为“Retain”和“Delete”。“Retain”表示VolumeSnapshotContent及其在底层存储系统上的物理快照将被保留。“Delete”表示VolumeSnapshotContent及其在底层存储系统上的物理快照将被删除。必需。
`driver`	`字符串`	driver是处理此VolumeSnapshotClass的存储驱动程序的名称。必需。
`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
`parameters`	`对象（字符串）`	parameters是一个键值映射，其中包含用于创建快照的特定于存储驱动程序的参数。这些值对Kubernetes来说是不透明的。

apiVersion

字符串

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

deletionPolicy

字符串

deletionPolicy确定当绑定其VolumeSnapshot的VolumeSnapshotContent被删除时，通过VolumeSnapshotClass创建的VolumeSnapshotContent是否应被删除。支持的值为“Retain”和“Delete”。“Retain”表示VolumeSnapshotContent及其在底层存储系统上的物理快照将被保留。“Delete”表示VolumeSnapshotContent及其在底层存储系统上的物理快照将被删除。必需。

driver

字符串

driver是处理此VolumeSnapshotClass的存储驱动程序的名称。必需。

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

parameters

对象（字符串）

parameters是一个键值映射，其中包含用于创建快照的特定于存储驱动程序的参数。这些值对Kubernetes来说是不透明的。

API端点

提供以下API端点

/apis/snapshot.storage.k8s.io/v1/volumesnapshotclasses
- DELETE：删除VolumeSnapshotClass集合
- GET：列出VolumeSnapshotClass类型的对象
- POST：创建一个VolumeSnapshotClass
/apis/snapshot.storage.k8s.io/v1/volumesnapshotclasses/{name}
- DELETE：删除一个VolumeSnapshotClass
- GET：读取指定的VolumeSnapshotClass
- PATCH：部分更新指定的VolumeSnapshotClass
- PUT：替换指定的VolumeSnapshotClass

/apis/snapshot.storage.k8s.io/v1/volumesnapshotclasses

HTTP方法: DELETE
描述: 删除VolumeSnapshotClass集合

表1. HTTP响应
HTTP代码	响应体
200 - OK	`Status`模式
401 - 未授权	空

HTTP方法: GET
描述: 列出VolumeSnapshotClass类型的对象

表2. HTTP响应
HTTP代码	响应体
200 - OK	`VolumeSnapshotClassList`模式
401 - 未授权	空

HTTP方法: POST
描述: 创建一个VolumeSnapshotClass

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

表4. 主体参数
参数	类型	描述
`body`	`VolumeSnapshotClass`模式

表5. HTTP响应
HTTP代码	响应体
200 - OK	`VolumeSnapshotClass`模式
201 - 已创建	`VolumeSnapshotClass`模式
202 - 已接受	`VolumeSnapshotClass`模式
401 - 未授权	空

/apis/snapshot.storage.k8s.io/v1/volumesnapshotclasses/{name}

表6. 全局路径参数
参数	类型	描述
`name`	`字符串`	VolumeSnapshotClass的名称

HTTP方法: DELETE
描述: 删除一个VolumeSnapshotClass

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

表8. HTTP响应
HTTP代码	响应体
200 - OK	`Status`模式
202 - 已接受	`Status`模式
401 - 未授权	空

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

表 9. HTTP 响应
HTTP代码	响应体
200 - OK	`VolumeSnapshotClass`模式
401 - 未授权	空

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

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

表 11. HTTP 响应
HTTP代码	响应体
200 - OK	`VolumeSnapshotClass`模式
401 - 未授权	空

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

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

表 13. 请求体参数
参数	类型	描述
`body`	`VolumeSnapshotClass`模式

表 14. HTTP 响应
HTTP代码	响应体
200 - OK	`VolumeSnapshotClass`模式
201 - 已创建	`VolumeSnapshotClass`模式
401 - 未授权	空