路由 [route.openshift.io/v1] - 网络 API | API 参考 | OpenShift Container Platform 4.17

规范
API 端点

描述

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

创建路由后，host 字段将无法更改。通常，路由器在解决冲突时使用具有给定主机名的最旧路由。

路由器可以进行额外的自定义，并且可以通过注释字段支持额外的控制。

因为管理员可以配置多个路由器，所以路由状态字段用于将有关每个路由器下路由名称和状态的信息返回给客户端。例如，如果客户端选择重复名称，则路由状态条件用于指示无法选择路由。

要在路由上启用 HTTP/2 ALPN，需要自定义（非通配符）证书。这可以防止客户端（尤其是 Web 浏览器）连接合并。我们不支持使用默认证书的路由上的 HTTP/2 ALPN，因为存在连接重用/合并的风险。没有自定义证书的路由在前端或后端都不会启用 HTTP/2 ALPN。

兼容性级别 1：在主要版本中稳定至少 12 个月或 3 个次要版本（以较长者为准）。

类型

对象

必需

spec

规范

属性类型描述

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。不能更新。使用驼峰式命名法。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta_v2`	metadata 是标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	RouteSpec 描述路由公开的主机名或路径、任何安全信息以及路由指向的 1 到 4 个后端（服务）。请求根据分配给每个后端的权重在后端之间分配。使用轮询调度时，转到每个后端的请求部分是后端权重除以所有后端权重的总和。当后端有多个端点时，最终到达后端的请求将在端点之间进行轮询分配。权重介于 0 和 256 之间，默认为 100。权重为 0 则不会向后端发送请求。如果所有权重均为零，则该路由将被视为没有后端，并返回标准的 503 响应。 `tls` 字段是可选的，允许为路由指定证书或行为。路由器通常在通配符域上配置默认证书以终止没有显式证书的路由，但自定义主机名通常必须选择直通（通过 TLS 服务器名称指示字段直接将流量发送到后端）或提供证书。
`status`	`对象`	RouteStatus 提供有关路由状态的相关信息，包括哪些路由器已确认它。

apiVersion

字符串

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

kind

字符串

Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。不能更新。使用驼峰式命名法。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta_v2

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

spec

对象

RouteSpec 描述路由公开的主机名或路径、任何安全信息以及路由指向的 1 到 4 个后端（服务）。请求根据分配给每个后端的权重在后端之间分配。使用轮询调度时，转到每个后端的请求部分是后端权重除以所有后端权重的总和。当后端有多个端点时，最终到达后端的请求将在端点之间进行轮询分配。权重介于 0 和 256 之间，默认为 100。权重为 0 则不会向后端发送请求。如果所有权重均为零，则该路由将被视为没有后端，并返回标准的 503 响应。

tls 字段是可选的，允许为路由指定证书或行为。路由器通常在通配符域上配置默认证书以终止没有显式证书的路由，但自定义主机名通常必须选择直通（通过 TLS 服务器名称指示字段直接将流量发送到后端）或提供证书。

status

对象

RouteStatus 提供有关路由状态的相关信息，包括哪些路由器已确认它。

.spec

描述

类型

对象

必需

to

属性类型描述

属性	类型	描述
`alternateBackends`	`数组`	alternateBackends 允许最多为路由分配 3 个其他后端。只允许 Service 类型，它将默认为 Service。使用 RouteTargetReference 对象中的 weight 字段指定相对优先级。
`alternateBackends[]`	`对象`	RouteTargetReference 指定解析为端点的目标。“Service”类型是唯一允许的类型。使用“weight”字段来强调一个目标的重要性。
`host`	`字符串`	host 是指向服务的别名/DNS。可选。如果未指定，通常会自动选择路由名称。必须遵循 DNS952 子域约定。
`httpHeaders`	`对象`	RouteHTTPHeaders 定义 HTTP 标头的策略。
`path`	`字符串`	路由器监视的路径，用于将流量路由到服务。可选
`port`	`对象`	RoutePort 定义了从路由器到服务端点中端点的端口映射。
`子域名`	`字符串`	子域名是在入口控制器域名内请求的 DNS 子域名（作为子域名）。如果设置了 host，则忽略此字段。入口控制器可以选择忽略此建议名称，在这种情况下，控制器将在 status.ingress 数组中报告分配的名称或拒绝接收路由。如果设置了此值且服务器不支持此字段，则会自动填充 host。否则，host 保持为空。该字段可以使用点分隔多个部分，但并非所有入口控制器都会遵守此请求。创建后，除非拥有更新路由/自定义主机权限的用户，否则此字段不能更改。示例：子域名 `frontend` 会自动接收路由器子域名 `apps.mycluster.com` 以形成完整的主机名 `frontend.apps.mycluster.com`。
`TLS`	`对象`	TLSConfig 定义用于保护路由并提供终止的配置。
`to`	`对象`	RouteTargetReference 指定解析为端点的目标。“Service”类型是唯一允许的类型。使用“weight”字段来强调一个目标的重要性。
`通配符策略`	`字符串`	路由的通配符策略（如有）。目前仅允许“子域名”或“无”。

alternateBackends

数组

alternateBackends 允许最多为路由分配 3 个其他后端。只允许 Service 类型，它将默认为 Service。使用 RouteTargetReference 对象中的 weight 字段指定相对优先级。

alternateBackends[]

对象

RouteTargetReference 指定解析为端点的目标。“Service”类型是唯一允许的类型。使用“weight”字段来强调一个目标的重要性。

host

字符串

host 是指向服务的别名/DNS。可选。如果未指定，通常会自动选择路由名称。必须遵循 DNS952 子域约定。

httpHeaders

对象

RouteHTTPHeaders 定义 HTTP 标头的策略。

path

字符串

路由器监视的路径，用于将流量路由到服务。可选

port

对象

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

子域名

字符串

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

示例：子域名 `frontend` 会自动接收路由器子域名 `apps.mycluster.com` 以形成完整的主机名 `frontend.apps.mycluster.com`。

TLS

对象

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

to

对象

RouteTargetReference 指定解析为端点的目标。“Service”类型是唯一允许的类型。使用“weight”字段来强调一个目标的重要性。

通配符策略

字符串

路由的通配符策略（如有）。目前仅允许“子域名”或“无”。

.spec.alternateBackends

描述: alternateBackends 允许最多为路由分配 3 个其他后端。只允许 Service 类型，它将默认为 Service。使用 RouteTargetReference 对象中的 weight 字段指定相对优先级。
类型: 数组

.spec.alternateBackends[]

描述

RouteTargetReference 指定解析为端点的目标。“Service”类型是唯一允许的类型。使用“weight”字段来强调一个目标的重要性。

类型

对象

必需

kind
名称

属性类型描述

属性	类型	描述
`kind`	`字符串`	路由所引用的目标的种类。目前，只允许“服务”。
`名称`	`字符串`	所引用服务/目标的名称，例如服务的名称。
`权重`	`整数`	介于 0 到 256 之间的整数权重，默认为 100，指定目标相对于其他目标引用对象的相对权重。0 表示禁止对此后端发出请求。

kind

字符串

路由所引用的目标的种类。目前，只允许“服务”。

名称

字符串

所引用服务/目标的名称，例如服务的名称。

权重

整数

介于 0 到 256 之间的整数权重，默认为 100，指定目标相对于其他目标引用对象的相对权重。0 表示禁止对此后端发出请求。

.spec.httpHeaders

描述: RouteHTTPHeaders 定义 HTTP 标头的策略。
类型: 对象

属性类型描述

属性	类型	描述
`操作`	`对象`	RouteHTTPHeaderActions 定义了对 HTTP 请求和响应报头操作的配置。

操作

对象

RouteHTTPHeaderActions 定义了对 HTTP 请求和响应报头操作的配置。

.spec.httpHeaders.actions

描述: RouteHTTPHeaderActions 定义了对 HTTP 请求和响应报头操作的配置。
类型: 对象

属性类型描述

属性	类型	描述
`请求`	`数组`	request 是要修改的 HTTP 请求报头的列表。目前，操作可以定义为 `Set` 或 `Delete` 报头值。此处定义的操作将修改通过路由发出的所有请求的请求报头。这些操作应用于集群内定义的特定路由，即通过路由建立的连接。目前，操作可以定义为 `Set` 或 `Delete` 报头值。路由操作将在入口控制器对请求报头的操作之后执行。操作按此列表中定义的顺序应用。最多可以配置 20 个请求报头操作。您可以使用此字段指定在将客户端连接转发到您的应用程序时应设置或删除的 HTTP 请求报头。允许的示例提取器为“req.hdr”和“ssl_c_der”。允许的转换器为“lower”和“base64”。示例报头值：“%[req.hdr(X-target),lower]”、“%{+Q}[ssl_c_der,base64]”。使用此 API 通过 Route 资源直接应用的任何请求报头配置都将覆盖通过入口控制器的 spec.httpHeaders.actions 或路由注释应用的相同名称报头的报头配置。注意：如果您的路由使用 TLS 直通，则不能使用此字段。
`request[]`	`对象`	RouteHTTPHeader 指定了设置或删除 HTTP 报头的配置。
`响应`	`数组`	response 是要修改的 HTTP 响应报头的列表。目前，操作可以定义为 `Set` 或 `Delete` 报头值。此处定义的操作将修改通过路由发出的所有请求的响应报头。这些操作应用于集群内定义的特定路由，即通过路由建立的连接。路由操作将在入口控制器对响应报头的操作之前执行。操作按此列表中定义的顺序应用。最多可以配置 20 个响应报头操作。您可以使用此字段指定在将响应从您的应用程序转发到客户端时应设置或删除的 HTTP 响应报头。允许的示例提取器为“res.hdr”和“ssl_c_der”。允许的转换器为“lower”和“base64”。示例报头值：“%[res.hdr(X-target),lower]”、“%{+Q}[ssl_c_der,base64]”。注意：如果您的路由使用 TLS 直通，则不能使用此字段。
`response[]`	`对象`	RouteHTTPHeader 指定了设置或删除 HTTP 报头的配置。

请求

数组

request 是要修改的 HTTP 请求报头的列表。目前，操作可以定义为 `Set` 或 `Delete` 报头值。此处定义的操作将修改通过路由发出的所有请求的请求报头。这些操作应用于集群内定义的特定路由，即通过路由建立的连接。目前，操作可以定义为 `Set` 或 `Delete` 报头值。路由操作将在入口控制器对请求报头的操作之后执行。操作按此列表中定义的顺序应用。最多可以配置 20 个请求报头操作。您可以使用此字段指定在将客户端连接转发到您的应用程序时应设置或删除的 HTTP 请求报头。允许的示例提取器为“req.hdr”和“ssl_c_der”。允许的转换器为“lower”和“base64”。示例报头值：“%[req.hdr(X-target),lower]”、“%{+Q}[ssl_c_der,base64]”。使用此 API 通过 Route 资源直接应用的任何请求报头配置都将覆盖通过入口控制器的 spec.httpHeaders.actions 或路由注释应用的相同名称报头的报头配置。注意：如果您的路由使用 TLS 直通，则不能使用此字段。

request[]

对象

RouteHTTPHeader 指定了设置或删除 HTTP 报头的配置。

响应

数组

response 是要修改的 HTTP 响应报头的列表。目前，操作可以定义为 `Set` 或 `Delete` 报头值。此处定义的操作将修改通过路由发出的所有请求的响应报头。这些操作应用于集群内定义的特定路由，即通过路由建立的连接。路由操作将在入口控制器对响应报头的操作之前执行。操作按此列表中定义的顺序应用。最多可以配置 20 个响应报头操作。您可以使用此字段指定在将响应从您的应用程序转发到客户端时应设置或删除的 HTTP 响应报头。允许的示例提取器为“res.hdr”和“ssl_c_der”。允许的转换器为“lower”和“base64”。示例报头值：“%[res.hdr(X-target),lower]”、“%{+Q}[ssl_c_der,base64]”。注意：如果您的路由使用 TLS 直通，则不能使用此字段。

response[]

对象

RouteHTTPHeader 指定了设置或删除 HTTP 报头的配置。

.spec.httpHeaders.actions.request

描述: request 是要修改的 HTTP 请求报头的列表。目前，操作可以定义为 `Set` 或 `Delete` 报头值。此处定义的操作将修改通过路由发出的所有请求的请求报头。这些操作应用于集群内定义的特定路由，即通过路由建立的连接。目前，操作可以定义为 `Set` 或 `Delete` 报头值。路由操作将在入口控制器对请求报头的操作之后执行。操作按此列表中定义的顺序应用。最多可以配置 20 个请求报头操作。您可以使用此字段指定在将客户端连接转发到您的应用程序时应设置或删除的 HTTP 请求报头。允许的示例提取器为“req.hdr”和“ssl_c_der”。允许的转换器为“lower”和“base64”。示例报头值：“%[req.hdr(X-target),lower]”、“%{+Q}[ssl_c_der,base64]”。使用此 API 通过 Route 资源直接应用的任何请求报头配置都将覆盖通过入口控制器的 spec.httpHeaders.actions 或路由注释应用的相同名称报头的报头配置。注意：如果您的路由使用 TLS 直通，则不能使用此字段。
类型: 数组

.spec.httpHeaders.actions.request[]

描述

RouteHTTPHeader 指定了设置或删除 HTTP 报头的配置。

类型

对象

必需

名称
操作

属性类型描述

属性	类型	描述
`操作`	`对象`	RouteHTTPHeaderActionUnion 指定对 HTTP 报头采取的操作。
`名称`	`字符串`	name 指定要对其执行操作的报头的名称。其值必须是 RFC 2616 第 4.2 节中定义的有效 HTTP 报头名称。名称只能包含字母数字字符和以下特殊字符：“-!#$%&'*+.^_`”。以下报头名称是保留的，不能通过此 API 修改：Strict-Transport-Security、Proxy、Cookie、Set-Cookie。其长度不得超过 255 个字符。报头名称必须唯一。

操作

对象

RouteHTTPHeaderActionUnion 指定对 HTTP 报头采取的操作。

名称

字符串

name 指定要对其执行操作的报头的名称。其值必须是 RFC 2616 第 4.2 节中定义的有效 HTTP 报头名称。名称只能包含字母数字字符和以下特殊字符：“-!#$%&'*+.^_`”。以下报头名称是保留的，不能通过此 API 修改：Strict-Transport-Security、Proxy、Cookie、Set-Cookie。其长度不得超过 255 个字符。报头名称必须唯一。

.spec.httpHeaders.actions.request[].action

描述

RouteHTTPHeaderActionUnion 指定对 HTTP 报头采取的操作。

类型

对象

必需

类型

属性类型描述

属性	类型	描述
`设置`	`对象`	RouteSetHTTPHeader 指定需要在 HTTP 报头上设置什么值。
`类型`	`字符串`	type 定义要应用于报头的操作类型。可能的值为 Set 或 Delete。Set 允许您设置 HTTP 请求和响应报头。Delete 允许您删除 HTTP 请求和响应报头。

设置

对象

RouteSetHTTPHeader 指定需要在 HTTP 报头上设置什么值。

类型

字符串

type 定义要应用于报头的操作类型。可能的值为 Set 或 Delete。Set 允许您设置 HTTP 请求和响应报头。Delete 允许您删除 HTTP 请求和响应报头。

.spec.httpHeaders.actions.request[].action.set

描述

RouteSetHTTPHeader 指定需要在 HTTP 报头上设置什么值。

类型

对象

必需

值

属性类型描述

属性	类型	描述
`值`	`字符串`	value 指定报头值。可以添加动态值。该值将被解释为 http://cbonte.github.io/haproxy-dconv/2.6/configuration.html#8.2.6 中定义的 HAProxy 格式字符串，可以使用 HAProxy 的 %[] 语法，否则必须是 https://datatracker.ietf.org/doc/html/rfc7230#section-3.2 中定义的有效 HTTP 报头值。此字段的值长度不得超过 16384 个字符。请注意，在内插动态值后，所有净添加报头的总大小不得超过入口控制器的 spec.tuningOptions.headerBufferMaxRewriteBytes 值。

值

字符串

value 指定报头值。可以添加动态值。该值将被解释为 http://cbonte.github.io/haproxy-dconv/2.6/configuration.html#8.2.6 中定义的 HAProxy 格式字符串，可以使用 HAProxy 的 %[] 语法，否则必须是 https://datatracker.ietf.org/doc/html/rfc7230#section-3.2 中定义的有效 HTTP 报头值。此字段的值长度不得超过 16384 个字符。请注意，**在**内插动态值后，所有净添加报头的总大小不得超过入口控制器的 spec.tuningOptions.headerBufferMaxRewriteBytes 值。

.spec.httpHeaders.actions.response

描述: response 是要修改的 HTTP 响应报头的列表。目前，操作可以定义为 `Set` 或 `Delete` 报头值。此处定义的操作将修改通过路由发出的所有请求的响应报头。这些操作应用于集群内定义的特定路由，即通过路由建立的连接。路由操作将在入口控制器对响应报头的操作之前执行。操作按此列表中定义的顺序应用。最多可以配置 20 个响应报头操作。您可以使用此字段指定在将响应从您的应用程序转发到客户端时应设置或删除的 HTTP 响应报头。允许的示例提取器为“res.hdr”和“ssl_c_der”。允许的转换器为“lower”和“base64”。示例报头值：“%[res.hdr(X-target),lower]”、“%{+Q}[ssl_c_der,base64]”。注意：如果您的路由使用 TLS 直通，则不能使用此字段。
类型: 数组

.spec.httpHeaders.actions.response[]

描述

RouteHTTPHeader 指定了设置或删除 HTTP 报头的配置。

类型

对象

必需

名称
操作

属性类型描述

属性	类型	描述
`操作`	`对象`	RouteHTTPHeaderActionUnion 指定对 HTTP 报头采取的操作。
`名称`	`字符串`	name 指定要对其执行操作的报头的名称。其值必须是 RFC 2616 第 4.2 节中定义的有效 HTTP 报头名称。名称只能包含字母数字字符和以下特殊字符：“-!#$%&'*+.^_`”。以下报头名称是保留的，不能通过此 API 修改：Strict-Transport-Security、Proxy、Cookie、Set-Cookie。其长度不得超过 255 个字符。报头名称必须唯一。

操作

对象

RouteHTTPHeaderActionUnion 指定对 HTTP 报头采取的操作。

名称

字符串

.spec.httpHeaders.actions.response[].action

描述

RouteHTTPHeaderActionUnion 指定对 HTTP 报头采取的操作。

类型

对象

必需

类型

属性类型描述

属性	类型	描述
`设置`	`对象`	RouteSetHTTPHeader 指定需要在 HTTP 报头上设置什么值。
`类型`	`字符串`	type 定义要应用于报头的操作类型。可能的值为 Set 或 Delete。Set 允许您设置 HTTP 请求和响应报头。Delete 允许您删除 HTTP 请求和响应报头。

设置

对象

RouteSetHTTPHeader 指定需要在 HTTP 报头上设置什么值。

类型

字符串

type 定义要应用于报头的操作类型。可能的值为 Set 或 Delete。Set 允许您设置 HTTP 请求和响应报头。Delete 允许您删除 HTTP 请求和响应报头。

.spec.httpHeaders.actions.response[].action.set

描述

RouteSetHTTPHeader 指定需要在 HTTP 报头上设置什么值。

类型

对象

必需

值

属性类型描述

属性	类型	描述
`值`	`字符串`	value 指定报头值。可以添加动态值。该值将被解释为 http://cbonte.github.io/haproxy-dconv/2.6/configuration.html#8.2.6 中定义的 HAProxy 格式字符串，可以使用 HAProxy 的 %[] 语法，否则必须是 https://datatracker.ietf.org/doc/html/rfc7230#section-3.2 中定义的有效 HTTP 报头值。此字段的值长度不得超过 16384 个字符。请注意，在内插动态值后，所有净添加报头的总大小不得超过入口控制器的 spec.tuningOptions.headerBufferMaxRewriteBytes 值。

值

字符串

.spec.port

描述

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

类型

对象

必需

目标端口

属性类型描述

属性	类型	描述
`目标端口`	`IntOrString`	此路由指向的服务选择的 Pod 上的目标端口。如果这是一个字符串，它将作为目标端点端口列表中的命名端口查找。必需

目标端口

IntOrString

此路由指向的服务选择的 Pod 上的目标端口。如果这是一个字符串，它将作为目标端点端口列表中的命名端口查找。必需

.spec.tls

描述

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

类型

对象

必需

终止

属性类型描述

属性	类型	描述
`ca证书`	`字符串`	caCertificate 提供证书颁发机构证书内容。
`证书`	`字符串`	certificate 提供证书内容。这应该是一个单独的服务证书，而不是证书链。不要包含 CA 证书。
`目标 CA 证书`	`字符串`	destinationCACertificate 提供最终目标的 CA 证书内容。使用重新加密终止时，应提供此文件以便路由器将其用于安全连接的健康检查。如果未指定此字段，路由器可能会提供其自己的目标 CA 并使用短服务名称 (service.namespace.svc) 执行主机名验证，从而允许基础设施生成的证书自动验证。
`externalCertificate`	`对象`	LocalObjectReference 包含足够的信息，可让您在同一命名空间内找到引用的对象。
`insecureEdgeTerminationPolicy`	`字符串`	insecureEdgeTerminationPolicy 指示对路由器的非安全连接所需的行為。虽然每个路由器可能会自行决定要公开哪些端口，但这通常是 80 端口。如果路由未指定 insecureEdgeTerminationPolicy，则默认行为为“None”。 * Allow - 流量将发送到非安全端口上的服务器（仅限边缘/重新加密终止）。 * None - 非安全端口不允许任何流量（默认值）。 * Redirect - 客户端将重定向到安全端口。
`key`	`字符串`	key 提供密钥文件内容。
`终止`	`字符串`	termination 指示终止类型。 * edge - TLS 终止由路由器完成，并使用 http 与后端通信（默认值）* passthrough - 流量直接发送到目标，而路由器不提供 TLS 终止 * reencrypt - TLS 终止由路由器完成，并使用 https 与后端通信注意：passthrough 终止与 httpHeader 操作不兼容。

ca证书

字符串

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

证书

字符串

certificate 提供证书内容。这应该是一个单独的服务证书，而不是证书链。不要包含 CA 证书。

目标 CA 证书

字符串

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

externalCertificate

对象

LocalObjectReference 包含足够的信息，可让您在同一命名空间内找到引用的对象。

insecureEdgeTerminationPolicy

字符串

insecureEdgeTerminationPolicy 指示对路由器的非安全连接所需的行為。虽然每个路由器可能会自行决定要公开哪些端口，但这通常是 80 端口。

如果路由未指定 insecureEdgeTerminationPolicy，则默认行为为“None”。

* Allow - 流量将发送到非安全端口上的服务器（仅限边缘/重新加密终止）。

* None - 非安全端口不允许任何流量（默认值）。

* Redirect - 客户端将重定向到安全端口。

key

字符串

key 提供密钥文件内容。

终止

字符串

termination 指示终止类型。

* edge - TLS 终止由路由器完成，并使用 http 与后端通信（默认值）* passthrough - 流量直接发送到目标，而路由器不提供 TLS 终止 * reencrypt - TLS 终止由路由器完成，并使用 https 与后端通信

注意：passthrough 终止与 httpHeader 操作不兼容。

.spec.tls.externalCertificate

描述: LocalObjectReference 包含足够的信息，可让您在同一命名空间内找到引用的对象。
类型: 对象

属性类型描述

属性	类型	描述
`名称`	`字符串`	引用的名称。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names

名称

字符串

.spec.to

描述

RouteTargetReference 指定解析为端点的目标。“Service”类型是唯一允许的类型。使用“weight”字段来强调一个目标的重要性。

类型

对象

必需

kind
名称

属性类型描述

属性	类型	描述
`kind`	`字符串`	路由所引用的目标的种类。目前，只允许“服务”。
`名称`	`字符串`	所引用服务/目标的名称，例如服务的名称。
`权重`	`整数`	介于 0 到 256 之间的整数权重，默认为 100，指定目标相对于其他目标引用对象的相对权重。0 表示禁止对此后端发出请求。

kind

字符串

路由所引用的目标的种类。目前，只允许“服务”。

名称

字符串

所引用服务/目标的名称，例如服务的名称。

权重

整数

介于 0 到 256 之间的整数权重，默认为 100，指定目标相对于其他目标引用对象的相对权重。0 表示禁止对此后端发出请求。

.status

描述: RouteStatus 提供有关路由状态的相关信息，包括哪些路由器已确认它。
类型: 对象

属性类型描述

属性	类型	描述
`ingress`	`数组`	ingress 描述路由可能公开的位置。入口点列表可能包含重复的主机名或路由器名称值。路由一旦处于`Ready`状态即被视为活动状态。
`ingress[]`	`对象`	RouteIngress 保存有关路由公开位置的信息。

ingress

数组

ingress 描述路由可能公开的位置。入口点列表可能包含重复的主机名或路由器名称值。路由一旦处于Ready状态即被视为活动状态。

ingress[]

对象

RouteIngress 保存有关路由公开位置的信息。

.status.ingress

描述: ingress 描述路由可能公开的位置。入口点列表可能包含重复的主机名或路由器名称值。路由一旦处于Ready状态即被视为活动状态。
类型: 数组

.status.ingress[]

描述: RouteIngress 保存有关路由公开位置的信息。
类型: 对象

属性类型描述

属性	类型	描述
`conditions`	`数组`	Conditions 是路由的状态，可能为空。
`conditions[]`	`对象`	RouteIngressCondition 包含此路由在特定路由器上的当前状态的详细信息。
`host`	`字符串`	Host 是公开路由的主机字符串；此值是必需的。
`routerCanonicalHostname`	`字符串`	CanonicalHostname 是路由器的外部主机名，可用作此路由请求的主机的 CNAME。此值是可选的，并非在所有情况下都设置。
`Name 是路由器选择用于标识自身的名称；此值是必需的。`	`字符串`	routerName
`通配符策略`	`字符串`	通配符策略是在公开此路由的位置允许的通配符策略。

conditions

数组

Conditions 是路由的状态，可能为空。

conditions[]

对象

RouteIngressCondition 包含此路由在特定路由器上的当前状态的详细信息。

host

字符串

Host 是公开路由的主机字符串；此值是必需的。

routerCanonicalHostname

字符串

CanonicalHostname 是路由器的外部主机名，可用作此路由请求的主机的 CNAME。此值是可选的，并非在所有情况下都设置。

Name 是路由器选择用于标识自身的名称；此值是必需的。

字符串

routerName

通配符策略

字符串

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

.status.ingress[].conditions

描述: Conditions 是路由的状态，可能为空。
类型: 数组

.status.ingress[].conditions[]

描述

RouteIngressCondition 包含此路由在特定路由器上的当前状态的详细信息。

类型

对象

必需

类型
status

属性类型描述

属性	类型	描述
`lastTransitionTime`	`Time`	此条件上次转换时的 RFC 3339 日期和时间。
`message`	`字符串`	指示上次转换详细信息的人类可读消息。
`reason`	`字符串`	条件上次转换的（简短）原因，通常是机器和人类可读的常量。
`status`	`字符串`	Status 是条件的状态。可以是 True、False、Unknown。
`类型`	`字符串`	Type 是条件的类型。目前只有 Admitted 或 UnservableInFutureVersions。

lastTransitionTime

Time

此条件上次转换时的 RFC 3339 日期和时间。

message

字符串

指示上次转换详细信息的人类可读消息。

reason

字符串

条件上次转换的（简短）原因，通常是机器和人类可读的常量。

status

字符串

Status 是条件的状态。可以是 True、False、Unknown。

类型

字符串

Type 是条件的类型。目前只有 Admitted 或 UnservableInFutureVersions。

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：删除 Route 集合
- GET：列出或监视 Route 类型对象
- POST：创建一个 Route
/apis/route.openshift.io/v1/watch/namespaces/{namespace}/routes
- GET：监视 Route 列表的单个更改。已弃用：改用列表操作中的“watch”参数。
/apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}
- DELETE：删除一个 Route
- GET：读取指定的 Route
- PATCH：部分更新指定的 Route
- PUT：替换指定的 Route
/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：部分更新指定的 Route 的状态
- PUT：替换指定的 Route 的状态

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

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

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

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

HTTP 方法: GET
描述: 监视 Route 列表的单个更改。已弃用：改用列表操作中的“watch”参数。

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

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

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

表 3. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

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

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

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

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

表 6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何静默从对象中删除的未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 7. 主体参数
参数	类型	描述
`body`	`Route` 模式

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

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

HTTP 方法: GET
描述: 监视 Route 列表的单个更改。已弃用：改用列表操作中的“watch”参数。

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

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

表 10. 全局路径参数
参数	类型	描述
`名称`	`字符串`	Route 的名称

HTTP 方法: DELETE
描述: 删除一个 Route

表 11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

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

HTTP 方法: GET
描述: 读取指定的 Route

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

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

表 14. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何静默从对象中删除的未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

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

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

表 16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何静默从对象中删除的未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 17. 主体参数
参数	类型	描述
`body`	`Route` 模式

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

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

表 19. 全局路径参数
参数	类型	描述
`名称`	`字符串`	Route 的名称

HTTP 方法: GET
描述: 监控 Route 对象类型的变更。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数将其过滤为单个项目。

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

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

表 21. 全局路径参数
参数	类型	描述
`名称`	`字符串`	Route 的名称

HTTP 方法: GET
描述: 读取指定 Route 的状态

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

HTTP 方法: PATCH
描述: 部分更新指定 Route 的状态

表 23. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何静默从对象中删除的未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

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

HTTP 方法: PUT
描述: 替换指定 Route 的状态

表 25. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何静默从对象中删除的未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 26. 主体参数
参数	类型	描述
`body`	`Route` 模式

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