API 参考

Red Hat build of MicroShift 4.12

MicroShift API 参考

Red Hat OpenShift Documentation Team

摘要

本文档提供有关 MicroShift 中的 REST API 功能的详细信息。

第 1 章 了解 API 层

重要

这个指南不包括层次的红帽构建的 MicroShift 产品。

红帽要求应用程序开发人员验证他们所依赖的所有行为是否在正式的 API 文档中明确定义,以防止引入特定实施特定行为或对 API 特定实施错误的依赖项。例如,如果应用程序使用未文档化的 API 或依赖于未定义行为,则入口路由器的新版本可能无法与旧的版本兼容。

1.1. API 层

所有商业支持的 API、组件和功能都与以下支持级别之一相关联:

API 层 1

API 和应用程序操作环境(AOE)在主发行版本中保持稳定。它们在主版本中可能被弃用,但在后续的主发行版本前不会删除它们。

API 层 2

API 和 AOEs 在主发行版本中至少为 9 个月或 3 个次版本的发布周期(以更长的时间为准)。

API 层 3

此级别适用于通过 Operator Hub 的红帽构建 MicroShift 附带的语言、工具、应用程序和可选 Operator。每个组件都将指定一个生命周期,在其中支持 API 和 AOE。较新的语言运行时组件版本将尽量作为 API 和 AOE 兼容次版本。但是,无法保证次版本的兼容性。

通过 Operator Hub 接收持续更新的组件和开发人员工具(称为 Operator 和操作对象)应该被视为 API 层 3。开发人员应谨慎使用,并了解这些组件如何在每个次发行版本中改变。我们鼓励用户参考组件所记录的兼容性指南。

API 层 4

不提供兼容性。API 和 AOE 可在任何时候更改。这些功能不应由需要长期支持的应用程序使用。

Operator 在内部使用自定义资源定义 (CRD) 来完成任务是常见的。这些对象并应由 Operator 外部执行者使用,它旨在隐藏。如果任何 CRD 没有被 Operator 外部执行者使用,则 Operator ClusterServiceVersion (CSV)中的 operators.operatorframework.io/internal-objects 注解应指定给对应资源使用范围,并且 CRD 可能会明确标记为层 4。

1.2. 将 API 层映射到 API 组

对于由红帽定义的每个 API 层,我们为上游社区致力于保持向前兼容性的特定 API 组提供映射表。默认情况下,任何没有指定显式兼容性级别且未特别讨论的 API 组都会被分配 API 层 3,但 v1alpha1 API 默认被分配层 4。

1.2.1. 支持 Kubernetes API 组

以后缀 *.k8s.io 结尾的 API 组,或带有任何后缀的 version.<name> 均由 Kubernetes 弃用策略管理,并遵循公开和对应的支持层之间的通用映射,除非另有指定。

API 版本示例API 层

v1

1 级

v1beta1

2 级

v1alpha1

4 级

1.2.2. 支持 OpenShift API 组

以后缀 If openshift.io 结尾的 API 组由红帽构建的 MicroShift 弃用策略管理,并遵循公开和对应的兼容性级别之间的通用映射,除非另有指定。

API 版本示例API 层

route.openshift.io/v1

1 级

security.openshift.io/v1

1 级,除 RangeAllocation (4 级) 和 *Reviews (2 级)

1.3. API 弃用策略

红帽构建的 MicroShift 由许多来自上游社区的组件组成。因此,我们预计许多组件、关联的 API 接口和关联的功能集合将随着时间推移而有所变化,并且在功能被完成删除前会提供一个弃用的阶段。

1.3.1. 弃用的 API 部分

红帽构建的 MicroShift 是一个分布式系统,多个组件通过一组结构化 API 与由集群 control plane 管理的共享状态进行交互。根据 Kubernetes 惯例,红帽构建的 MicroShift 提供的每个 API 都与组标识符关联,每个 API 组都是独立的版本。每个 API 组都在不同的上游社区中管理,包括 Kubernetes、Metal3、Multus、Operator Framework、Open Cluster Management、OpenShift 本身等。

虽然每个上游社区可能会为给定的 API 组和版本定义自己的唯一弃用策略,但红帽会将社区特定策略规范化为之前定义的兼容性级别之一,具体取决于我们的集成和认知,以简化最终用户消费和支持。

API 的弃用策略和调度因兼容性级别而异。

弃用策略涵盖 API 的所有元素,包括:

  • REST 资源,也称为 API 对象
  • REST 资源的字段
  • REST 资源的注解,不包括特定于版本的限定符
  • Enumerated 或 constant 值

除每个组中最新的 API 版本外,在宣布弃用后,必须支持旧的 API 版本,且时间不少于:

API 层Duration

1 级

在一个主版本内是稳定的。它们在主版本中可能被弃用,但在后续的主发行版本前不会删除它们。

2 级

从公布弃用后的 9 个月或 3 个发行版本(以更长的时间为准)。

3 级

请参阅特定于组件的调度。

4 级

无。无法保证兼容性。

以下规则适用于所有 1 级 API:

  • API 元素只能通过递增组版本来删除。
  • API 对象必须能够在没有信息丢失的情况下在 API 版本之间往返,除非整个 REST 资源在某些版本中不存在。如果在版本之间没有对等的字段,数据将在转换过程中以注解的形式保留。
  • 一个特定组中的 API 版本在新的 API 版本至少发行了一个稳定的版本前不会被弃用,除非整个 API 对象已被删除。

1.3.2. 弃用的 CLI 元素

对于面向客户端的 CLI 命令,它们的版本模式与 API 不同,它们是面向用户的组件系统。用户与 CLI 交互的两种主要方法是通过命令或标志(在此上下文中称为 CLI 元素)。

除非另有说明,否则所有 CLI 元素都默认为 API 层 1,除非另有说明或 CLI 依赖于较低层 API。

 元素API 层

正式发布(GA)

标志和命令

1 级

技术预览

标志和命令

3 级

开发者预览

标志和命令

4 级

1.3.3. 弃用整个组件

弃用整个组件的持续时间和调度直接映射到与该组件公开的 API 的最高 API 层关联的持续时间。例如,在满足第 1 层弃用计划前,无法删除带有级别 1 和 2 的 API 的组件。

API 层Duration

1 级

在一个主版本内是稳定的。它们在主版本中可能被弃用,但在后续的主发行版本前不会删除它们。

2 级

从公布弃用后的 9 个月或 3 个发行版本(以更长的时间为准)。

3 级

请参阅特定于组件的调度。

4 级

无。无法保证兼容性。

第 2 章 了解 API 兼容性指南

重要

这个指南不包括层次的红帽构建的 MicroShift 产品。

2.1. API 兼容性指南

红帽建议应用程序开发人员使用以下原则来改进与红帽构建的 MicroShift 的兼容性:

  • 使用与应用需求匹配的 API 和组件,支持层。
  • 尽可能使用公布的客户端库构建应用程序。
  • 只有应用程序在作为新环境构建的环境中执行时,才能保证正确运行。无法保证为红帽构建的 MicroShift 4.7 构建的应用程序在 MicroShift 4.6 上正常工作。
  • 不要设计依赖于系统软件包或其他组件提供的配置文件的应用程序。除非上游社区明确提交来保留它们,否则这些文件可以在不同版本之间更改。在适当的情况下,依靠任何红帽在这些配置文件中提供接口抽象,以便保持向前兼容性。不鼓励直接修改配置文件,强烈建议用户与提供的 API 集成,以避免双写器冲突。
  • 不要依赖于以 unsupported<FieldName> 或在产品文档中未明确提及的注解作为前缀的 API 字段。
  • 不要依赖于比您的应用程序更短的兼容性保证。
  • 不要在 etcd 服务器上执行直接存储操作。所有 etcd 访问都必须通过 api-server 或记录的备份和恢复步骤执行。

红帽建议应用程序开发人员遵循 Red Hat Enterprise Linux (RHEL)定义的兼容性指南。红帽构建的 MicroShift 强烈推荐以下准则,在构建应用程序或在此平台上托管应用程序:

  • 不要依赖于特定的 Linux 内核或 MicroShift 版本的红帽构建。
  • 避免从 procsysdebug 文件系统,或任何其他伪文件系统读取。
  • 避免使用 ioctls 直接与硬件交互。
  • 避免直接与 cgroups 交互,以便不与红帽构建的 MicroShift 主机代理冲突,后者提供容器执行环境。
注意

在发行版本的生命周期中,红帽采取商业合理的努力来维护所有次发行版本和 z-stream 版本中的 API 和应用程序操作环境 (AOE) 兼容性。但是如有必要,红帽会就安全影响级别为“关键(Critical)”的安全问题或者其他严重问题在兼容性方面做例外处理。

2.2. API 兼容性例外

以下是红帽构建的 MicroShift 中兼容性的例外:

升级的集群和新安装之间的功能默认

目前,产品次版本的新安装功能与之前次版本一起安装的产品版本相同,不会进行保证。例如,未来版本的产品可能会置备云基础架构,其默认值与之前的次版本不同。此外,未来版本的产品中可能会进行不同的默认安全选择。产品的过去版本将会向前升级,但仍然保留了旧的选择,以便保持向后兼容性。

使用前缀 "unsupported" 或 undocumented 注解的 API 字段

在产品公开字段中,选择带有前缀 unsupported<FieldName> 的 API。不保证,目前在不同版本间或一个版本内支持使用这个字段。产品支持可在调试特定问题时请求在此字段中指定值,但在该交互之外不支持其使用。在未明确记录的对象中使用注解在次版本间不会保证支持。

每个产品安装拓扑的 API 可用性

OpenShift 发行版将继续演进其支持的安装拓扑,且不是一个安装拓扑中的所有 API 都必须包含在另一个安装中。例如,如果某些拓扑与产品安装拓扑冲突,或者根本不包括特定的 API,则某些拓扑可能会限制对特定 API 的读/写访问。根据上面定义的兼容性层,支持给定拓扑中存在的 API。

2.3. API 兼容性常见术语

2.3.1. 应用程序编程接口 (API)

API 是一个由软件程序实现的公共接口,它允许它与其他软件交互。在 MicroShift 的红帽构建中,API 从集中式 API 服务器提供,用作所有系统交互的中心。

2.3.2. 应用程序操作环境 (AOE)

AOE 是执行最终用户应用程序程序的集成环境。AOE 是一个容器化环境,提供与主机操作系统 (OS) 隔离的。至少,AOE 允许应用程序以独立于主机操作系统库和二进制文件运行,但仍然与主机上的所有其他容器共享相同的 OS 内核。AOE 在运行时强制执行,它描述了应用程序及其操作环境之间的接口。它包括平台操作系统和环境的交集点,以及用户应用程序,包括 Downward API、DNS、资源核算、设备访问、平台工作负载身份、容器之间隔离、容器和主机操作系统之间的隔离。

AOE 不包括安装可能会有所不同的组件,如 Container Network Interface (CNI)插件选择或对产品的扩展,如准入 hook。在容器环境下面的级别与集群集成的组件可能会受到不同版本之间的其他变化。

2.3.3. 虚拟化环境中的兼容性

虚拟环境模拟裸机环境,这样在裸机环境中运行的非特权应用程序将在对应的虚拟环境中运行。虚拟环境改进了物理资源的抽象视图,因此可能存在一些差异。

2.3.4. 云环境中的兼容性

红帽构建的 MicroShift 可能会选择通过云供应商特定集成提供与托管云环境的集成点。这些集成点的兼容性特定于原生云供应商提供的保证,及其与红帽构建的 MicroShift 兼容性窗口交集。如果红帽构建的 MicroShift 作为默认安装的一部分原生地与云环境集成,红帽针对稳定的云 API 端点开发,以提供合理的商业支持,包括稳定的弃用策略。云供应商与红帽构建的 MicroShift 之间的集成示例包括:但不仅限于动态卷置备、服务负载均衡器集成、pod 工作负载身份、计算的动态管理,以及作为初始安装的一部分置备的基础架构。

2.3.5. 主版本、次版本和 z-stream 版本

红帽主发行版本代表了开发产品的显著步骤。次发行版本会出现在主发行版本范围内,并代表弃用界限可能会影响将来的应用程序兼容性。z-stream 版本是次版本的更新,它为关联的次版本提供持续修复流。API 和 AOE 兼容性永远不会在 z-stream 版本中中断,除非明确覆盖此策略以响应不可预见的安全影响。

例如,在版本 4.3.2 中:

  • 4 是主版本
  • 3 是次版本
  • 2 是 z-stream 版本

2.3.6. 扩展的用户支持 (EUS)

一个 Red Hat build of MicroShift 主发行版本中的一个次发行版本,它有一个对关键程序错误修复的延长支持窗口。通过在 EUS 版本之间使用次版本,用户可以在 EUS 版本之间迁移 EUS 版本。请注意,弃用策略是在次发行版本中定义,而不是 EUS 版本。因此,在通过每个次版本按顺序升级时,EUS 用户可能需要在迁移到将来的 EUS 时响应弃用。

2.3.7. 开发者预览

可选的产品功能不受红帽官方支持,但旨在提供探索早期阶段技术的机制。默认情况下,开发人员预览功能是 opt-in,可以随时删除。启用开发人员预览功能可能会导致集群无法支持,这取决于该功能的范围。

2.3.8. 技术预览

提供即将推出的产品创新的可选产品功能,以测试功能并在开发过程中提供反馈。这个功能没有被完全支持,可能无法正常工作,且不适用于生产环境。使用技术预览功能需要明确选择。了解有关 技术预览功能支持范围 的更多信息。

第 3 章 网络 API

3.1. Route [route.openshift.io/v1]

描述

通过路由,开发人员可以通过 HTTP (S)了解负载平衡和代理层通过公共 DNS 条目公开服务。路由可以进一步指定 TLS 选项和证书,或者指定路由器也应该接受 HTTP 和 HTTPS 流量的公共 CNAME。管理员通常将其路由器配置为在集群防火墙外可见,还可在服务内容上添加额外的安全性、缓存或流量控制。路由器通常直接与服务端点通信。

创建路由后,可能不会更改 host 字段。通常,路由器在解析冲突时使用带有给定主机的最旧的路由。

路由器受到额外的自定义,可以通过 annotations 字段支持其他控制。

由于管理员可以配置多个路由器,因此路由状态字段用于向客户端返回每个路由器下路由的名称和状态的信息。如果客户端选择重复的名称,例如,则使用路由状态条件来指示无法选择路由。

要在路由上启用 HTTP/2 ALPN,它需要自定义(非通配符)证书。这可防止客户端的连接并发,特别是 Web 浏览器。由于连接重新使用的风险,我们不支持使用默认证书的 HTTP/2 ALPN。没有其自身自定义证书的路由在前端或后端上都不会是启用了 HTTP/2 ALPN 的路由。

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

类型
对象
必填
  • spec

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

元数据

ObjectMeta_v2

 

spec

对象

RouteSpec 描述了路由公开的主机名或路径、任何安全信息,以及到路由指向的四个后端(服务)。根据分配给每个后端的权重在后端间分布请求。当使用 roundrobin 调度进入每个后端的请求部分时,后端权重会除以所有后端权重的总和。当后端有多个端点时,后端结束的请求会在端点之间循环分布。权重介于 0 到 256 之间,默认为 100。权重 0 会导致请求到后端。如果所有权重都为零,则路由将被视为没有后端并返回标准 503 响应。

tls 字段是可选的,允许路由的特定证书或行为。路由器通常在通配符域中配置默认证书,以在没有显式证书的情况下终止路由,但自定义主机名通常必须选择 passthrough (通过 TLS Server-Name- Indication 字段向后端发送流量)或提供证书。

status

对象

RouteStatus 提供有关路由状态的相关信息,包括确认哪个路由器。

3.1.1.1. .spec

描述

RouteSpec 描述了路由公开的主机名或路径、任何安全信息,以及到路由指向的四个后端(服务)。根据分配给每个后端的权重在后端间分布请求。当使用 roundrobin 调度进入每个后端的请求部分时,后端权重会除以所有后端权重的总和。当后端有多个端点时,后端结束的请求会在端点之间循环分布。权重介于 0 到 256 之间,默认为 100。权重 0 会导致请求到后端。如果所有权重都为零,则路由将被视为没有后端并返回标准 503 响应。

tls 字段是可选的,允许路由的特定证书或行为。路由器通常在通配符域中配置默认证书,以在没有显式证书的情况下终止路由,但自定义主机名通常必须选择 passthrough (通过 TLS Server-Name- Indication 字段向后端发送流量)或提供证书。

类型
对象
必填
属性类型描述

alternateBackends

array

alternateBackends 允许最多 3 个额外的后端分配给路由。只允许 Service kind,它将默认为 Service。使用 RouteTargetReference 对象中的 weight 字段指定相对的首选项。

alternateBackends[]

对象

RouteTargetReference 指定解析为端点的目标。只允许 'Service' kind。使用"weight"字段加重其他字段。

主机

字符串

主机是一个指向该服务的别名/DNS。可选。如果没有指定路由名称,则通常会自动选择。必须遵循 DNS952 子域惯例。

path

字符串

路由器监视的路径,将流量路由到该服务的流量。选填

port

对象

RoutePort 定义从路由器到服务端点中的端点的端口映射。

subdomain

字符串

子域是在入口控制器的域(作为子域)中请求的 DNS 子域。如果设置 host,则忽略此字段。入口控制器可能会选择忽略这个建议的名称,在这种情况下,控制器会在 status.ingress 数组中报告分配的名称,或拒绝接受该路由。如果设置了这个值,且服务器不支持此字段,主机则会自动填充。否则主机将留空。该字段可能有多个以点分开的部分,但并非所有入口控制器都遵守请求。创建后无法更改此字段,但具有更新路由/自定义主机权限的用户除外。

示例:子域 frontend 会自动接收路由器子域 apps.mycluster.com,以获得完整的主机名 frontend.apps.mycluster.com

tls

对象

TLSConfig 定义用于保护路由并提供终止的配置

对象

RouteTargetReference 指定解析为端点的目标。只允许 'Service' kind。使用"weight"字段加重其他字段。

wildcardPolicy

字符串

用于路由的通配符策略。目前只允许 'Subdomain' 或 'None'。

3.1.1.2. .spec.alternateBackends

描述
alternateBackends 允许最多 3 个额外的后端分配给路由。只允许 Service kind,它将默认为 Service。使用 RouteTargetReference 对象中的 weight 字段指定相对的首选项。
类型
array

3.1.1.3. .spec.alternateBackends[]

描述
RouteTargetReference 指定解析为端点的目标。只允许 'Service' kind。使用"weight"字段加重其他字段。
类型
对象
必填
  • kind
  • name
属性类型描述

kind

字符串

路由引用的目标种类。目前,只允许 'Service'

name

字符串

要引用的服务/目标的名称,如服务的名称

weight

整数

weight 作为 0 到 256 之间的整数,默认 100 指定针对其他目标引用对象的目标相对权重。0 会阻止请求进入此后端。

3.1.1.4. .spec.port

描述
RoutePort 定义从路由器到服务端点中的端点的端口映射。
类型
对象
必填
  • targetPort
属性类型描述

targetPort

IntOrString

此路由所指向的服务选择的 pod 上的目标端口。如果这是字符串,它会在目标端点端口列表中作为命名的端口进行查找。必填

3.1.1.5. .spec.tls

描述
TLSConfig 定义用于保护路由并提供终止的配置
类型
对象
必填
  • termination
属性类型描述

caCertificate

字符串

caCertificate 提供证书颁发机构证书内容

certificate

字符串

证书提供证书内容。这应该是单一服务证书,而不是证书链。不要包括 CA 证书。

destinationCACertificate

字符串

destinationCACertificate 提供最终目的地的 ca 证书的内容。使用重新加密终止时,应提供此文件,以便让路由器将它用于安全连接上的健康检查。如果没有指定此字段,路由器可能会提供自己的目标 CA,并使用短服务名称(service.namespace.svc)执行主机名验证,它允许基础架构生成的证书自动验证。

insecureEdgeTerminationPolicy

字符串

insecureEdgeTerminationPolicy 表示路由不安全连接所需的行为。虽然每个路由器可能会对要公开的端口做出自己的决定,但通常这是端口 80。

* Allow - 流量发送到不安全端口(默认)上的服务器,在不安全的端口上不允许禁用 - 不允许流量。* Redirect - 客户端被重定向到安全端口。

key

字符串

密钥提供密钥文件内容

termination

字符串

termination 表示终止类型。

* edge - TLS 终止由路由器完成,http 用于与后端通信(默认)= 透传 - 在不提供 TLS 终止的路由器时直接发送到目的地,TLS 终止由路由器完成,https 用于与后端通信

3.1.1.6. .spec.to

描述
RouteTargetReference 指定解析为端点的目标。只允许 'Service' kind。使用"weight"字段加重其他字段。
类型
对象
必填
  • kind
  • name
属性类型描述

kind

字符串

路由引用的目标种类。目前,只允许 'Service'

name

字符串

要引用的服务/目标的名称,如服务的名称

weight

整数

weight 作为 0 到 256 之间的整数,默认 100 指定针对其他目标引用对象的目标相对权重。0 会阻止请求进入此后端。

3.1.1.7. .status

描述
RouteStatus 提供有关路由状态的相关信息,包括确认哪个路由器。
类型
对象
属性类型描述

ingress

array

Ingress 描述了可公开路由的位置。ingress 点列表可能包含重复的主机或 RouterName 值。路由在就绪后被视为 Ready

ingress[]

对象

RouteIngress 包含有关公开路由的位置的信息。

3.1.1.8. .status.ingress

描述
Ingress 描述了可公开路由的位置。ingress 点列表可能包含重复的主机或 RouterName 值。路由在就绪后被视为 Ready
类型
array

3.1.1.9. .status.ingress[]

描述
RouteIngress 包含有关公开路由的位置的信息。
类型
对象
属性类型描述

conditions

array

条件是路由的状态,可能为空。

conditions[]

对象

RouteIngressCondition 包含特定路由器上此路由的当前条件的详情。

主机

字符串

host 是公开路由的主机字符串;需要这个值

routerCanonicalHostname

字符串

CanonicalHostname 是路由器的外部主机名,可用作为此路由请求的主机的 CNAME。这个值是可选的,可能不会在所有情况下设置。

routerName

字符串

名称是路由器选择以标识自身的名称;需要这个值

wildcardPolicy

字符串

通配符策略是允许公开此路由的通配符策略。

3.1.1.10. .status.ingress[].conditions

描述
条件是路由的状态,可能为空。
类型
array

3.1.1.11. .status.ingress[].conditions[]

描述
RouteIngressCondition 包含特定路由器上此路由的当前条件的详情。
类型
对象
必填
  • type
  • status
属性类型描述

lastTransitionTime

Time

当条件最后转换时的 RFC 3339 日期和时间

message

字符串

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

reason

字符串

(简洁) 条件最后一次转换的原因,通常是机器和人类可读的常量。

status

字符串

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

type

字符串

type 是条件的类型。目前只有 Admited。

3.1.2. API 端点

可用的 API 端点如下:

  • /apis/route.openshift.io/v1/routes

    • GET :列出或监视类型为 Route 的对象
  • /apis/route.openshift.io/v1/watch/routes

    • GET: 观察单个对 Route 列表的更改。已弃用:改为使用 'watch' 参数以及列表操作。
  • /apis/route.openshift.io/v1/namespaces/{namespace}/routes

    • DELETE :删除路由的集合
    • GET :列出或监视类型为 Route 的对象
    • POST :创建路由
  • /apis/route.openshift.io/v1/watch/namespaces/{namespace}/routes

    • GET: 观察单个对 Route 列表的更改。已弃用:改为使用 'watch' 参数以及列表操作。
  • /apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}

    • DELETE :删除路由
    • GET :读指定的路由
    • PATCH :部分更新指定的路由
    • PUT :替换指定的路由
  • /apis/route.openshift.io/v1/watch/namespaces/{namespace}/routes/{name}

    • GET: 观察对类型为 Route 的对象的更改。已弃用:使用带列表操作的 'watch' 参数,而是过滤到带有 'fieldSelector' 参数的单个项目。
  • /apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}/status

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

3.1.2.1. /apis/route.openshift.io/v1/routes

表 3.1. 全局查询参数

参数类型描述

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
描述
列出或监视类型为 Route 的对象

表 3.2. HTTP 响应

HTTP 代码响应正文

200 - OK

RouteList 模式

401 - Unauthorized

3.1.2.2. /apis/route.openshift.io/v1/watch/routes

表 3.3. 全局查询参数

参数类型描述

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
描述
观察单个对 Route 列表的更改。已弃用:改为使用 'watch' 参数以及 list 操作。

表 3.4. HTTP 响应

HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

3.1.2.3. /apis/route.openshift.io/v1/namespaces/{namespace}/routes

表 3.5. 全局路径参数

参数类型描述

namespace

字符串

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

表 3.6. 全局查询参数

参数类型描述

pretty

字符串

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

HTTP 方法
DELETE
描述
删除路由的集合

表 3.7. 查询参数

参数类型描述

继续

字符串

从服务器检索更多结果时,应设置 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 调用的超时。这限制了调用的时间,无论任何活动或不活跃。

表 3.8. 主体参数

参数类型描述

正文(body)

DeleteOptions 模式

 

表 3.9. HTTP 响应

HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

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

表 3.10. 查询参数

参数类型描述

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。

表 3.11. HTTP 响应

HTTP 代码响应正文

200 - OK

RouteList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建路由

表 3.12. 查询参数

参数类型描述

dryRun

字符串

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

fieldManager

字符串

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

表 3.13. 主体参数

参数类型描述

正文(body)

Route 模式

 

表 3.14. HTTP 响应

HTTP 代码响应正文

200 - OK

Route 模式

201 - Created

Route 模式

202 - Accepted

Route 模式

401 - Unauthorized

3.1.2.4. /apis/route.openshift.io/v1/watch/namespaces/{namespace}/routes

表 3.15. 全局路径参数

参数类型描述

namespace

字符串

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

表 3.16. 全局查询参数

参数类型描述

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
描述
观察单个对 Route 列表的更改。已弃用:改为使用 'watch' 参数以及 list 操作。

表 3.17. HTTP 响应

HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

3.1.2.5. /apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}

表 3.18. 全局路径参数

参数类型描述

name

字符串

路由的名称

namespace

字符串

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

表 3.19. 全局查询参数

参数类型描述

pretty

字符串

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

HTTP 方法
DELETE
描述
删除路由

表 3.20. 查询参数

参数类型描述

dryRun

字符串

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

gracePeriodSeconds

整数

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

orphanDependents

布尔值

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

propagationPolicy

字符串

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

表 3.21. 主体参数

参数类型描述

正文(body)

DeleteOptions 模式

 

表 3.22. HTTP 响应

HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
读取指定的路由

表 3.23. HTTP 响应

HTTP 代码响应正文

200 - OK

Route 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的路由

表 3.24. 查询参数

参数类型描述

dryRun

字符串

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

fieldManager

字符串

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

force

布尔值

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

表 3.25. 主体参数

参数类型描述

正文(body)

Patch 模式

 

表 3.26. HTTP 响应

HTTP 代码响应正文

200 - OK

Route 模式

201 - Created

Route 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的路由

表 3.27. 查询参数

参数类型描述

dryRun

字符串

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

fieldManager

字符串

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

表 3.28. 主体参数

参数类型描述

正文(body)

Route 模式

 

表 3.29. HTTP 响应

HTTP 代码响应正文

200 - OK

Route 模式

201 - Created

Route 模式

401 - Unauthorized

3.1.2.6. /apis/route.openshift.io/v1/watch/namespaces/{namespace}/routes/{name}

表 3.30. 全局路径参数

参数类型描述

name

字符串

路由的名称

namespace

字符串

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

表 3.31. 全局查询参数

参数类型描述

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
描述
观察对类型为 Route 的对象的更改。已弃用:使用带有列表操作的 'watch' 参数,而是过滤到带有 'fieldSelector' 参数的单个项目。

表 3.32. HTTP 响应

HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

3.1.2.7. /apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}/status

表 3.33. 全局路径参数

参数类型描述

name

字符串

路由的名称

namespace

字符串

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

表 3.34. 全局查询参数

参数类型描述

pretty

字符串

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

HTTP 方法
GET
描述
指定路由的读取状态

表 3.35. HTTP 响应

HTTP 代码响应正文

200 - OK

Route 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
指定路由的部分更新状态

表 3.36. 查询参数

参数类型描述

dryRun

字符串

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

fieldManager

字符串

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

force

布尔值

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

表 3.37. 主体参数

参数类型描述

正文(body)

Patch 模式

 

表 3.38. HTTP 响应

HTTP 代码响应正文

200 - OK

Route 模式

201 - Created

Route 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定路由的状态

表 3.39. 查询参数

参数类型描述

dryRun

字符串

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

fieldManager

字符串

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

表 3.40. 主体参数

参数类型描述

正文(body)

Route 模式

 

表 3.41. HTTP 响应

HTTP 代码响应正文

200 - OK

Route 模式

201 - Created

Route 模式

401 - Unauthorized

第 4 章 安全 API

4.1. SecurityContextConstraints [security.openshift.io/v1]

描述
SecurityContextConstraints (SCC)监管了影响应用到容器的 SecurityContext 的请求的能力。使用 security.openshift.io 组来管理 SecurityContextConstraints。兼容性级别 1:在主发行版本中至少提供 12 个月或 3 个次版本(以更长的时间为准)。
类型
对象
必填
  • allowHostDirVolumePlugin
  • allowHostIPC
  • allowHostNetwork
  • allowHostPID
  • allowHostPorts
  • allowPrivilegedContainer
  • readOnlyRootFilesystem

4.1.1. 规格

属性类型描述

allowHostDirVolumePlugin

布尔值

AllowHostDirVolumePlugin 决定策略是否允许容器使用 HostDir 卷插件

allowHostIPC

布尔值

allowHostIPC 确定策略是否允许容器中的主机 ipc。

allowHostNetwork

布尔值

allowHostNetwork 决定策略是否允许在 pod spec 中使用 HostNetwork。

allowHostPID

布尔值

allowHostPID 确定策略是否允许容器中的 host pid。

allowHostPorts

布尔值

allowHostPorts 决定策略是否允许容器中的主机端口。

allowPrivilegeEscalation

``

allowPrivilegeEscalation 决定 pod 是否请求允许特权升级。如果未指定,则默认为 true。

allowPrivilegedContainer

布尔值

allowPrivilegedContainer 决定容器是否可以请求以特权方式运行。

allowedCapabilities

``

allowedCapabilities 是可请求添加到容器的功能列表。此字段中的功能可能会在 pod 作者自由裁量中添加。您不能列出 AllowedCapabilities 和 RequiredDropCapabilities 中的功能。要允许所有功能,您可以使用"Demo"。

allowedFlexVolumes

``

AllowedFlexVolumes 是允许的 Flexvolumes 的白名单。empty 或 nil 表示可以使用所有 Flexvolumes。只有在"Volumes"字段中允许使用 Flexvolumes 时,这个参数才有效。

allowedUnsafeSysctls

``

allowedUnsafeSysctls 是明确允许的不安全 sysctl 列表,默认为 none。每个条目都是普通 sysctl 名称,也可以是以 "" 结尾,在这种情况下,它被视为允许的 sysctl 的前缀。单站表示允许所有不安全 sysctl。kubelet 必须明确将所有允许的不安全 sysctl 列入白名单,以避免拒绝。示例:e.g. "foo/" allow "foo/bar", "foo/baz" 等,例如 "foo114" 允许 "foo.bar", "foo.baz" 等。

apiVersion

字符串

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

defaultAddCapabilities

``

defaultAddCapabilities 是添加到容器的默认功能集,除非 pod 规格特别丢弃该功能。您不能在 DefaultAddCapabilities 和 RequiredDropCapabilities 中列出 capabiility。

defaultAllowPrivilegeEscalation

``

defaultAllowPrivilegeEscalation 控制进程是否可以获得比父进程更多的特权的默认设置。

forbiddenSysctls

``

forbiddenSysctls 是明确禁止的 sysctl 列表,默认为 none。每个条目都是普通 sysctl 名称,也可以是以 "" 结尾,在这种情况下,它被视为禁止的 sysctl 前缀。单站表示所有 sysctl 都被禁止。示例:例如 "foo/" forbids "foo/bar", "foo/baz" 等,如 "foo the" forbids "foo.bar", "foo.baz" 等。

fsGroup

``

fsGroup 是指明 SecurityContext 使用什么 fs 组的策略。

groups

``

具有使用此安全性上下文约束权限的组

kind

字符串

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

元数据

ObjectMeta

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

priority

``

优先级根据 User and Groups 字段中的访问权限,决定在评估哪些 SCC 以先尝试给定 Pod 请求时 SCC 的排序顺序。int 越大,优先级更高。取消设置的值被视为 0 优先级。如果多个 SCC 的分数相等,则根据限制性最强到最强的排序。如果优先级和限制都相等,则 SCC 按照名称排序。

readOnlyRootFilesystem

布尔值

当设为 true 时,readOnlyRootFileSystem 将强制容器使用只读根文件系统运行。如果容器特别请求使用非读取的 root 文件系统运行,则 SCC 将拒绝 Pod。如果设置为 false,则容器可能以只读根文件系统运行(如果其希望但不会被强制运行)。

requiredDropCapabilities

``

requiredDropCapabilities 是从容器中丢弃的功能。这些需要被丢弃且无法添加。

runAsUser

``

runAsUser 是策略,它将指明 SecurityContext 中使用什么 RunAsUser。

seLinuxContext

``

seLinuxContext 是策略,它将指明在 SecurityContext 中设置哪些标签。

seccompProfiles

``

seccompProfiles 列出了可为 pod 或容器的 seccomp 注解设置的允许的配置集。unset (nil)或空值意味着 pod 或容器没有覆盖配置集。通配符 'IANA' 可以用来允许所有配置集。当为 pod 生成值时,第一个非通配符配置集将用作默认值。

supplementalGroups

``

supplementalGroups 是策略,它将指明 SecurityContext 使用哪些补充组。

users

``

具有使用此安全性上下文约束权限的用户

``

卷是允许卷插件的白名单列表。fstype 直接与 VolumeSource 的字段名称对应(azureFile、configMap、emptyDir)。要允许所有卷,您可以使用"Demo"。要允许卷,设置为 ["none"]。

4.1.2. API 端点

可用的 API 端点如下:

  • /apis/security.openshift.io/v1/securitycontextconstraints

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

    • GET: 观察对 SecurityContextConstraints 列表的各个更改。已弃用:将 'watch' 参数与列表操作一起使用。
  • /apis/security.openshift.io/v1/securitycontextconstraints/{name}

    • DELETE: delete SecurityContextConstraints
    • GET :读取指定的 SecurityContextConstraints
    • PATCH :部分更新指定的 SecurityContextConstraints
    • PUT :替换指定的 SecurityContextConstraints
  • /apis/security.openshift.io/v1/watch/securitycontextconstraints/{name}

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

4.1.2.1. /apis/security.openshift.io/v1/securitycontextconstraints

表 4.1. 全局查询参数

参数类型描述

pretty

字符串

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

HTTP 方法
DELETE
描述
删除 SecurityContextConstraints 集合

表 4.2. 查询参数

参数类型描述

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。

表 4.3. HTTP 响应

HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出 SecurityContextConstraints 类型的对象

表 4.4. 查询参数

参数类型描述

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。

表 4.5. HTTP 响应

HTTP 代码响应正文

200 - OK

SecurityContextConstraintsList schema

401 - Unauthorized

HTTP 方法
POST
描述
创建 SecurityContextConstraints

表 4.6. 查询参数

参数类型描述

dryRun

字符串

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

fieldManager

字符串

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

fieldValidation

字符串

fieldValidation 指示服务器如何处理包含未知或重复字段的请求中的对象(POST/PUT/PATCH),只要也启用了"ServerSideFieldValidation"功能门。有效值为:- Ignore:这将忽略任何从对象中静默丢弃的未知字段,并将忽略解码器遇到的最后一个重复字段。这是 v1.23 之前的默认行为,是禁用 'ServerSideFieldValidation' 功能门时的默认行为。- Warn: 这将通过来自对象丢弃的每个未知字段的标准警告响应标头发送警告。如果没有其他错误,请求仍会成功,并且仅保留任何重复字段的最后一个字段。当启用 'ServerSideFieldValidation' 功能门时,这是默认设置。- Strict: 如果从对象中丢弃了任何未知字段,则会失败,并带有 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

表 4.7. 主体参数

参数类型描述

正文(body)

SecurityContextConstraints 模式

 

表 4.8. HTTP 响应

HTTP 代码响应正文

200 - OK

SecurityContextConstraints 模式

201 - Created

SecurityContextConstraints 模式

202 - Accepted

SecurityContextConstraints 模式

401 - Unauthorized

4.1.2.2. /apis/security.openshift.io/v1/watch/securitycontextconstraints

表 4.9. 全局查询参数

参数类型描述

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
描述
观察对 SecurityContextConstraints 列表的各个更改。已弃用:改为使用 'watch' 参数和列表操作。

表 4.10. HTTP 响应

HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

4.1.2.3. /apis/security.openshift.io/v1/securitycontextconstraints/{name}

表 4.11. 全局路径参数

参数类型描述

name

字符串

SecurityContextConstraints 的名称

表 4.12. 全局查询参数

参数类型描述

pretty

字符串

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

HTTP 方法
DELETE
描述
delete SecurityContextConstraints

表 4.13. 查询参数

参数类型描述

dryRun

字符串

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

gracePeriodSeconds

整数

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

orphanDependents

布尔值

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

propagationPolicy

字符串

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

表 4.14. 主体参数

参数类型描述

正文(body)

DeleteOptions 模式

 

表 4.15. HTTP 响应

HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
读取指定的 SecurityContextConstraints

表 4.16. 查询参数

参数类型描述

resourceVersion

字符串

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

默认为未设置

表 4.17. HTTP 响应

HTTP 代码响应正文

200 - OK

SecurityContextConstraints 模式

401 - Unauthorized

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

表 4.18. 查询参数

参数类型描述

dryRun

字符串

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

fieldManager

字符串

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

fieldValidation

字符串

fieldValidation 指示服务器如何处理包含未知或重复字段的请求中的对象(POST/PUT/PATCH),只要也启用了"ServerSideFieldValidation"功能门。有效值为:- Ignore:这将忽略任何从对象中静默丢弃的未知字段,并将忽略解码器遇到的最后一个重复字段。这是 v1.23 之前的默认行为,是禁用 'ServerSideFieldValidation' 功能门时的默认行为。- Warn: 这将通过来自对象丢弃的每个未知字段的标准警告响应标头发送警告。如果没有其他错误,请求仍会成功,并且仅保留任何重复字段的最后一个字段。当启用 'ServerSideFieldValidation' 功能门时,这是默认设置。- Strict: 如果从对象中丢弃了任何未知字段,则会失败,并带有 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

表 4.19. 主体参数

参数类型描述

正文(body)

Patch 模式

 

表 4.20. HTTP 响应

HTTP 代码响应正文

200 - OK

SecurityContextConstraints 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 SecurityContextConstraints

表 4.21. 查询参数

参数类型描述

dryRun

字符串

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

fieldManager

字符串

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

fieldValidation

字符串

fieldValidation 指示服务器如何处理包含未知或重复字段的请求中的对象(POST/PUT/PATCH),只要也启用了"ServerSideFieldValidation"功能门。有效值为:- Ignore:这将忽略任何从对象中静默丢弃的未知字段,并将忽略解码器遇到的最后一个重复字段。这是 v1.23 之前的默认行为,是禁用 'ServerSideFieldValidation' 功能门时的默认行为。- Warn: 这将通过来自对象丢弃的每个未知字段的标准警告响应标头发送警告。如果没有其他错误,请求仍会成功,并且仅保留任何重复字段的最后一个字段。当启用 'ServerSideFieldValidation' 功能门时,这是默认设置。- Strict: 如果从对象中丢弃了任何未知字段,则会失败,并带有 BadRequest 错误。从服务器返回的错误将包含遇到的所有未知和重复字段。

表 4.22. 主体参数

参数类型描述

正文(body)

SecurityContextConstraints 模式

 

表 4.23. HTTP 响应

HTTP 代码响应正文

200 - OK

SecurityContextConstraints 模式

201 - Created

SecurityContextConstraints 模式

401 - Unauthorized

4.1.2.4. /apis/security.openshift.io/v1/watch/securitycontextconstraints/{name}

表 4.24. 全局路径参数

参数类型描述

name

字符串

SecurityContextConstraints 的名称

表 4.25. 全局查询参数

参数类型描述

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
描述
观察对类型为 SecurityContextConstraints 的对象的更改。已弃用:使用带有列表操作的 'watch' 参数,而是过滤到带有 'fieldSelector' 参数的单个项目。

表 4.26. HTTP 响应

HTTP 代码响应正文

200 - OK

WatchEvent 模式

401 - Unauthorized

法律通告

Copyright © 2023 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat 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 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.