27.4. CSIStorageCapacity [storage.k8s.io/v1]

描述

CSIStorageCapacity 存储一个 CSI GetCapacity 调用的结果。对于给定的 StorageClass，这描述了特定拓扑片段中的可用容量。在考虑在什么位置来实例化新的 PersistentVolume 时，可以使用它。

例如，这可表达类似： - StorageClass "standard" 在 "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" 中可用的 "10 GiB" 带有 "kubernetes.io/hostname=knode-abc123"

以下三种情况都表示，没有容量可用于特定的组合： - 没有合适的拓扑和存储类名称的对象 - 这种对象存在，但容量未设置 - 此类对象存在，但存在容量为零。

这些对象的生成者可以决定哪个方法更合适。

当 CSI 驱动程序选择使用 CSIDriverSpec.StorageCapacity 进行容量感知调度时，kube-scheduler 会消耗它们。调度程序将 MaximumVolumeSize 与请求的待处理卷的大小进行比较，以过滤掉不适合的节点。如果未设置 MaximumVolumeSize，它会回退到与不太精确容量的比较。如果也未设置，调度程序会假定容量不足，并尝试某些其他节点。

类型

object

必填

storageClassName

27.4.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`capacity`	`数量`	capacity 是 CSI 驱动程序为其 GetCapacityRequest 中报告的值，其带有与上一字段匹配的 topology 和 parameters。目前，语义(CSI spec 1.2)定义为：可用于置备卷的存储的可用容量（以字节为单位）。如果没有设置，则信息当前不可用。
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`maximumVolumeSize`	`数量`	maximumVolumeSize 是 CSI 驱动程序在 GetCapacityResponse 中报告的值，用于带有与上一字段匹配的 GetCapacityRequest 和参数。这是定义，因为 CSI spec 1.4.0 是可在 CreateVolumeRequest.capacity_range.required_bytes 字段中使用的最大大小来创建与 GetCapacityRequest 中参数相同的卷。Kubernetes API 中对应的值为 ResourceRequirements.Requests 在卷声明中。
`metadata`	`ObjectMeta`	标准对象元数据。名称没有特定含义。它必须是 DNS 子域（允许 253 个字符）。为确保集群中没有与其他 CSI 驱动程序冲突，建议使用 csisc-<uuid>、生成的名称或以唯一 CSI 驱动程序名称结尾的反向域名。对象是 namespaced。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`nodeTopology`	`labelSelector`	NodeTopology 定义哪些节点有权访问报告容量的存储。如果没有设置，则无法从集群中的任何节点访问存储。如果为空，可从所有节点访问存储。此字段不可变。
`storageClassName`	`string`	storageClassName 代表所报告容量应用到的 StorageClass 名称。它必须满足与 StorageClass 对象的名称相同的要求（非空，DNS 子域）。如果该对象不再存在，CSIStorageCapacity 对象已过时，应该通过其创建者删除。此字段不可变。

27.4.2. API 端点

可用的 API 端点如下：

/apis/storage.k8s.io/v1/csistoragecapacities
- GET: 列出或监视类型为 CSIStorageCapacity 的对象
/apis/storage.k8s.io/v1/watch/csistoragecapacities
- GET: 观察单个对 CSIStorageCapacity 列表的更改。已弃用：使用带列表操作的 'watch' 参数。
/apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities
- DELETE: 删除 CSIStorageCapacity 集合
- GET: 列出或监视类型为 CSIStorageCapacity 的对象
- POST ：创建一个 CSIStorageCapacity
/apis/storage.k8s.io/v1/watch/namespaces/{namespace}/csistoragecapacities
- GET: 观察单个对 CSIStorageCapacity 列表的更改。已弃用：使用带列表操作的 'watch' 参数。
/apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}
- DELETE: 删除 CSIStorageCapacity
- GET ：读取指定的 CSIStorageCapacity
- PATCH: 部分更新指定的 CSIStorageCapacity
- PUT ：替换指定的 CSIStorageCapacity
/apis/storage.k8s.io/v1/watch/namespaces/{namespace}/csistoragecapacities/{name}
- GET: 观察对类型为 CSIStorageCapacity 的对象的更改。已弃用：使用带有 list 操作的 'watch' 参数，而是过滤为带有 'fieldSelector' 参数的单个项目。

27.4.2.1. /apis/storage.k8s.io/v1/csistoragecapacities

表 27.53. 全局查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值，以检索下一组结果。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion'，这会被解释为 "consistent read"，当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。如果 'resourceVersion=""' 或 'resourceVersion="0"' （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

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

表 27.54. HTTP 响应
HTTP 代码	响应正文
200 - OK	`CSIStorageCapacityList` schema
401 - Unauthorized	空

27.4.2.2. /apis/storage.k8s.io/v1/watch/csistoragecapacities

表 27.55. 全局查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值，以检索下一组结果。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion'，这会被解释为 "consistent read"，当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。如果 'resourceVersion=""' 或 'resourceVersion="0"' （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

HTTP 方法: GET
描述: 观察单个对 CSIStorageCapacity 列表的更改。已弃用：使用带列表操作的 'watch' 参数。

表 27.56. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - Unauthorized	空

27.4.2.3. /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities

表 27.57. 全局路径参数
参数	类型	描述
`namespace`	`字符串`	对象名称和身份验证范围，如团队（team）和项目（project）

表 27.58. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

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

表 27.59. 查询参数
参数	类型	描述
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值，以检索下一组结果。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 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 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion'，这会被解释为 "consistent read"，当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。如果 'resourceVersion=""' 或 'resourceVersion="0"' （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。

表 27.60. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

表 27.61. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

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

表 27.62. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值，以检索下一组结果。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion'，这会被解释为 "consistent read"，当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。如果 'resourceVersion=""' 或 'resourceVersion="0"' （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

表 27.63. HTTP 响应
HTTP 代码	响应正文
200 - OK	`CSIStorageCapacityList` schema
401 - Unauthorized	空

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

表 27.64. 查询参数
参数	类型	描述
`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 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 27.65. 主体参数
参数	类型	描述
`正文（body）`	`CSIStorageCapacity` 模式

表 27.66. HTTP 响应
HTTP 代码	响应正文
200 - OK	`CSIStorageCapacity` 模式
201 - Created	`CSIStorageCapacity` 模式
202 - Accepted	`CSIStorageCapacity` 模式
401 - Unauthorized	空

27.4.2.4. /apis/storage.k8s.io/v1/watch/namespaces/{namespace}/csistoragecapacities

表 27.67. 全局路径参数
参数	类型	描述
`namespace`	`字符串`	对象名称和身份验证范围，如团队（team）和项目（project）

表 27.68. 全局查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值，以检索下一组结果。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion'，这会被解释为 "consistent read"，当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。如果 'resourceVersion=""' 或 'resourceVersion="0"' （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

HTTP 方法: GET
描述: 观察单个对 CSIStorageCapacity 列表的更改。已弃用：使用带列表操作的 'watch' 参数。

表 27.69. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - Unauthorized	空

27.4.2.5. /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}

表 27.70. 全局路径参数
参数	类型	描述
`name`	`string`	CSIStorageCapacity 的名称
`namespace`	`字符串`	对象名称和身份验证范围，如团队（team）和项目（project）

表 27.71. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 CSIStorageCapacity

表 27.72. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

表 27.73. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

表 27.74. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 CSIStorageCapacity

表 27.75. HTTP 响应
HTTP 代码	响应正文
200 - OK	`CSIStorageCapacity` 模式
401 - Unauthorized	空

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

表 27.76. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段，但对非应用补丁类型(JsonPatch、MergePatch、MergePatch)是可选的。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。
`force`	`布尔值`	强制要"强制"应用请求。这意味着用户将重新分配由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

表 27.77. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

表 27.78. HTTP 响应
HTTP 代码	响应正文
200 - OK	`CSIStorageCapacity` 模式
201 - Created	`CSIStorageCapacity` 模式
401 - Unauthorized	空

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

表 27.79. 查询参数
参数	类型	描述
`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 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 27.80. 主体参数
参数	类型	描述
`正文（body）`	`CSIStorageCapacity` 模式

表 27.81. HTTP 响应
HTTP 代码	响应正文
200 - OK	`CSIStorageCapacity` 模式
201 - Created	`CSIStorageCapacity` 模式
401 - Unauthorized	空

27.4.2.6. /apis/storage.k8s.io/v1/watch/namespaces/{namespace}/csistoragecapacities/{name}

表 27.82. 全局路径参数
参数	类型	描述
`name`	`string`	CSIStorageCapacity 的名称
`namespace`	`字符串`	对象名称和身份验证范围，如团队（team）和项目（project）

表 27.83. 全局查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设为可用于同一初始查询的值，以检索下一组结果。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`sendInitialEvents`	`布尔值`	'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，观察流将以复合事件开头，以生成集合中对象的当前状态。发送完所有这些事件后，将发送合成"Bookmark"事件。书签将报告与对象集合对应的 ResourceVersion (RV)，并使用 '"k8s.io/initial-events-end": "true" 注解进行标记。之后，监视流将照常进行，从而向监视的对象发送与更改对应的监视事件（按 RV 排序）。当设置 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。watch 请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 被解释为"data"作为提供的 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion'。如果未设置 'resourceVersion'，这会被解释为 "consistent read"，当请求开始处理时至少会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或未设置 Invalid 错误。如果 'resourceVersion=""' 或 'resourceVersion="0"' （出于向后兼容原因）和 false，则默认为 true。
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

HTTP 方法: GET
描述: 观察对类型为 CSIStorageCapacity 的对象的更改。已弃用：使用带有 list 操作的 'watch' 参数，而是过滤成带有 'fieldSelector' 参数的单个项目。

表 27.84. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - Unauthorized	空

27.4. CSIStorageCapacity [storage.k8s.io/v1]

27.4.1. 规格

27.4.2. API 端点

27.4.2.1. /apis/storage.k8s.io/v1/csistoragecapacities

27.4.2.2. /apis/storage.k8s.io/v1/watch/csistoragecapacities

27.4.2.3. /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities

27.4.2.4. /apis/storage.k8s.io/v1/watch/namespaces/{namespace}/csistoragecapacities

27.4.2.5. /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}

27.4.2.6. /apis/storage.k8s.io/v1/watch/namespaces/{namespace}/csistoragecapacities/{name}

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Red Hat legal and privacy links

Red Hat legal and privacy links