25.4. FlowSchema [flowcontrol.apiserver.k8s.io/v1beta1]


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

25.4.1. 规格

Expand
属性类型描述

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 的当前状态。

25.4.1.1. .spec

描述
FlowSchemaSpec 描述了 FlowSchema 的规格如何样子。
类型
对象
必填
  • priorityLevelConfiguration
Expand
属性类型描述

distinguisherMethod

对象

FlowDistinguisherMethod 指定流区分器的方法。

matchingPrecedence

整数

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

priorityLevelConfiguration

对象

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

rules

array

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

rules[]

对象

PolicyRulesWithSubjects 预加一个应用于 apiserver 请求的测试。测试会考虑发出请求的主题,请求动词,以及要执行操作的资源。只有当一个主题成员与请求匹配,并且(b)至少匹配 resourceRules 或 nonResourceRules 或 nonResourceRules 的一个成员时,此 PolicyRulesWithSubjects 才会匹配请求。

25.4.1.2. .spec.distinguisherMethod

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

type

字符串

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

25.4.1.3. .spec.priorityLevelConfiguration

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

name

字符串

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

25.4.1.4. .spec.rules

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

25.4.1.5. .spec.rules[]

描述
PolicyRulesWithSubjects 预加一个应用于 apiserver 请求的测试。测试会考虑发出请求的主题,请求动词,以及要执行操作的资源。只有当一个主题成员与请求匹配,并且(b)至少匹配 resourceRules 或 nonResourceRules 或 nonResourceRules 的一个成员时,此 PolicyRulesWithSubjects 才会匹配请求。
类型
对象
必填
  • subjects
Expand
属性类型描述

nonResourceRules

array

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

nonResourceRules[]

对象

NonResourcePolicyRule 是一个 predicate,它根据其操作动词和目标非资源 URL 匹配非资源请求。只有当(a)至少一个操作动词成员与请求匹配,并且(b)至少一个非ResourceURLs 成员与请求匹配时,NonResourcePolicyRule 才会匹配请求。

resourceRules

array

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

resourceRules[]

对象

ResourcePolicyRule 是一个与一些资源请求匹配的 predicate,测试请求的操作动词和目标资源。ResourcePolicyRule 匹配资源请求,且只有:(a)至少一个与请求匹配的操作动词成员匹配,(b)至少一个 apiGroups 成员与请求匹配,(c)至少一个与请求匹配的资源成员,并且(d)至少一个与请求匹配的命名空间成员。

subjects

array

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

subjects[]

对象

主题与请求的原始者匹配,如请求身份验证系统所标识。有三种匹配来源器的方法:按用户、组或服务帐户匹配。

25.4.1.6. .spec.rules[].nonResourceRules

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

25.4.1.7. .spec.rules[].nonResourceRules[]

描述
NonResourcePolicyRule 是一个 predicate,它根据其操作动词和目标非资源 URL 匹配非资源请求。只有当(a)至少一个操作动词成员与请求匹配,并且(b)至少一个非ResourceURLs 成员与请求匹配时,NonResourcePolicyRule 才会匹配请求。
类型
对象
必填
  • verbs
  • nonResourceURLs
Expand
属性类型描述

nonResourceURLs

数组(字符串)

nonResourceURLs 是一组用户应有权访问且可能不为空的 url 前缀。例如: - "/healthz" 是法律 - "/hea047" is illegal - "/hea" 是法律,但"/hea/ " 也匹配任何 - "/healthz/" 匹配所有每个组件的健康检查。" the" 匹配所有非资源 urls。如果存在,它必须是唯一的条目。必需。

verbs

数组(字符串)

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

25.4.1.8. .spec.rules[].resourceRules

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

25.4.1.9. .spec.rules[].resourceRules[]

描述
ResourcePolicyRule 是一个与一些资源请求匹配的 predicate,测试请求的操作动词和目标资源。ResourcePolicyRule 匹配资源请求,且只有:(a)至少一个与请求匹配的操作动词成员匹配,(b)至少一个 apiGroups 成员与请求匹配,(c)至少一个与请求匹配的资源成员,并且(d)至少一个与请求匹配的命名空间成员。
类型
对象
必填
  • verbs
  • apiGroups
  • resources
Expand
属性类型描述

apiGroups

数组(字符串)

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

clusterScope

布尔值

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

命名空间

数组(字符串)

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

resources

数组(字符串)

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

verbs

数组(字符串)

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

25.4.1.10. .spec.rules[].subjects

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

25.4.1.11. .spec.rules[].subjects[]

描述
主题与请求的原始者匹配,如请求身份验证系统所标识。有三种匹配来源器的方法:按用户、组或服务帐户匹配。
类型
对象
必填
  • kind
Expand
属性类型描述

group

对象

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

kind

字符串

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

serviceAccount

对象

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

user

对象

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

25.4.1.12. .spec.rules[].subjects[].group

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

name

字符串

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

25.4.1.13. .spec.rules[].subjects[].serviceAccount

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

name

字符串

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

namespace

字符串

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

25.4.1.14. .spec.rules[].subjects[].user

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

name

字符串

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

25.4.1.15. .status

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

conditions

array

条件 是 FlowSchema 的当前状态列表。

conditions[]

对象

FlowSchemaCondition 描述 FlowSchema 的条件。

25.4.1.16. .status.conditions

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

25.4.1.17. .status.conditions[]

描述
FlowSchemaCondition 描述 FlowSchema 的条件。
类型
对象
Expand
属性类型描述

lastTransitionTime

time

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

message

字符串

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

reason

字符串

原因 是唯一、单向的、用于条件最后一次转换的 CamelCase 原因。

status

字符串

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

type

字符串

type 是条件的类型。必需。

25.4.2. API 端点

可用的 API 端点如下:

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

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

    • GET: 观察对 FlowSchema 列表的各个更改。已弃用:将 'watch' 参数与列表操作一起使用。
  • /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}

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

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

    • GET: 指定 FlowSchema 的读取状态
    • PATCH :部分更新指定流架构的状态
    • PUT: 替换指定 FlowSchema 的状态
Expand
表 25.45. 全局查询参数
参数类型描述

pretty

字符串

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

HTTP 方法
DELETE
描述
删除流架构集合
Expand
表 25.46. 查询参数
参数类型描述

继续

字符串

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

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

dryRun

字符串

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

fieldSelector

字符串

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

gracePeriodSeconds

整数

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

labelSelector

字符串

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

limit

整数

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

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

orphanDependents

布尔值

弃用:请使用 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

默认为未设置

timeoutSeconds

整数

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

Expand
表 25.47. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
Expand
表 25.48. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

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

allowWatchBookmarks

布尔值

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

继续

字符串

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

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

fieldSelector

字符串

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

labelSelector

字符串

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

limit

整数

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

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

resourceVersion

字符串

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

默认为未设置

resourceVersionMatch

字符串

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

默认为未设置

timeoutSeconds

整数

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

watch

布尔值

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

Expand
表 25.50. HTTP 响应
HTTP 代码响应正文

200 - OK

FlowSchemaList schema

401 - Unauthorized

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

dryRun

字符串

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

fieldManager

字符串

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

Expand
表 25.52. 主体参数
参数类型描述

正文(body)

FlowSchema 模式

 
Expand
表 25.53. HTTP 响应
HTTP 代码响应正文

200 - OK

FlowSchema 模式

201 - Created

FlowSchema 模式

202 - Accepted

FlowSchema 模式

401 - Unauthorized

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

allowWatchBookmarks

布尔值

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

继续

字符串

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

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

fieldSelector

字符串

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

labelSelector

字符串

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

limit

整数

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

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

pretty

字符串

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

resourceVersion

字符串

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

默认为未设置

resourceVersionMatch

字符串

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

默认为未设置

timeoutSeconds

整数

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

watch

布尔值

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

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

200 - OK

WatchEvent 模式

401 - Unauthorized

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

name

字符串

FlowSchema 的名称

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

pretty

字符串

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

HTTP 方法
DELETE
描述
删除流架构
Expand
表 25.58. 查询参数
参数类型描述

dryRun

字符串

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

gracePeriodSeconds

整数

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

orphanDependents

布尔值

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

propagationPolicy

字符串

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

Expand
表 25.59. 主体参数
参数类型描述

正文(body)

DeleteOptions 模式

 
Expand
表 25.60. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

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

200 - OK

FlowSchema 模式

401 - Unauthorized

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

dryRun

字符串

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

fieldManager

字符串

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

force

布尔值

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

Expand
表 25.63. 主体参数
参数类型描述

正文(body)

Patch 模式

 
Expand
表 25.64. HTTP 响应
HTTP 代码响应正文

200 - OK

FlowSchema 模式

201 - Created

FlowSchema 模式

401 - Unauthorized

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

dryRun

字符串

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

fieldManager

字符串

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

Expand
表 25.66. 主体参数
参数类型描述

正文(body)

FlowSchema 模式

 
Expand
表 25.67. HTTP 响应
HTTP 代码响应正文

200 - OK

FlowSchema 模式

201 - Created

FlowSchema 模式

401 - Unauthorized

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

name

字符串

FlowSchema 的名称

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

allowWatchBookmarks

布尔值

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

继续

字符串

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

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

fieldSelector

字符串

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

labelSelector

字符串

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

limit

整数

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

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

pretty

字符串

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

resourceVersion

字符串

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

默认为未设置

resourceVersionMatch

字符串

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

默认为未设置

timeoutSeconds

整数

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

watch

布尔值

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

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

200 - OK

WatchEvent 模式

401 - Unauthorized

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

name

字符串

FlowSchema 的名称

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

pretty

字符串

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

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

200 - OK

FlowSchema 模式

401 - Unauthorized

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

dryRun

字符串

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

fieldManager

字符串

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

force

布尔值

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

Expand
表 25.75. 主体参数
参数类型描述

正文(body)

Patch 模式

 
Expand
表 25.76. HTTP 响应
HTTP 代码响应正文

200 - OK

FlowSchema 模式

201 - Created

FlowSchema 模式

401 - Unauthorized

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

dryRun

字符串

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

fieldManager

字符串

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

Expand
表 25.78. 主体参数
参数类型描述

正文(body)

FlowSchema 模式

 
Expand
表 25.79. HTTP 响应
HTTP 代码响应正文

200 - OK

FlowSchema 模式

201 - Created

FlowSchema 模式

401 - Unauthorized

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

Theme

© 2025 Red Hat