调度和配额 API


OpenShift Container Platform 4.14

调度和配额 API 的参考指南

Red Hat OpenShift Documentation Team

摘要

本文档描述了 OpenShift Container Platform 调度和配额 API 对象及其详细规格。

第 1 章 调度和配额 API

1.1. AppliedClusterResourceQuota [quota.openshift.io/v1]

描述

项目范围内的 AppliedClusterResourceQuota 镜像 ClusterResourceQuota,用于投射到项目中。它允许 project-admin 知道哪些 ClusterResourceQuotas 应用到其项目及其相关使用量。

兼容性级别 1:在主发行版本中至少提供 12 个月或 3 个次版本(以更长的时间为准)。

类型
对象

1.2. ClusterResourceQuota [quota.openshift.io/v1]

描述
ClusterResourceQuota 镜像在集群范围内的 ResourceQuota。此对象可轻松转换为 synthetic ResourceQuota 对象,以允许重新使用配额评估。兼容性级别 1:在主发行版本中至少提供 12 个月或 3 个次版本(以更长的时间为准)。
类型
object

1.3. FlowSchema [flowcontrol.apiserver.k8s.io/v1beta3]

描述
FlowSchema 定义一组流的 schema。请注意,流由一组带有类似属性的入站 API 请求组成,并通过一对字符串来标识: FlowSchema 的名称和一个 "flow distinguisher"。
类型
对象

1.4. LimitRange [v1]

描述
LimitRange 为命名空间中的每种资源设置资源使用量限制。
类型
对象

1.5. PriorityClass [scheduling.k8s.io/v1]

描述
PriorityClass 定义从优先级类名称到优先级整数值的映射。该值可以是任何有效的整数。
类型
object

1.6. PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1beta3]

描述
priorityLevelConfiguration 代表优先级级别的配置。
类型
对象

1.7. ResourceQuota [v1]

描述
ResourceQuota 设置每个命名空间的聚合配额限制
类型
对象

第 2 章 AppliedClusterResourceQuota [quota.openshift.io/v1]

描述

项目范围内的 AppliedClusterResourceQuota 镜像 ClusterResourceQuota,用于投射到项目中。它允许 project-admin 知道哪些 ClusterResourceQuotas 应用到其项目及其相关使用量。

兼容性级别 1:在主发行版本中至少提供 12 个月或 3 个次版本(以更长的时间为准)。

类型
object
必填
  • metadata
  • spec

2.1. 规格

属性类型描述

apiVersion

字符串

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

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

metadata 是标准对象的元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

ClusterResourceQuotaSpec 定义所需的配额限制

status

对象

ClusterResourceQuotaStatus 定义实际强制的配额及其当前使用情况

2.1.1. .spec

描述
ClusterResourceQuotaSpec 定义所需的配额限制
类型
object
必填
  • selector
  • quota
属性类型描述

quota

ResourceQuotaSpec

quota 定义所需的配额

selector

对象

ClusterResourceQuotaSelector 用于选择项目。至少一个 LabelSelector 或 AnnotationSelector 必须存在。如果只有一个,则是唯一选择条件。如果同时指定了这两者,则项目必须匹配这两个限制。

2.1.2. .spec.selector

描述
ClusterResourceQuotaSelector 用于选择项目。至少一个 LabelSelector 或 AnnotationSelector 必须存在。如果只有一个,则是唯一选择条件。如果同时指定了这两者,则项目必须匹配这两个限制。
类型
object
属性类型描述

annotations

对象(字符串)

AnnotationSelector 用于通过注解来选择项目。

labels

LabelSelector

labelSelector 用于根据标签选择项目。

2.1.3. .status

描述
ClusterResourceQuotaStatus 定义实际强制的配额及其当前使用情况
类型
object
必填
  • total
属性类型描述

命名空间

array

命名空间对项目的使用情况进行分片。此部门允许在单个项目内快速解析删除协调,而无需在所有项目中重新计算。这可用于拉取给定项目的 deltas。

namespaces[]

对象

ResourceQuotaStatusByNamespace 提供特定项目的状态

total

ResourceQuotaStatus

total 定义所有项目的实际强制配额及其当前使用量

2.1.4. .status.namespaces

描述
命名空间对项目的使用情况进行分片。此部门允许在单个项目内快速解析删除协调,而无需在所有项目中重新计算。这可用于拉取给定项目的 deltas。
类型
array

2.1.5. .status.namespaces[]

描述
ResourceQuotaStatusByNamespace 提供特定项目的状态
类型
object
必填
  • namespace
  • status
属性类型描述

namespace

字符串

此状态应用到的项目的命名空间

status

ResourceQuotaStatus

Status 指明此项目消耗的资源数量

2.2. API 端点

可用的 API 端点如下:

  • /apis/quota.openshift.io/v1/appliedclusterresourcequotas

    • GET: 列出类型为 AppliedClusterResourceQuota 的对象
  • /apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas

    • GET: 列出类型为 AppliedClusterResourceQuota 的对象
  • /apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas/{name}

    • GET :读取指定的 AppliedClusterResourceQuota

2.2.1. /apis/quota.openshift.io/v1/appliedclusterresourcequotas

表 2.1. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
列出 AppliedClusterResourceQuota 类型的对象
表 2.2. HTTP 响应
HTTP 代码响应正文

200 - OK

AppliedClusterResourceQuotaList schema

401 - Unauthorized

2.2.2. /apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas

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

namespace

字符串

对象名称和身份验证范围,如团队(team)和项目(project)

表 2.4. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
列出 AppliedClusterResourceQuota 类型的对象
表 2.5. HTTP 响应
HTTP 代码响应正文

200 - OK

AppliedClusterResourceQuotaList schema

401 - Unauthorized

2.2.3. /apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas/{name}

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

name

字符串

AppliedClusterResourceQuota 的名称

namespace

字符串

对象名称和身份验证范围,如团队(team)和项目(project)

表 2.7. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
GET
描述
读取指定的 AppliedClusterResourceQuota
表 2.8. HTTP 响应
HTTP 代码响应正文

200 - OK

AppliedClusterResourceQuota schema

401 - Unauthorized

第 3 章 ClusterResourceQuota [quota.openshift.io/v1]

描述
ClusterResourceQuota 镜像在集群范围内的 ResourceQuota。此对象可轻松转换为 synthetic ResourceQuota 对象,以允许重新使用配额评估。兼容性级别 1:在主发行版本中至少提供 12 个月或 3 个次版本(以更长的时间为准)。
类型
object
必填
  • metadata
  • spec

3.1. 规格

属性类型描述

apiVersion

字符串

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

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: 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

对象

spec 定义所需的配额

status

对象

Status 定义实际强制的配额及其当前使用情况

3.1.1. .spec

描述
spec 定义所需的配额
类型
object
必填
  • quota
  • selector
属性类型描述

quota

对象

quota 定义所需的配额

selector

对象

selector 是用来匹配项目的选择器。它应该只选择几十个规模的活动项目(尽管它可以选择更多活跃的项目)。这些项目将通过此资源继续创建对象。

3.1.2. .spec.quota

描述
quota 定义所需的配额
类型
object
属性类型描述

hard

integer-or-string

hard 是每个命名资源所需的硬限制集合。更多信息: https://kubernetes.io/docs/concepts/policy/resource-quotas/

scopeSelector

对象

scopeSelector 也是一个过滤器集合,如范围,它必须与配额跟踪的每个对象匹配,但使用 ScopeSelectorOperator 与可能的值结合使用。要匹配的资源,两个范围和 scopeSelector (在 spec 中指定)必须匹配。

scopes

数组(字符串)

一组过滤器,必须与配额跟踪的每个对象匹配。如果未指定,则配额与所有对象匹配。

3.1.3. .spec.quota.scopeSelector

描述
scopeSelector 也是一个过滤器集合,如范围,它必须与配额跟踪的每个对象匹配,但使用 ScopeSelectorOperator 与可能的值结合使用。要匹配的资源,两个范围和 scopeSelector (在 spec 中指定)必须匹配。
类型
object
属性类型描述

matchExpressions

array

根据资源范围划分的范围选择器要求列表。

matchExpressions[]

对象

scoped-resource 选择器要求是一个选择器,其中包含与范围名称和值相关的值、范围名称和 Operator。

3.1.4. .spec.quota.scopeSelector.matchExpressions

描述
根据资源范围划分的范围选择器要求列表。
类型
array

3.1.5. .spec.quota.scopeSelector.matchExpressions[]

描述
scoped-resource 选择器要求是一个选择器,其中包含与范围名称和值相关的值、范围名称和 Operator。
类型
object
必填
  • operator
  • scopeName
属性类型描述

operator

字符串

代表范围与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。

scopeName

字符串

选择器应用到的范围的名称。

数组(字符串)

字符串值数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

3.1.6. .spec.selector

描述
selector 是用来匹配项目的选择器。它应该只选择几十个规模的活动项目(尽管它可以选择更多活跃的项目)。这些项目将通过此资源继续创建对象。
类型
object
属性类型描述

annotations

undefined (字符串)

AnnotationSelector 用于通过注解来选择项目。

labels

``

labelSelector 用于根据标签选择项目。

3.1.7. .status

描述
Status 定义实际强制的配额及其当前使用情况
类型
object
必填
  • total
属性类型描述

命名空间

``

命名空间对项目的使用情况进行分片。此部门允许在单个项目内快速解析删除协调,而无需在所有项目中重新计算。这可用于拉取给定项目的 deltas。

total

对象

total 定义所有项目的实际强制配额及其当前使用量

3.1.8. .status.total

描述
total 定义所有项目的实际强制配额及其当前使用量
类型
object
属性类型描述

hard

integer-or-string

hard 是每个命名资源的强制硬限制集。更多信息: https://kubernetes.io/docs/concepts/policy/resource-quotas/

使用的

integer-or-string

使用是命名空间中资源的总使用情况。

3.2. API 端点

可用的 API 端点如下:

  • /apis/quota.openshift.io/v1/clusterresourcequotas

    • DELETE :删除 ClusterResourceQuota 集合
    • GET: 列出 ClusterResourceQuota 类型的对象
    • POST :创建 ClusterResourceQuota
  • /apis/quota.openshift.io/v1/watch/clusterresourcequotas

    • GET: 观察单个更改 ClusterResourceQuota 列表。已弃用:改为使用 'watch' 参数及列表操作。
  • /apis/quota.openshift.io/v1/clusterresourcequotas/{name}

    • DELETE :删除 ClusterResourceQuota
    • GET :读取指定的 ClusterResourceQuota
    • PATCH: 部分更新指定的 ClusterResourceQuota
    • PUT :替换指定的 ClusterResourceQuota
  • /apis/quota.openshift.io/v1/watch/clusterresourcequotas/{name}

    • GET: 观察对类型为 ClusterResourceQuota 的对象的更改。已弃用:使用带有 list 操作的 'watch' 参数,而是过滤成带有 'fieldSelector' 参数的单个项目。
  • /apis/quota.openshift.io/v1/clusterresourcequotas/{name}/status

    • GET :指定 ClusterResourceQuota 的读取状态
    • PATCH: 部分更新指定 ClusterResourceQuota 的状态
    • PUT :替换指定 ClusterResourceQuota 的状态

3.2.1. /apis/quota.openshift.io/v1/clusterresourcequotas

表 3.1. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
DELETE
描述
删除 ClusterResourceQuota 集合
表 3.2. 查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

表 3.3. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出 ClusterResourceQuota 类型的对象
表 3.4. 查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

表 3.5. HTTP 响应
HTTP 代码响应正文

200 - OK

ClusterResourceQuotaList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建 ClusterResourceQuota
表 3.6. 查询参数
参数类型描述

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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 3.7. 主体参数
参数类型描述

正文(body)

ClusterResourceQuota 模式

 
表 3.8. HTTP 响应
HTTP 代码响应正文

200 - OK

ClusterResourceQuota 模式

201 - Created

ClusterResourceQuota 模式

202 - Accepted

ClusterResourceQuota 模式

401 - Unauthorized

3.2.2. /apis/quota.openshift.io/v1/watch/clusterresourcequotas

表 3.9. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
观察单个对 ClusterResourceQuota 列表的更改。已弃用:改为使用 'watch' 参数及列表操作。
表 3.10. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

3.2.3. /apis/quota.openshift.io/v1/clusterresourcequotas/{name}

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

name

字符串

ClusterResourceQuota 的名称

表 3.12. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
DELETE
描述
删除 ClusterResourceQuota
表 3.13. 查询参数
参数类型描述

dryRun

字符串

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

gracePeriodSeconds

整数

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

orphanDependents

布尔值

弃用:请使用 PropagationPolicy,此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false,则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy,但不能同时设置。

propagationPolicy

字符串

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

表 3.14. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
表 3.15. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
读取指定的 ClusterResourceQuota
表 3.16. 查询参数
参数类型描述

resourceVersion

字符串

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

默认为未设置

表 3.17. HTTP 响应
HTTP 代码响应正文

200 - OK

ClusterResourceQuota 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的 ClusterResourceQuota
表 3.18. 查询参数
参数类型描述

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 标志。

表 3.19. 主体参数
参数类型描述

正文(body)

Patch 模式

 
表 3.20. HTTP 响应
HTTP 代码响应正文

200 - OK

ClusterResourceQuota 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 ClusterResourceQuota
表 3.21. 查询参数
参数类型描述

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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 3.22. 主体参数
参数类型描述

正文(body)

ClusterResourceQuota 模式

 
表 3.23. HTTP 响应
HTTP 代码响应正文

200 - OK

ClusterResourceQuota 模式

201 - Created

ClusterResourceQuota 模式

401 - Unauthorized

3.2.4. /apis/quota.openshift.io/v1/watch/clusterresourcequotas/{name}

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

name

字符串

ClusterResourceQuota 的名称

表 3.25. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
观察对类型为 ClusterResourceQuota 的对象的更改。已弃用:使用带列表操作的 'watch' 参数,而是过滤成带有 'fieldSelector' 参数的单个项目。
表 3.26. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

3.2.5. /apis/quota.openshift.io/v1/clusterresourcequotas/{name}/status

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

name

字符串

ClusterResourceQuota 的名称

表 3.28. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
GET
描述
指定 ClusterResourceQuota 的读取状态
表 3.29. 查询参数
参数类型描述

resourceVersion

字符串

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

默认为未设置

表 3.30. HTTP 响应
HTTP 代码响应正文

200 - OK

ClusterResourceQuota 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定 ClusterResourceQuota 的状态
表 3.31. 查询参数
参数类型描述

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 标志。

表 3.32. 主体参数
参数类型描述

正文(body)

Patch 模式

 
表 3.33. HTTP 响应
HTTP 代码响应正文

200 - OK

ClusterResourceQuota 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定 ClusterResourceQuota 的状态
表 3.34. 查询参数
参数类型描述

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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 3.35. 主体参数
参数类型描述

正文(body)

ClusterResourceQuota 模式

 
表 3.36. HTTP 响应
HTTP 代码响应正文

200 - OK

ClusterResourceQuota 模式

201 - Created

ClusterResourceQuota 模式

401 - Unauthorized

第 4 章 FlowSchema [flowcontrol.apiserver.k8s.io/v1beta3]

描述
FlowSchema 定义一组流的 schema。请注意,流由一组带有类似属性的入站 API 请求组成,并通过一对字符串来标识: FlowSchema 的名称和一个 "flow distinguisher"。
类型
对象

4.1. 规格

属性类型描述

apiVersion

字符串

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

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

metadata 是标准对象的元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

FlowSchemaSpec 描述 FlowSchema 的规格如何。

status

对象

FlowSchemaStatus 代表 FlowSchema 的当前状态。

4.1.1. .spec

描述
FlowSchemaSpec 描述 FlowSchema 的规格如何。
类型
object
必填
  • priorityLevelConfiguration
属性类型描述

distinguisherMethod

对象

FlowDistinguisherMethod 指定流区分器的方法。

matchingPrecedence

整数

matchingPrecedence 用于在与给定请求匹配的 FlowSchemas 中进行选择。所选的 FlowSchema 是其中数字最低(我们需要逻辑上最高的)匹配中。每个 MatchingPrecedence 值都必须的范围为 [1,10000]。请注意,如果没有指定优先级,它将默认设置为 1000。

priorityLevelConfiguration

对象

PriorityLevelConfigurationReference 包含指向正在使用的"request-priority"的信息。

rules

array

规则 描述了哪些请求与此流模式匹配。此 FlowSchema 将匹配请求,只有在至少有一个规则成员与请求匹配时才匹配。如果它是空的片段,则不会有与 FlowSchema 匹配的请求。

rules[]

对象

PolicyRulesWithSubjects 规定了一个适用于 apiserver 请求的测试。该测试将考虑提出请求的主题、被请求的操作动词,以及要处理的资源。此 PolicyRulesWithSubjects 匹配一个请求,只有在(a)至少一个主题成员与请求匹配,且(b)至少匹配 resourceRules 或 nonResourceRules 的一个成员。

4.1.2. .spec.distinguisherMethod

描述
FlowDistinguisherMethod 指定流区分器的方法。
类型
object
必填
  • type
属性类型描述

type

字符串

type 是流区分器方法的类型。支持的类型是 "ByUser" 和 "ByNamespace"。必需。

4.1.3. .spec.priorityLevelConfiguration

描述
PriorityLevelConfigurationReference 包含指向正在使用的"request-priority"的信息。
类型
object
必填
  • name
属性类型描述

name

字符串

name 是被引用所需的优先级级别配置的名称。

4.1.4. .spec.rules

描述
规则 描述了哪些请求与此流模式匹配。此 FlowSchema 将匹配请求,只有在至少有一个规则成员与请求匹配时才匹配。如果它是空的片段,则不会有与 FlowSchema 匹配的请求。
类型
array

4.1.5. .spec.rules[]

描述
PolicyRulesWithSubjects 规定了一个适用于 apiserver 请求的测试。该测试将考虑提出请求的主题、被请求的操作动词,以及要处理的资源。此 PolicyRulesWithSubjects 匹配一个请求,只有在(a)至少一个主题成员与请求匹配,且(b)至少匹配 resourceRules 或 nonResourceRules 的一个成员。
类型
object
必填
  • subjects
属性类型描述

nonResourceRules

array

nonResourceRules 是一个 NonResourcePolicyRules 列表,它根据其操作动词和目标非资源 URL 识别匹配的请求。

nonResourceRules[]

对象

NonResourcePolicyRule 是一个 predicate,根据其操作动词和目标非资源 URL 匹配非资源请求。如果(a)至少一个操作动词与请求匹配,并且(b)至少匹配请求,并且(b)至少匹配请求,则 NonResourcePolicyRule 匹配请求。

resourceRules

array

resourceRules 是 ResourcePolicyRules 的一个片段,它根据其操作动词和目标资源来识别匹配的请求。至少一个 resourceRulesnonResourceRules 必须是非空的。

resourceRules[]

对象

ResourcePolicyRule 是一个与某些资源请求匹配的 predicate,测试请求的操作动词和目标资源。ResourcePolicyRule 会匹配一个资源请求(如果且仅匹配一个操作动词)与请求匹配,(b)至少一个 apiGroups 成员与请求匹配,(c)至少一个资源成员与请求匹配,(d1)请求没有指定命名空间(即 Namespace=="")和 clusterScope 为 true 或(d2)请求。

subjects

array

subjects 是此规则所关注的普通用户、serviceaccount 或组的列表。这个片段中必须至少有一个成员。包含 system:authenticated 和 system:unauthenticated 用户组的片段与每个请求匹配。必需。

subjects[]

对象

主题与请求的原始卷匹配,如请求身份验证系统所标识。匹配原始器的方式有三种;根据用户、组或服务帐户。

4.1.6. .spec.rules[].nonResourceRules

描述
nonResourceRules 是一个 NonResourcePolicyRules 列表,它根据其操作动词和目标非资源 URL 识别匹配的请求。
类型
array

4.1.7. .spec.rules[].nonResourceRules[]

描述
NonResourcePolicyRule 是一个 predicate,根据其操作动词和目标非资源 URL 匹配非资源请求。如果(a)至少一个操作动词与请求匹配,并且(b)至少匹配请求,并且(b)至少匹配请求,则 NonResourcePolicyRule 匹配请求。
类型
object
必填
  • verbs
  • nonResourceURLs
属性类型描述

nonResourceURLs

数组(字符串)

nonResourceURLs 是一组用户应有权访问且可能不是空的 url 前缀。例如: - "/healthz"是法律 - "/hea*" is illegal - "/hea" is legal but match nothing -"/hea/ " also match nothing - "/healthz/" match all per-component health checks. "*" 匹配所有非资源 URL。如果它存在,它必须是唯一的条目。必需。

verbs

数组(字符串)

verbs 是一个匹配的操作动词列表,可能不为空。"*"与所有操作都匹配。如果存在,它必须是唯一的条目。必需。

4.1.8. .spec.rules[].resourceRules

描述
resourceRules 是 ResourcePolicyRules 的一个片段,它根据其操作动词和目标资源来识别匹配的请求。至少一个 resourceRulesnonResourceRules 必须是非空的。
类型
array

4.1.9. .spec.rules[].resourceRules[]

描述
ResourcePolicyRule 是一个与某些资源请求匹配的 predicate,测试请求的操作动词和目标资源。ResourcePolicyRule 会匹配一个资源请求(如果且仅匹配一个操作动词)与请求匹配,(b)至少一个 apiGroups 成员与请求匹配,(c)至少一个资源成员与请求匹配,(d1)请求没有指定命名空间(即 Namespace=="")和 clusterScope 为 true 或(d2)请求。
类型
object
必填
  • verbs
  • apiGroups
  • resources
属性类型描述

apiGroups

数组(字符串)

apiGroups 是匹配的 API 组列表,可能不为空。"*"与所有 API 组匹配,如果存在,则必须是唯一的条目。必需。

clusterScope

布尔值

ClusterScope 指示是否与没有指定命名空间的请求匹配(发生这种情况,因为资源没有命名空间,还是以所有命名空间为目标)。如果省略此字段或 false,则 namespaces 字段必须包含非空列表。

命名空间

数组(字符串)

命名空间是 限制匹配的目标命名空间列表。只有在(a)此列表包含该目标命名空间或(b)此列表包含 "" 时,指定目标命名空间的请求才会匹配。请注意,"与任何指定的命名空间匹配,但与 没有指定 命名空间的请求不匹配(请参阅 clusterScope 字段)。此列表可能为空,但只有 clusterScope 为 true 时。

resources

数组(字符串)

资源是匹配资源(如小写和复数)的列表(如果需要,子资源)。例如,[ "services", "nodes/status" ]。这个列表可能无法为空。"*"与所有资源匹配,如果存在,则必须是唯一的条目。必需。

verbs

数组(字符串)

verbs 是匹配的操作动词列表,可能不是空的。"*" 匹配所有操作动词,如果存在,则必须是唯一的条目。必需。

4.1.10. .spec.rules[].subjects

描述
subjects 是此规则所关注的普通用户、serviceaccount 或组的列表。这个片段中必须至少有一个成员。包含 system:authenticated 和 system:unauthenticated 用户组的片段与每个请求匹配。必需。
类型
array

4.1.11. .spec.rules[].subjects[]

描述
主题与请求的原始卷匹配,如请求身份验证系统所标识。匹配原始器的方式有三种;根据用户、组或服务帐户。
类型
object
必填
  • kind
属性类型描述

group

对象

GroupSubject 包含 group-kind 主题的详细信息。

kind

字符串

kind 表示哪些其他字段是非空的。必填

serviceAccount

对象

ServiceAccountSubject 包含 service-account-kind 主题的详细信息。

user

对象

UserSubject 包含 user-kind 主题的详细信息。

4.1.12. .spec.rules[].subjects[].group

描述
GroupSubject 包含 group-kind 主题的详细信息。
类型
object
必填
  • name
属性类型描述

name

字符串

name 是匹配所有用户组的用户组群,或 "*"。有关一些已知的组名称,请参阅 https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go。必需。

4.1.13. .spec.rules[].subjects[].serviceAccount

描述
ServiceAccountSubject 包含 service-account-kind 主题的详细信息。
类型
object
必填
  • namespace
  • name
属性类型描述

name

字符串

name 是匹配的 ServiceAccount 对象的名称,或 "*" 以匹配,无论名称是什么。必需。

namespace

字符串

namespace 是匹配的 ServiceAccount 对象的命名空间。必需。

4.1.14. .spec.rules[].subjects[].user

描述
UserSubject 包含 user-kind 主题的详细信息。
类型
object
必填
  • name
属性类型描述

name

字符串

name 是匹配的用户名,或 "*" 以匹配所有用户名。必需。

4.1.15. .status

描述
FlowSchemaStatus 代表 FlowSchema 的当前状态。
类型
object
属性类型描述

conditions

array

conditions 是 FlowSchema 的当前状态列表。

conditions[]

对象

FlowSchemaCondition 描述了 FlowSchema 的条件。

4.1.16. .status.conditions

描述
conditions 是 FlowSchema 的当前状态列表。
类型
array

4.1.17. .status.conditions[]

描述
FlowSchemaCondition 描述了 FlowSchema 的条件。
类型
object
属性类型描述

lastTransitionTime

时间

lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间。

message

字符串

Message 是人类可读的消息,表示有关最后一次转换的详细信息。

reason

字符串

reason 是条件最后一次转换的唯一一词 CamelCase 原因。

status

字符串

status 是条件的状态。可以是 True, False, Unknown。必需。

type

字符串

type 是条件的类型。必需。

4.2. API 端点

可用的 API 端点如下:

  • /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas

    • DELETE :删除 FlowSchema 集合
    • GET: 列出或监视类型为 FlowSchema 的对象
    • POST :创建一个 FlowSchema
  • /apis/flowcontrol.apiserver.k8s.io/v1beta3/watch/flowschemas

    • GET: 观察单个对 FlowSchema 列表的更改。已弃用:使用带列表操作的 'watch' 参数。
  • /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas/{name}

    • DELETE :删除 FlowSchema
    • GET :读取指定的 FlowSchema
    • PATCH: 部分更新指定的 FlowSchema
    • PUT :替换指定的 FlowSchema
  • /apis/flowcontrol.apiserver.k8s.io/v1beta3/watch/flowschemas/{name}

    • GET: 观察对类型为 FlowSchema 的对象的更改。已弃用:使用带有 list 操作的 'watch' 参数,而是过滤为带有 'fieldSelector' 参数的单个项目。
  • /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas/{name}/status

    • GET :指定 FlowSchema 的读取状态
    • PATCH: 部分更新指定 FlowSchema 的状态
    • PUT :替换指定 FlowSchema 的状态

4.2.1. /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas

表 4.1. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
DELETE
描述
删除 FlowSchema 集合
表 4.2. 查询参数
参数类型描述

继续

字符串

从服务器检索更多结果时,应设置 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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

表 4.3. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
表 4.4. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出或监视类型为 FlowSchema 的对象
表 4.5. 查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

表 4.6. HTTP 响应
HTTP 代码响应正文

200 - OK

FlowSchemaList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建 FlowSchema
表 4.7. 查询参数
参数类型描述

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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 4.8. 主体参数
参数类型描述

正文(body)

FlowSchema 模式

 
表 4.9. HTTP 响应
HTTP 代码响应正文

200 - OK

FlowSchema 模式

201 - Created

FlowSchema 模式

202 - Accepted

FlowSchema 模式

401 - Unauthorized

4.2.2. /apis/flowcontrol.apiserver.k8s.io/v1beta3/watch/flowschemas

表 4.10. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
观察单个对 FlowSchema 列表的更改。已弃用:改为使用 'watch' 参数以及列表操作。
表 4.11. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

4.2.3. /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas/{name}

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

name

字符串

FlowSchema 的名称

表 4.13. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
DELETE
描述
删除 FlowSchema
表 4.14. 查询参数
参数类型描述

dryRun

字符串

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

gracePeriodSeconds

整数

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

orphanDependents

布尔值

弃用:请使用 PropagationPolicy,此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false,则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy,但不能同时设置。

propagationPolicy

字符串

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

表 4.15. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
表 4.16. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
读取指定的 FlowSchema
表 4.17. HTTP 响应
HTTP 代码响应正文

200 - OK

FlowSchema 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的 FlowSchema
表 4.18. 查询参数
参数类型描述

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 标志。

表 4.19. 主体参数
参数类型描述

正文(body)

Patch 模式

 
表 4.20. HTTP 响应
HTTP 代码响应正文

200 - OK

FlowSchema 模式

201 - Created

FlowSchema 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 FlowSchema
表 4.21. 查询参数
参数类型描述

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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 4.22. 主体参数
参数类型描述

正文(body)

FlowSchema 模式

 
表 4.23. HTTP 响应
HTTP 代码响应正文

200 - OK

FlowSchema 模式

201 - Created

FlowSchema 模式

401 - Unauthorized

4.2.4. /apis/flowcontrol.apiserver.k8s.io/v1beta3/watch/flowschemas/{name}

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

name

字符串

FlowSchema 的名称

表 4.25. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
观察对类型为 FlowSchema 的对象的更改。已弃用:使用带列表操作的 'watch' 参数,而是过滤成一个带有 'fieldSelector' 参数的单个项目。
表 4.26. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

4.2.5. /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas/{name}/status

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

name

字符串

FlowSchema 的名称

表 4.28. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
GET
描述
指定 FlowSchema 的读取状态
表 4.29. HTTP 响应
HTTP 代码响应正文

200 - OK

FlowSchema 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定 FlowSchema 的状态
表 4.30. 查询参数
参数类型描述

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 标志。

表 4.31. 主体参数
参数类型描述

正文(body)

Patch 模式

 
表 4.32. HTTP 响应
HTTP 代码响应正文

200 - OK

FlowSchema 模式

201 - Created

FlowSchema 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定 FlowSchema 的状态
表 4.33. 查询参数
参数类型描述

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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 4.34. 主体参数
参数类型描述

正文(body)

FlowSchema 模式

 
表 4.35. HTTP 响应
HTTP 代码响应正文

200 - OK

FlowSchema 模式

201 - Created

FlowSchema 模式

401 - Unauthorized

第 5 章 LimitRange [v1]

描述
LimitRange 为命名空间中的每种资源设置资源使用量限制。
类型
对象

5.1. 规格

属性类型描述

apiVersion

字符串

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

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: 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

对象

LimitRangeSpec 为与 kind 匹配的资源定义 min/max 用量限制。

5.1.1. .spec

描述
LimitRangeSpec 为与 kind 匹配的资源定义 min/max 用量限制。
类型
object
必填
  • limits
属性类型描述

limits

array

limits 是强制的 LimitRangeItem 对象列表。

limits[]

对象

LimitRangeItem 为任何与 kind 匹配的资源定义 min/max 用量限制。

5.1.2. .spec.limits

描述
limits 是强制的 LimitRangeItem 对象列表。
类型
array

5.1.3. .spec.limits[]

描述
LimitRangeItem 为任何与 kind 匹配的资源定义 min/max 用量限制。
类型
object
必填
  • type
属性类型描述

default

对象(数量)

如果省略资源限值,则默认资源要求限制值。

defaultRequest

对象(数量)

如果省略资源请求,则 defaultRequest 是资源名称的默认资源要求请求值。

max

对象(数量)

按资源名称对此类型的最大使用量限制。

maxLimitRequestRatio

对象(数量)

如果指定,则 named 资源必须具有一个请求和限制,它既为零,其中限制按请求划分或等于枚举的值;这代表指定资源的最大突发。

分钟

对象(数量)

按资源名称对此种类的最少使用限制。

type

字符串

此限制应用到的资源类型。

5.2. API 端点

可用的 API 端点如下:

  • /api/v1/limitranges

    • GET :列出或监视类型为 LimitRange 的对象
  • /api/v1/watch/limitranges

    • GET: 观察单个对 LimitRange 列表的更改。已弃用:改为使用 'watch' 参数及列表操作。
  • /api/v1/namespaces/{namespace}/limitranges

    • DELETE :删除 LimitRange 集合
    • GET :列出或监视类型为 LimitRange 的对象
    • POST :创建一个 LimitRange
  • /api/v1/watch/namespaces/{namespace}/limitranges

    • GET: 观察单个对 LimitRange 列表的更改。已弃用:改为使用 'watch' 参数及列表操作。
  • /api/v1/namespaces/{namespace}/limitranges/{name}

    • DELETE :删除 LimitRange
    • GET :读取指定的 LimitRange
    • PATCH: 部分更新指定的 LimitRange
    • PUT :替换指定的 LimitRange
  • /api/v1/watch/namespaces/{namespace}/limitranges/{name}

    • GET: 观察对类型为 LimitRange 的对象的更改。已弃用:使用带有 list 操作的 'watch' 参数,而是过滤到带有 'fieldSelector' 参数的单个项目。

5.2.1. /api/v1/limitranges

表 5.1. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
列出或监视类型为 LimitRange 的对象
表 5.2. HTTP 响应
HTTP 代码响应正文

200 - OK

LimitRangeList 模式

401 - Unauthorized

5.2.2. /api/v1/watch/limitranges

表 5.3. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
观察单个对 LimitRange 列表的更改。已弃用:改为使用 'watch' 参数和列表操作。
表 5.4. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

5.2.3. /api/v1/namespaces/{namespace}/limitranges

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

namespace

字符串

对象名称和身份验证范围,如团队(team)和项目(project)

表 5.6. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
DELETE
描述
删除 LimitRange 集合
表 5.7. 查询参数
参数类型描述

继续

字符串

从服务器检索更多结果时,应设置 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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

表 5.8. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
表 5.9. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出或监视类型为 LimitRange 的对象
表 5.10. 查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

表 5.11. HTTP 响应
HTTP 代码响应正文

200 - OK

LimitRangeList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建 LimitRange
表 5.12. 查询参数
参数类型描述

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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 5.13. 主体参数
参数类型描述

正文(body)

LimitRange 模式

 
表 5.14. HTTP 响应
HTTP 代码响应正文

200 - OK

LimitRange 模式

201 - Created

LimitRange 模式

202 - Accepted

LimitRange 模式

401 - Unauthorized

5.2.4. /api/v1/watch/namespaces/{namespace}/limitranges

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

namespace

字符串

对象名称和身份验证范围,如团队(team)和项目(project)

表 5.16. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
观察单个对 LimitRange 列表的更改。已弃用:改为使用 'watch' 参数和列表操作。
表 5.17. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

5.2.5. /api/v1/namespaces/{namespace}/limitranges/{name}

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

name

字符串

LimitRange 的名称

namespace

字符串

对象名称和身份验证范围,如团队(team)和项目(project)

表 5.19. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
DELETE
描述
删除 LimitRange
表 5.20. 查询参数
参数类型描述

dryRun

字符串

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

gracePeriodSeconds

整数

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

orphanDependents

布尔值

弃用:请使用 PropagationPolicy,此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false,则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy,但不能同时设置。

propagationPolicy

字符串

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

表 5.21. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
表 5.22. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
读取指定的 LimitRange
表 5.23. HTTP 响应
HTTP 代码响应正文

200 - OK

LimitRange 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的 LimitRange
表 5.24. 查询参数
参数类型描述

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 标志。

表 5.25. 主体参数
参数类型描述

正文(body)

Patch 模式

 
表 5.26. HTTP 响应
HTTP 代码响应正文

200 - OK

LimitRange 模式

201 - Created

LimitRange 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 LimitRange
表 5.27. 查询参数
参数类型描述

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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 5.28. 主体参数
参数类型描述

正文(body)

LimitRange 模式

 
表 5.29. HTTP 响应
HTTP 代码响应正文

200 - OK

LimitRange 模式

201 - Created

LimitRange 模式

401 - Unauthorized

5.2.6. /api/v1/watch/namespaces/{namespace}/limitranges/{name}

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

name

字符串

LimitRange 的名称

namespace

字符串

对象名称和身份验证范围,如团队(team)和项目(project)

表 5.31. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
观察对一个类型为 LimitRange 的对象的更改。已弃用:使用带有列表操作的 'watch' 参数,而是过滤成带有 'fieldSelector' 参数的单个项目。
表 5.32. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

第 6 章 PriorityClass [scheduling.k8s.io/v1]

描述
PriorityClass 定义从优先级类名称到优先级整数值的映射。该值可以是任何有效的整数。
类型
object
必填
  • value

6.1. 规格

属性类型描述

apiVersion

字符串

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

description

字符串

description 是一个任意字符串,通常在使用此优先级类时提供指导。

globalDefault

布尔值

globalDefault 指定此 PriorityClass 是否应该被视为没有任何优先级类的 pod 的默认优先级。只能将一个 PriorityClass 标记为 globalDefault。但是,如果存在多个 PriorityClasses,其 globalDefault 字段设为 true,则全局默认 PriorityClasses 的最小值将用作默认优先级。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: 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

preemptionPolicy

string

preemptionPolicy 是抢占优先级较低 pod 的策略。Never 之一 PreemptLowerPriority。如果未设置,则默认为 PreemptLowerPriority。

可能枚举值: - "Never" 表示 pod 不会抢占优先级较低的其他 pod。- "PreemptLowerPriority" 表示 pod 可以抢占优先级较低的其他 pod。

value

整数

value 代表此优先级类的整数值。这是 Pod 在 pod 规格中具有此类名称时接收的实际优先级。

6.2. API 端点

可用的 API 端点如下:

  • /apis/scheduling.k8s.io/v1/priorityclasses

    • DELETE: 删除 PriorityClass 集合
    • GET: 列出或监视类型为 PriorityClass 的对象
    • POST :创建 PriorityClass
  • /apis/scheduling.k8s.io/v1/watch/priorityclasses

    • GET: 观察单个对 PriorityClass 列表的更改。已弃用:改为使用 'watch' 参数及列表操作。
  • /apis/scheduling.k8s.io/v1/priorityclasses/{name}

    • DELETE :删除 PriorityClass
    • GET :读取指定的 PriorityClass
    • PATCH: 部分更新指定的 PriorityClass
    • PUT :替换指定的 PriorityClass
  • /apis/scheduling.k8s.io/v1/watch/priorityclasses/{name}

    • GET: 观察对类型为 PriorityClass 的对象的更改。已弃用:使用带有 list 操作的 'watch' 参数,而是过滤为带有 'fieldSelector' 参数的单个项目。

6.2.1. /apis/scheduling.k8s.io/v1/priorityclasses

表 6.1. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
DELETE
描述
删除 PriorityClass 集合
表 6.2. 查询参数
参数类型描述

继续

字符串

从服务器检索更多结果时,应设置 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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

表 6.3. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
表 6.4. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出或监视类型为 PriorityClass 的对象
表 6.5. 查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

表 6.6. HTTP 响应
HTTP 代码响应正文

200 - OK

PriorityClassList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建 PriorityClass
表 6.7. 查询参数
参数类型描述

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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 6.8. 主体参数
参数类型描述

正文(body)

PriorityClass 模式

 
表 6.9. HTTP 响应
HTTP 代码响应正文

200 - OK

PriorityClass 模式

201 - Created

PriorityClass 模式

202 - Accepted

PriorityClass 模式

401 - Unauthorized

6.2.2. /apis/scheduling.k8s.io/v1/watch/priorityclasses

表 6.10. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
观察单个对 PriorityClass 列表的更改。已弃用:改为使用 'watch' 参数及列表操作。
表 6.11. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

6.2.3. /apis/scheduling.k8s.io/v1/priorityclasses/{name}

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

name

字符串

PriorityClass 的名称

表 6.13. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
DELETE
描述
删除 PriorityClass
表 6.14. 查询参数
参数类型描述

dryRun

字符串

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

gracePeriodSeconds

整数

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

orphanDependents

布尔值

弃用:请使用 PropagationPolicy,此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false,则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy,但不能同时设置。

propagationPolicy

字符串

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

表 6.15. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
表 6.16. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
读取指定的 PriorityClass
表 6.17. HTTP 响应
HTTP 代码响应正文

200 - OK

PriorityClass 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的 PriorityClass
表 6.18. 查询参数
参数类型描述

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 标志。

表 6.19. 主体参数
参数类型描述

正文(body)

Patch 模式

 
表 6.20. HTTP 响应
HTTP 代码响应正文

200 - OK

PriorityClass 模式

201 - Created

PriorityClass 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 PriorityClass
表 6.21. 查询参数
参数类型描述

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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 6.22. 主体参数
参数类型描述

正文(body)

PriorityClass 模式

 
表 6.23. HTTP 响应
HTTP 代码响应正文

200 - OK

PriorityClass 模式

201 - Created

PriorityClass 模式

401 - Unauthorized

6.2.4. /apis/scheduling.k8s.io/v1/watch/priorityclasses/{name}

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

name

字符串

PriorityClass 的名称

表 6.25. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
观察对类型为 PriorityClass 的对象的更改。已弃用:使用带列表操作的 'watch' 参数,而是过滤成一个带有 'fieldSelector' 参数的单个项目。
表 6.26. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

第 7 章 PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1beta3]

描述
priorityLevelConfiguration 代表优先级级别的配置。
类型
对象

7.1. 规格

属性类型描述

apiVersion

字符串

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

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

metadata 是标准对象的元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

PriorityLevelConfigurationSpec 指定优先级级别的配置。

status

对象

PriorityLevelConfigurationStatus 代表 "request-priority" 的当前状态。

7.1.1. .spec

描述
PriorityLevelConfigurationSpec 指定优先级级别的配置。
类型
object
必填
  • type
属性类型描述

有限

对象

LimitedPriorityLevelConfiguration 指定如何处理受限制的请求。它解决了两个问题: - 此优先级级别的请求如何限制?- 应该对超过限制的请求执行什么操作?

type

字符串

type 表示此优先级级别是否受到请求执行的限制。"Exempt" 值表示此优先级级别的请求不会受到限制(因此永远不会被排队),且不会从容量中分离其他优先级级别。"Limited" 值表示(a)此优先级级别的请求会受到限制,(b)一些服务器的有限容量只可用于这个优先级级别。必需。

7.1.2. .spec.limited

描述
LimitedPriorityLevelConfiguration 指定如何处理受限制的请求。它解决了两个问题: - 此优先级级别的请求如何限制?- 应该对超过限制的请求执行什么操作?
类型
object
属性类型描述

borrowingLimitPercent

整数

如果存在,borrowingLimitPercent 配置了这个优先级级别的限制,这个优先级级别可以从其他优先级级别进行计费。这个限制被称为这个级别的 BorrowingConcurrencyLimit (BorrowingCL),它是这个级别可能在任何一个时间可以有界限的限制。此字段包含该限值与级别的 nominal concurrency 限制的比例。当此字段不是nil 时,它必须保留一个非负整数,并且限制按照如下所示计算:

BorrowingCL(i) = round( NominalCL(i) * borrowingLimitPercent(i)/100.0 )

此字段的值可能大于 100,这意味着此优先级级别可以借此优先级数量大于其自身的 nominal concurrency 限制(NominalCL)。当此字段保留为 nil 时,限制有效无限。

lendablePercent

整数

LendablePercent 规定了级别 NominalCL 的比例,这些部分可由其他优先级级别进行计费。此字段的值必须介于 0 到 100 之间,且默认为 0。其他级别可以从这个级别浏览(称为这个级别的 LendableConcurrencyLimit (LendableCL)的数量),具体定义如下。

LendableCL(i) = round( NominalCL(i) * lendablePercent(i)/100.0 )

limitResponse

对象

LimitResponse 定义如何处理现在无法执行的请求。

nominalConcurrencyShares

整数

nominalConcurrencyShares (NCS)向计算这个级别的 NominalConcurrencyLimit (NominalCL)贡献。这是此优先级级别上提供的执行席数。这用于从此优先级级别发送的请求,以及从其他优先级级别发送的请求(从这个级别借位)。服务器的并发限制(ServerCL)被划分成其 NCS 值的有限优先级级别:

NominalCL(i) = ceil( ServerCL * NCS(i) / sum_ncs ) sum_ncs = sum[limited priority level k] NCS(k)

较大的数字意味着一个更大的 nominal 并发限制,但会牺牲其他有限优先级级别。此字段的默认值为 30。

7.1.3. .spec.limited.limitResponse

描述
LimitResponse 定义如何处理现在无法执行的请求。
类型
object
必填
  • type
属性类型描述

排队

对象

QueuingConfiguration 包含排队的配置参数

type

字符串

type 为 "Queue" 或 "Reject"。"queue"表示无法在 arrival 上执行的请求,直到请求被执行或到达排队限制。"reject"意味着在 arrival 上无法执行的请求将被拒绝。必需。

7.1.4. .spec.limited.limitResponse.queuing

描述
QueuingConfiguration 包含排队的配置参数
类型
object
属性类型描述

handSize

整数

handSize 是一个小的正数,它将请求分片配置为队列。当以此优先级排序请求时,请求的流标识符(字符串对)会被哈希处理,哈希值用于影响队列列表和处理此处指定大小的几个大小。该请求被放入该手动中最短队列中的一个中。handSize 不得大于 队列,并且应该显著降低(因此,一些重度流不会饱和大多数队列)。有关设置此字段的更广泛的指导信息,请参阅面向用户的文档。此字段的默认值为 8。

queueLengthLimit

整数

queueLengthLimit 是允许在这个优先级级别的给定队列中等待的最大请求数;过量请求将被拒绝。这个值必须是正数。如果没有指定,则默认为 50。

队列

整数

队列 是此优先级级别的队列数量。队列在每个 apiserver 中独立存在。该值必须是 positive。将它设置为 1 有效地阻止了 shufflesharding,因此使得相关流模式的区分方式不相关。此字段的默认值为 64。

7.1.5. .status

描述
PriorityLevelConfigurationStatus 代表 "request-priority" 的当前状态。
类型
object
属性类型描述

conditions

array

条件 是 "request-priority" 的当前状态。

conditions[]

对象

PriorityLevelConfigurationCondition 定义优先级级别的条件。

7.1.6. .status.conditions

描述
条件 是 "request-priority" 的当前状态。
类型
array

7.1.7. .status.conditions[]

描述
PriorityLevelConfigurationCondition 定义优先级级别的条件。
类型
object
属性类型描述

lastTransitionTime

时间

lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间。

message

字符串

Message 是人类可读的消息,表示有关最后一次转换的详细信息。

reason

字符串

reason 是条件最后一次转换的唯一一词 CamelCase 原因。

status

字符串

status 是条件的状态。可以是 True, False, Unknown。必需。

type

字符串

type 是条件的类型。必需。

7.2. API 端点

可用的 API 端点如下:

  • /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations

    • DELETE: 删除 PriorityLevelConfiguration 集合
    • GET: 列出或监视类型为 PriorityLevelConfiguration 的对象
    • POST :创建 PriorityLevelConfiguration
  • /apis/flowcontrol.apiserver.k8s.io/v1beta3/watch/prioritylevelconfigurations

    • GET: 观察单个对 PriorityLevelConfiguration 列表的更改。已弃用:使用带列表操作的 'watch' 参数。
  • /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name}

    • DELETE :删除 PriorityLevelConfiguration
    • GET :读取指定的 PriorityLevelConfiguration
    • PATCH: 部分更新指定的 PriorityLevelConfiguration
    • PUT :替换指定的 PriorityLevelConfiguration
  • /apis/flowcontrol.apiserver.k8s.io/v1beta3/watch/prioritylevelconfigurations/{name}

    • GET: 观察对类型为 PriorityLevelConfiguration 的对象的更改。已弃用:使用带有 list 操作的 'watch' 参数,而是过滤为带有 'fieldSelector' 参数的单个项目。
  • /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name}/status

    • GET: 指定 PriorityLevelConfiguration 的读取状态
    • PATCH: 部分更新指定 PriorityLevelConfiguration 的状态
    • PUT :替换指定 PriorityLevelConfiguration 的状态

7.2.1. /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations

表 7.1. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
DELETE
描述
删除 PriorityLevelConfiguration 集合
表 7.2. 查询参数
参数类型描述

继续

字符串

从服务器检索更多结果时,应设置 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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

表 7.3. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
表 7.4. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出或监视类型为 PriorityLevelConfiguration 的对象
表 7.5. 查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

表 7.6. HTTP 响应
HTTP 代码响应正文

200 - OK

PriorityLevelConfigurationList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建 PriorityLevelConfiguration
表 7.7. 查询参数
参数类型描述

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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 7.8. 主体参数
参数类型描述

正文(body)

priorityLevelConfiguration 模式

 
表 7.9. HTTP 响应
HTTP 代码响应正文

200 - OK

priorityLevelConfiguration 模式

201 - Created

priorityLevelConfiguration 模式

202 - Accepted

priorityLevelConfiguration 模式

401 - Unauthorized

7.2.2. /apis/flowcontrol.apiserver.k8s.io/v1beta3/watch/prioritylevelconfigurations

表 7.10. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
观察单个对 PriorityLevelConfiguration 列表的更改。已弃用:使用带列表操作的 'watch' 参数。
表 7.11. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

7.2.3. /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name}

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

name

字符串

PriorityLevelConfiguration 的名称

表 7.13. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
DELETE
描述
删除 PriorityLevelConfiguration
表 7.14. 查询参数
参数类型描述

dryRun

字符串

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

gracePeriodSeconds

整数

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

orphanDependents

布尔值

弃用:请使用 PropagationPolicy,此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false,则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy,但不能同时设置。

propagationPolicy

字符串

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

表 7.15. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
表 7.16. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
阅读指定的 PriorityLevelConfiguration
表 7.17. HTTP 响应
HTTP 代码响应正文

200 - OK

priorityLevelConfiguration 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的 PriorityLevelConfiguration
表 7.18. 查询参数
参数类型描述

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 标志。

表 7.19. 主体参数
参数类型描述

正文(body)

Patch 模式

 
表 7.20. HTTP 响应
HTTP 代码响应正文

200 - OK

priorityLevelConfiguration 模式

201 - Created

priorityLevelConfiguration 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 PriorityLevelConfiguration
表 7.21. 查询参数
参数类型描述

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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 7.22. 主体参数
参数类型描述

正文(body)

priorityLevelConfiguration 模式

 
表 7.23. HTTP 响应
HTTP 代码响应正文

200 - OK

priorityLevelConfiguration 模式

201 - Created

priorityLevelConfiguration 模式

401 - Unauthorized

7.2.4. /apis/flowcontrol.apiserver.k8s.io/v1beta3/watch/prioritylevelconfigurations/{name}

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

name

字符串

PriorityLevelConfiguration 的名称

表 7.25. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
观察对类型为 PriorityLevelConfiguration 的对象的更改。已弃用:使用带有 list 操作的 'watch' 参数,而是过滤成带有 'fieldSelector' 参数的单个项目。
表 7.26. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

7.2.5. /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations/{name}/status

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

name

字符串

PriorityLevelConfiguration 的名称

表 7.28. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
GET
描述
指定 PriorityLevelConfiguration 的读取状态
表 7.29. HTTP 响应
HTTP 代码响应正文

200 - OK

priorityLevelConfiguration 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定 PriorityLevelConfiguration 的状态
表 7.30. 查询参数
参数类型描述

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 标志。

表 7.31. 主体参数
参数类型描述

正文(body)

Patch 模式

 
表 7.32. HTTP 响应
HTTP 代码响应正文

200 - OK

priorityLevelConfiguration 模式

201 - Created

priorityLevelConfiguration 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定 PriorityLevelConfiguration 的状态
表 7.33. 查询参数
参数类型描述

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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 7.34. 主体参数
参数类型描述

正文(body)

priorityLevelConfiguration 模式

 
表 7.35. HTTP 响应
HTTP 代码响应正文

200 - OK

priorityLevelConfiguration 模式

201 - Created

priorityLevelConfiguration 模式

401 - Unauthorized

第 8 章 ResourceQuota [v1]

描述
ResourceQuota 设置每个命名空间的聚合配额限制
类型
对象

8.1. 规格

属性类型描述

apiVersion

字符串

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

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: 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

对象

ResourceQuotaSpec 定义为 Quota 强制执行所需的硬限制。

status

对象

ResourceQuotaStatus 定义强制的硬限制和观察到的使用。

8.1.1. .spec

描述
ResourceQuotaSpec 定义为 Quota 强制执行所需的硬限制。
类型
object
属性类型描述

hard

对象(数量)

hard 是每个命名资源所需的硬限制集合。更多信息: https://kubernetes.io/docs/concepts/policy/resource-quotas/

scopeSelector

对象

范围选择器代表有 scope-resource 选择器要求所代表的选择器的 AND。

scopes

数组(字符串)

一组过滤器,必须与配额跟踪的每个对象匹配。如果未指定,则配额与所有对象匹配。

8.1.2. .spec.scopeSelector

描述
范围选择器代表有 scope-resource 选择器要求所代表的选择器的 AND。
类型
object
属性类型描述

matchExpressions

array

根据资源范围划分的范围选择器要求列表。

matchExpressions[]

对象

scoped-resource 选择器要求是一个选择器,其中包含与范围名称和值相关的值、范围名称和 Operator。

8.1.3. .spec.scopeSelector.matchExpressions

描述
根据资源范围划分的范围选择器要求列表。
类型
array

8.1.4. .spec.scopeSelector.matchExpressions[]

描述
scoped-resource 选择器要求是一个选择器,其中包含与范围名称和值相关的值、范围名称和 Operator。
类型
object
必填
  • scopeName
  • operator
属性类型描述

operator

字符串

代表范围与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。

可能枚举值: - "DoesNotExist" - "Exists" - "In" - "NotIn"

scopeName

字符串

选择器应用到的范围的名称。

可能枚举值: - "BestEffort" 匹配所有具有最佳服务质量的 pod 对象 - "CrossNamespacePodAffinity" 匹配所有具有跨命名空间 pod (anti) affinity 的 pod 对象。- "NotBestEffort" 匹配所有没有最佳服务质量的 pod 对象 - "NotTerminating" Match all pod 对象,其中 spec.activeDeadlineSeconds 为 nil - "PriorityClass " Match all pod 对象提及优先级类 - "Terminating " Match all pod 对象,其中 spec.activeDeadlineSeconds >=0

values

数组(字符串)

字符串值数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

8.1.5. .status

描述
ResourceQuotaStatus 定义强制的硬限制和观察到的使用。
类型
object
属性类型描述

hard

对象(数量)

hard 是每个命名资源的强制硬限制集。更多信息: https://kubernetes.io/docs/concepts/policy/resource-quotas/

使用的

对象(数量)

使用是命名空间中资源的总使用情况。

8.2. API 端点

可用的 API 端点如下:

  • /api/v1/resourcequotas

    • GET: 列出或监视类型为 ResourceQuota 的对象
  • /api/v1/watch/resourcequotas

    • GET: 观察单个对 ResourceQuota 列表的更改。已弃用:改为使用 'watch' 参数及列表操作。
  • /api/v1/namespaces/{namespace}/resourcequotas

    • DELETE: 删除 ResourceQuota 集合
    • GET: 列出或监视类型为 ResourceQuota 的对象
    • POST :创建 ResourceQuota
  • /api/v1/watch/namespaces/{namespace}/resourcequotas

    • GET: 观察单个对 ResourceQuota 列表的更改。已弃用:改为使用 'watch' 参数及列表操作。
  • /api/v1/namespaces/{namespace}/resourcequotas/{name}

    • DELETE: 删除 ResourceQuota
    • GET :读取指定的 ResourceQuota
    • PATCH: 部分更新指定的 ResourceQuota
    • PUT :替换指定的 ResourceQuota
  • /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}

    • GET: 观察对类型为 ResourceQuota 的对象的更改。已弃用:使用带有 list 操作的 'watch' 参数,而是过滤成带有 'fieldSelector' 参数的单个项目。
  • /api/v1/namespaces/{namespace}/resourcequotas/{name}/status

    • GET :指定 ResourceQuota 的读取状态
    • PATCH: 部分更新指定 ResourceQuota 的状态
    • PUT :替换指定 ResourceQuota 的状态

8.2.1. /api/v1/resourcequotas

表 8.1. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
列出或监视类型为 ResourceQuota 的对象
表 8.2. HTTP 响应
HTTP 代码响应正文

200 - OK

ResourceQuotaList 模式

401 - Unauthorized

8.2.2. /api/v1/watch/resourcequotas

表 8.3. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
观察单个对 ResourceQuota 列表的更改。已弃用:改为使用 'watch' 参数及列表操作。
表 8.4. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

8.2.3. /api/v1/namespaces/{namespace}/resourcequotas

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

namespace

字符串

对象名称和身份验证范围,如团队(team)和项目(project)

表 8.6. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
DELETE
描述
删除 ResourceQuota 集合
表 8.7. 查询参数
参数类型描述

继续

字符串

从服务器检索更多结果时,应设置 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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

表 8.8. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
表 8.9. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出或监视类型为 ResourceQuota 的对象
表 8.10. 查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

表 8.11. HTTP 响应
HTTP 代码响应正文

200 - OK

ResourceQuotaList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建 ResourceQuota
表 8.12. 查询参数
参数类型描述

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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 8.13. 主体参数
参数类型描述

正文(body)

ResourceQuota 模式

 
表 8.14. HTTP 响应
HTTP 代码响应正文

200 - OK

ResourceQuota 模式

201 - Created

ResourceQuota 模式

202 - Accepted

ResourceQuota 模式

401 - Unauthorized

8.2.4. /api/v1/watch/namespaces/{namespace}/resourcequotas

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

namespace

字符串

对象名称和身份验证范围,如团队(team)和项目(project)

表 8.16. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
观察单个对 ResourceQuota 列表的更改。已弃用:改为使用 'watch' 参数及列表操作。
表 8.17. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

8.2.5. /api/v1/namespaces/{namespace}/resourcequotas/{name}

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

name

字符串

ResourceQuota 的名称

namespace

字符串

对象名称和身份验证范围,如团队(team)和项目(project)

表 8.19. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
DELETE
描述
删除 ResourceQuota
表 8.20. 查询参数
参数类型描述

dryRun

字符串

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

gracePeriodSeconds

整数

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

orphanDependents

布尔值

弃用:请使用 PropagationPolicy,此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false,则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy,但不能同时设置。

propagationPolicy

字符串

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

表 8.21. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
表 8.22. HTTP 响应
HTTP 代码响应正文

200 - OK

ResourceQuota 模式

202 - Accepted

ResourceQuota 模式

401 - Unauthorized

HTTP 方法
GET
描述
阅读指定的 ResourceQuota
表 8.23. HTTP 响应
HTTP 代码响应正文

200 - OK

ResourceQuota 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的 ResourceQuota
表 8.24. 查询参数
参数类型描述

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 标志。

表 8.25. 主体参数
参数类型描述

正文(body)

Patch 模式

 
表 8.26. HTTP 响应
HTTP 代码响应正文

200 - OK

ResourceQuota 模式

201 - Created

ResourceQuota 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 ResourceQuota
表 8.27. 查询参数
参数类型描述

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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 8.28. 主体参数
参数类型描述

正文(body)

ResourceQuota 模式

 
表 8.29. HTTP 响应
HTTP 代码响应正文

200 - OK

ResourceQuota 模式

201 - Created

ResourceQuota 模式

401 - Unauthorized

8.2.6. /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}

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

name

字符串

ResourceQuota 的名称

namespace

字符串

对象名称和身份验证范围,如团队(team)和项目(project)

表 8.31. 全局查询参数
参数类型描述

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 选项。监控请求的语义如下: - resourceVersionMatch = NotOlderThan 解释为"数据至少为提供的 resourceVersion'",当状态同步到 'resourceVersion 时,如果状态同步到 ListOptions 提供的 'resourceVersion 时,会发送书签事件。如果未设置 resourceVersion,则这被解释为"consistent read",当请求开始处理时,将发送书签事件。- resourceVersionMatch 设置为任何其他值或未设置 Invalid 错误。

如果 resourceVersion=""resourceVersion="0" (出于向后兼容原因)和 false,则默认为 true。

timeoutSeconds

整数

列表/watch 调用的超时。这限制了调用的持续时间,无论任何活动或不活跃。

watch

布尔值

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

HTTP 方法
GET
描述
观察对 kind ResourceQuota 的对象的更改。已弃用:改为使用 'watch' 参数以及列表操作,而是过滤成带有 'fieldSelector' 参数的单个项目。
表 8.32. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

8.2.7. /api/v1/namespaces/{namespace}/resourcequotas/{name}/status

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

name

字符串

ResourceQuota 的名称

namespace

字符串

对象名称和身份验证范围,如团队(team)和项目(project)

表 8.34. 全局查询参数
参数类型描述

pretty

字符串

如果为 'true',则输出会经过 pretty print 处理。

HTTP 方法
GET
描述
指定 ResourceQuota 的读取状态
表 8.35. HTTP 响应
HTTP 代码响应正文

200 - OK

ResourceQuota 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定 ResourceQuota 的状态
表 8.36. 查询参数
参数类型描述

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 标志。

表 8.37. 主体参数
参数类型描述

正文(body)

Patch 模式

 
表 8.38. HTTP 响应
HTTP 代码响应正文

200 - OK

ResourceQuota 模式

201 - Created

ResourceQuota 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定 ResourceQuota 的状态
表 8.39. 查询参数
参数类型描述

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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 8.40. 主体参数
参数类型描述

正文(body)

ResourceQuota 模式

 
表 8.41. HTTP 响应
HTTP 代码响应正文

200 - OK

ResourceQuota 模式

201 - Created

ResourceQuota 模式

401 - Unauthorized

Legal Notice

Copyright © 2024 Red Hat, Inc.

OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).

Modified versions must remove all Red Hat trademarks.

Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.