27.12. VolumeSnapshotContent [snapshot.storage.k8s.io/v1]

deletionPolicy

字符串

deletionPolicy 决定在删除绑定 VolumeSnapshot 时，是否应删除此 VolumeSnapshotContent 及其物理快照。支持的值有 "Retain" 和 "Delete"。"retain" 表示在底层存储系统上保留 VolumeSnapshotContent 及其物理快照。"delete" 表示在底层存储系统上会删除 VolumeSnapshotContent 及其物理快照。对于动态置备的快照，此字段将自动由 CSI 快照 sidecar 填写，并带有相应 VolumeSnapshotClass 中定义的 "DeletionPolicy" 字段。对于预先存在的快照，用户必须在创建 VolumeSnapshotContent 对象时指定此字段。必需。

driver

字符串

driver 是用于在底层存储系统上创建物理快照的 CSI 驱动程序名称。这个 MUST 与这个驱动程序的 CSI GetPluginName （）调用返回的名称相同。必需。

source

对象

source 指定快照是（或应该是）动态置备或已存在，只需要 Kubernetes 对象表示。此字段在创建后不可变。必需。

volumeSnapshotClassName

字符串

创建此快照的 VolumeSnapshotClass 的名称（或是）请注意，在置备后，VolumeSnapshotClass 可能会使用不同的一组值删除或重新创建，因此不应引用后创建快照。

volumeSnapshotRef

对象

volumeSnapshotRef 指定这个 VolumeSnapshotContent 对象绑定到的 VolumeSnapshot 对象。VolumeSnapshot.Spec.VolumeSnapshotContentName 字段必须引用这个 VolumeSnapshotContent 的名称，以便双向绑定有效。对于预先存在的 VolumeSnapshotContent 对象，为绑定而提供 VolumeSnapshot 对象的名称和命名空间。此字段在创建后不可变。必需。

snapshotHandle

字符串

snapshotHandle 指定创建 Kubernetes 对象的底层存储系统上预先存在的快照的 CSI "snapshot_id"。此字段不可变。

volumeHandle

字符串

volumeHandle 指定要从中动态获取快照的卷的 CSI "volume_id"。此字段不可变。

apiVersion

字符串

引用的 API 版本。

fieldPath

字符串

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

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

creationTime

整数

creationTime 是底层存储系统执行时点快照的时间戳。在动态快照创建情形中，这个字段将由 CSI 快照 sidecar 填写，并带有从 CSI "CreateSnapshot" gRPC 调用返回的 "creation_time" 值。对于预先存在的快照，如果驱动程序支持，此字段将使用从 CSI "ListSnapshots" gRPC 调用返回的"creation_time"值填充。如果没有指定，这表示创建时间未知。此字段的格式是 Unix 纳秒时间，编码为 int64。在 Unix 上，命令 date +%s%N 从 1970-01-01 00:00:00 UTC 开始以纳秒返回当前时间。

错误

对象

错误是快照创建过程中最后一次观察到的错误（若有）。重试成功后，这个错误字段将被清除。

readyToUse

布尔值

readyToUse 表示快照是否准备好用于恢复卷。在动态快照创建情形中，CSI 快照 sidecar 将填写此字段，并带有从 CSI "CreateSnapshot" gRPC 调用返回的 "ready_to_use" 值。对于预先存在的快照，此字段将填写自 CSI "ListSnapshots" gRPC 调用返回的"ready_to_use"值（如果驱动程序支持），否则此字段将被设置为 "True"。如果没有指定，这意味着快照就绪状态未知。

restoreSize

整数

restoreSize 代表快照的完整大小（以字节为单位）。在动态快照创建情形中，这个字段将由 CSI 快照ter sidecar 填写，并带有从 CSI "CreateSnapshot" gRPC 调用返回的 "size_bytes" 值。对于预先存在的快照，如果驱动程序支持，此字段将使用从 CSI "ListSnapshots" gRPC 调用返回的"size_bytes"值填充。当从这个快照恢复卷时，如果指定，则卷的大小不能小于 restoreSize，否则恢复将失败。如果没有指定，这表示大小未知。

snapshotHandle

字符串

snapshotHandle 是底层存储系统上快照的 CSI "snapshot_id"。如果没有指定，这表示动态快照创建失败，或者它仍在进行中。

message

字符串

message 是一个字符串，如果指定，在快照创建过程中详细说明遇到的错误。注意：消息可以被记录，不应包含敏感信息。

time

字符串

当遇到错误时，时间戳是时间戳。

pretty

字符串

如果 'true'，则输出被用户友善。

allowWatchBookmarks

布尔值

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

继续

字符串

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

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

fieldSelector

字符串

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

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值，以检索下一个结果集。在过滤所有请求的对象时，设置限制可能会返回比请求的项目数量少（最多为零项），客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数，并将返回所有可用的结果。如果指定了限制，并且 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。

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间，无论任何活动或不活跃。

watch

布尔值

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

200 - OK

Status_v2 模式

401 - Unauthorized

空

allowWatchBookmarks

布尔值

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

继续

字符串

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

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

fieldSelector

字符串

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

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值，以检索下一个结果集。在过滤所有请求的对象时，设置限制可能会返回比请求的项目数量少（最多为零项），客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数，并将返回所有可用的结果。如果指定了限制，并且 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。

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间，无论任何活动或不活跃。

watch

布尔值

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

200 - OK

VolumeSnapshotContentList schema

401 - Unauthorized

空

dryRun

字符串

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

fieldManager

字符串

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

正文（body）

VolumeSnapshotContent schema

200 - OK

VolumeSnapshotContent schema

201 - Created

VolumeSnapshotContent schema

202 - Accepted

VolumeSnapshotContent schema

401 - Unauthorized

空

name

字符串

VolumeSnapshotContent 的名称

pretty

字符串

如果 'true'，则输出被用户友善。

dryRun

字符串

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

gracePeriodSeconds

整数

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

orphanDependents

布尔值

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

propagationPolicy

字符串

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

正文（body）

DeleteOptions_v2 schema

200 - OK

Status_v2 模式

202 - Accepted

Status_v2 模式

401 - Unauthorized

空

resourceVersion

字符串

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

默认为未设置

200 - OK

VolumeSnapshotContent schema

401 - Unauthorized

空

dryRun

字符串

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

fieldManager

字符串

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

正文（body）

Patch 模式

200 - OK

VolumeSnapshotContent schema

401 - Unauthorized

空

dryRun

字符串

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

fieldManager

字符串

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

正文（body）

VolumeSnapshotContent schema

200 - OK

VolumeSnapshotContent schema

201 - Created

VolumeSnapshotContent schema

401 - Unauthorized

空

name

字符串

VolumeSnapshotContent 的名称

pretty

字符串

如果 'true'，则输出被用户友善。

resourceVersion

字符串

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

默认为未设置

200 - OK

VolumeSnapshotContent schema

401 - Unauthorized

空

dryRun

字符串

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

fieldManager

字符串

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

正文（body）

Patch 模式

200 - OK

VolumeSnapshotContent schema

401 - Unauthorized

空

dryRun

字符串

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

fieldManager

字符串

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

正文（body）

VolumeSnapshotContent schema

200 - OK

VolumeSnapshotContent schema

201 - Created

VolumeSnapshotContent schema

401 - Unauthorized

空