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


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

17.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

对象

FlowSchemaSpec 描述了 FlowSchema 的规格如何。

status

对象

FlowSchemaStatus 代表 FlowSchema 的当前状态。

17.2.1.1. .spec

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

distinguisherMethod

对象

FlowDistinguisherMethod 指定流区分器的方法。

matchingPrecedence

整数

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

priorityLevelConfiguration

对象

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

rules

array

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

rules[]

对象

PolicyRulesWithSubjects 假定一个测试适用于一个 apiserver 的请求。测试会考虑主题进行请求、请求的动词以及要操作的资源。此 PolicyRulesWithSubjects 只在同时(a)至少一个主体成员与 request 和(b)至少匹配请求时匹配一个请求,或者(b)至少匹配 resourceRules 或 nonResourceRules 的请求。

17.2.1.2. .spec.distinguisherMethod

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

type

字符串

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

17.2.1.3. .spec.priorityLevelConfiguration

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

name

字符串

name 是引用 Required 的优先级级别配置的名称。

17.2.1.4. .spec.rules

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

17.2.1.5. .spec.rules[]

描述
PolicyRulesWithSubjects 假定一个测试适用于一个 apiserver 的请求。测试会考虑主题进行请求、请求的动词以及要操作的资源。此 PolicyRulesWithSubjects 只在同时(a)至少一个主体成员与 request 和(b)至少匹配请求时匹配一个请求,或者(b)至少匹配 resourceRules 或 nonResourceRules 的请求。
类型
object
必填
  • 主题
属性类型描述

nonResourceRules

array

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

nonResourceRules[]

对象

NonResourcePolicyRule 是一个 predicate,它根据其操作动词和目标非资源 URL 匹配非资源请求。NonResourcePolicyRule 在请求匹配时,只有最少一个操作动词成员与请求匹配,则 NonResourcePolicyRule 才会匹配请求,(b)至少匹配一个非ResourceURL 的成员。

resourceRules

array

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

resourceRules[]

对象

ResourcePolicyRule 是一个与一些资源请求匹配的 predicate,测试请求的动词和目标资源。ResourcePolicyRule 匹配资源请求(仅当:(d)至少有一个成员与请求匹配,(b)至少一个 apiGroups 的成员与请求匹配,(c)至少一个资源成员与请求匹配,(d1)请求不指定命名空间(例如,Namespace==""),而 clusterScope 则指定命名空间的一个成员,以及 (d2 个命名空间)与一个命名空间匹配。

主题

array

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

subjects[]

对象

主题与请求身份验证系统的发起者匹配,具体由请求身份验证系统识别。有三种匹配发起者的方法:用户、组或服务帐户。

17.2.1.6. .spec.rules[].nonResourceRules

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

17.2.1.7. .spec.rules[].nonResourceRules[]

描述
NonResourcePolicyRule 是一个 predicate,它根据其操作动词和目标非资源 URL 匹配非资源请求。NonResourcePolicyRule 在请求匹配时,只有最少一个操作动词成员与请求匹配,则 NonResourcePolicyRule 才会匹配请求,(b)至少匹配一个非ResourceURL 的成员。
类型
object
必填
  • verbs
  • nonResourceURLs
属性类型描述

nonResourceURLs

数组(字符串)

nonResourceURLs 是一组 url 前缀,用户应有权访问且可能不为空。例如: - "/healthz" 是法律 - "/hea*" is illegal - "/hea" is legal but match nothing -"/hea/ " also match nothing - "/healthz/" match all per-resource urls. if it is present, it must only entry.必需。

verbs

数组(字符串)

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

17.2.1.8. .spec.rules[].resourceRules

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

17.2.1.9. .spec.rules[].resourceRules[]

描述
ResourcePolicyRule 是一个与一些资源请求匹配的 predicate,测试请求的动词和目标资源。ResourcePolicyRule 匹配资源请求(仅当:(d)至少有一个成员与请求匹配,(b)至少一个 apiGroups 的成员与请求匹配,(c)至少一个资源成员与请求匹配,(d1)请求不指定命名空间(例如,Namespace==""),而 clusterScope 则指定命名空间的一个成员,以及 (d2 个命名空间)与一个命名空间匹配。
类型
object
必填
  • verbs
  • apiGroups
  • resources
属性类型描述

apiGroups

数组(字符串)

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

clusterScope

布尔值

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

命名空间

数组(字符串)

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

resources

数组(字符串)

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

verbs

数组(字符串)

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

17.2.1.10. .spec.rules[].subjects

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

17.2.1.11. .spec.rules[].subjects[]

描述
主题与请求身份验证系统的发起者匹配,具体由请求身份验证系统识别。有三种匹配发起者的方法:用户、组或服务帐户。
类型
object
必填
  • kind
属性类型描述

group

对象

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

kind

字符串

kind 表示其中一个其他字段是非空的。必填

serviceAccount

对象

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

user

对象

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

17.2.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。必需。

17.2.1.13. .spec.rules[].subjects[].serviceAccount

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

name

字符串

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

namespace

字符串

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

17.2.1.14. .spec.rules[].subjects[].user

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

name

字符串

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

17.2.1.15. .status

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

conditions

array

conditions 是 FlowSchema 的当前状态列表。

conditions[]

对象

FlowSchemaCondition 描述了 FlowSchema 的条件。

17.2.1.16. .status.conditions

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

17.2.1.17. .status.conditions[]

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

lastTransitionTime

时间

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

message

字符串

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

reason

字符串

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

status

字符串

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

type

字符串

type 是条件的类型。必需。

17.2.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' 参数和 list 操作。
  • /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 的对象的更改。已弃用:使用带有列表操作的 'watch' 参数,而是过滤到带有 'fieldSelector' 参数的单个项目。
  • /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas/{name}/status

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

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

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

pretty

字符串

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

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

继续

字符串

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

当监视为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不错过任何修改。

dryRun

字符串

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

fieldSelector

字符串

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

gracePeriodSeconds

整数

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

labelSelector

字符串

一个选择器,用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值,以检索下一个结果集合。如果过滤了所有请求的对象,设置限制可能会小于请求的项目数量(最多零项),并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数,并将返回所有可用结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假设没有更多结果可用。如果 watch 为 true,则不支持此字段。

服务器保证,在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同,即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照,并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象,则返回第一个列表结果时存在的对象版本。

orphanDependents

布尔值

deprecated :请使用 PropagationPolicy,此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false,则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 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 的列表调用设置 resourceVersionMatch,详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,监视流将以 synthetic 事件开头,以生成集合中对象的当前状态。发送完所有此类事件后,将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV),并标有 '"k8s.io/initial-events-end": "true"' 注解。之后,监视流会照常进行,将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion',则会将其解释为 "consistent read",并且当状态在请求开始处理时至少同步时,会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

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

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间,而不考虑任何活动或不活跃。

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

正文(body)

DeleteOptions 模式

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

200 - OK

Status 模式

401 - Unauthorized

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

allowWatchBookmarks

布尔值

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

继续

字符串

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

当监视为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不错过任何修改。

fieldSelector

字符串

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

labelSelector

字符串

一个选择器,用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值,以检索下一个结果集合。如果过滤了所有请求的对象,设置限制可能会小于请求的项目数量(最多零项),并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数,并将返回所有可用结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假设没有更多结果可用。如果 watch 为 true,则不支持此字段。

服务器保证,在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同,即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照,并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象,则返回第一个列表结果时存在的对象版本。

resourceVersion

字符串

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

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch,详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,监视流将以 synthetic 事件开头,以生成集合中对象的当前状态。发送完所有此类事件后,将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV),并标有 '"k8s.io/initial-events-end": "true"' 注解。之后,监视流会照常进行,将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion',则会将其解释为 "consistent read",并且当状态在请求开始处理时至少同步时,会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

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

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间,而不考虑任何活动或不活跃。

watch

布尔值

观察对上述资源的更改,并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。

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

200 - OK

FlowSchemaList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建 FlowSchema
表 17.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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

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

正文(body)

FlowSchema 模式

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

200 - OK

FlowSchema 模式

201 - Created

FlowSchema 模式

202 - Accepted

FlowSchema 模式

401 - Unauthorized

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

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

allowWatchBookmarks

布尔值

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

继续

字符串

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

当监视为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不错过任何修改。

fieldSelector

字符串

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

labelSelector

字符串

一个选择器,用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值,以检索下一个结果集合。如果过滤了所有请求的对象,设置限制可能会小于请求的项目数量(最多零项),并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数,并将返回所有可用结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假设没有更多结果可用。如果 watch 为 true,则不支持此字段。

服务器保证,在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同,即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照,并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象,则返回第一个列表结果时存在的对象版本。

pretty

字符串

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

resourceVersion

字符串

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

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch,详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,监视流将以 synthetic 事件开头,以生成集合中对象的当前状态。发送完所有此类事件后,将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV),并标有 '"k8s.io/initial-events-end": "true"' 注解。之后,监视流会照常进行,将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion',则会将其解释为 "consistent read",并且当状态在请求开始处理时至少同步时,会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

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

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间,而不考虑任何活动或不活跃。

watch

布尔值

观察对上述资源的更改,并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。

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

200 - OK

WatchEvent 模式

401 - Unauthorized

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

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

name

字符串

FlowSchema 的名称

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

pretty

字符串

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

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

dryRun

字符串

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

gracePeriodSeconds

整数

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

orphanDependents

布尔值

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

propagationPolicy

字符串

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

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

正文(body)

DeleteOptions 模式

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

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

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

200 - OK

FlowSchema 模式

401 - Unauthorized

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

dryRun

字符串

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

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch),但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

force

布尔值

强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求,必须取消设置 force 标志。

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

正文(body)

Patch 模式

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

200 - OK

FlowSchema 模式

201 - Created

FlowSchema 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 FlowSchema
表 17.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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

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

正文(body)

FlowSchema 模式

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

200 - OK

FlowSchema 模式

201 - Created

FlowSchema 模式

401 - Unauthorized

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

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

name

字符串

FlowSchema 的名称

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

allowWatchBookmarks

布尔值

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

继续

字符串

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

当监视为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视,而不错过任何修改。

fieldSelector

字符串

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

labelSelector

字符串

一个选择器,用于按标签限制返回的对象列表。默认为任何内容。

limit

整数

limit 是列表调用返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值,以检索下一个结果集合。如果过滤了所有请求的对象,设置限制可能会小于请求的项目数量(最多零项),并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数,并将返回所有可用结果。如果指定了 limit,并且 continue 字段为空,客户端可能会假设没有更多结果可用。如果 watch 为 true,则不支持此字段。

服务器保证,在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同,即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照,并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象,则返回第一个列表结果时存在的对象版本。

pretty

字符串

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

resourceVersion

字符串

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

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch,详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

sendInitialEvents

布尔值

'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下,监视流将以 synthetic 事件开头,以生成集合中对象的当前状态。发送完所有此类事件后,将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV),并标有 '"k8s.io/initial-events-end": "true"' 注解。之后,监视流会照常进行,将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。

当设置了 'sendInitialEvents' 选项时,我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下: - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'",当状态同步到 'resourceVersion' 时,书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion',则会将其解释为 "consistent read",并且当状态在请求开始处理时至少同步时,会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。

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

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的持续时间,而不考虑任何活动或不活跃。

watch

布尔值

观察对上述资源的更改,并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。

HTTP 方法
GET
描述
观察对 kind FlowSchema. deprecated 的对象的更改:使用带有列表操作的 'watch' 参数,而是过滤到带有 'fieldSelector' 参数的单个项目。
表 17.26. HTTP 响应
HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

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

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

name

字符串

FlowSchema 的名称

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

pretty

字符串

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

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

200 - OK

FlowSchema 模式

401 - Unauthorized

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

dryRun

字符串

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

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求需要此字段(application/apply-patch),但对于非应用补丁类型(JsonPatch、MergePatch、strategicMergePatch)是可选的。

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

force

布尔值

强制尝试"强制"应用请求。这意味着用户将重新排序由其他人员拥有的冲突字段。对于非应用补丁请求,必须取消设置 force 标志。

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

正文(body)

Patch 模式

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

200 - OK

FlowSchema 模式

201 - Created

FlowSchema 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定 FlowSchema 的状态
表 17.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 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

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

正文(body)

FlowSchema 模式

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

200 - OK

FlowSchema 模式

201 - Created

FlowSchema 模式

401 - Unauthorized

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

© 2024 Red Hat, Inc.