22.2. 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 个次版本（以更长的时间为准）。

类型

object

必填

spec

22.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`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`object`	spec 是路由的所需状态
`status`	`object`	Status 是路由的当前状态

22.2.1.1. .spec

描述

spec 是路由的所需状态

类型

object

必填

至

属性	类型	描述
`alternateBackends`	`array`	alternateBackends 允许最多 3 个额外的后端分配给路由。只允许 Service kind，它将默认为 Service。使用 RouteTargetReference 对象中的 weight 字段指定相对的首选项。
`alternateBackends[]`	`对象`	RouteTargetReference 指定解析为端点的目标。只允许 'Service' kind。使用"weight"字段加重其他字段。
`主机`	`字符串`	主机是一个指向该服务的别名/DNS。可选。如果没有指定路由名称，则通常会自动选择。必须遵循 DNS952 子域惯例。
`path`	`字符串`	路由器监视的路径，将流量路由到该服务的流量。选填
`port`	`object`	如果指定，路由器要使用的端口。大多数路由器默认使用服务公开的所有端点 - 设置此值以指示要使用的端口的路由器。
`subdomain`	`字符串`	子域是在入口控制器的域（作为子域）中请求的 DNS 子域。如果设置 host，则忽略此字段。入口控制器可能会选择忽略这个建议的名称，在这种情况下，控制器会在 status.ingress 数组中报告分配的名称，或拒绝接受该路由。如果设置了这个值，且服务器不支持此字段，主机则会自动填充。否则主机将留空。该字段可能有多个以点分开的部分，但并非所有入口控制器都遵守请求。创建后无法更改此字段，但具有更新路由/自定义主机权限的用户除外。示例：子域 `frontend` 会自动接收路由器子域 `apps.mycluster.com`，以获得完整的主机名 `frontend.apps.mycluster.com`。
`tls`	`object`	tls 字段提供为路由配置证书和终止的功能。
`至`	`object`	to 是路由应用作主后端的对象。只允许 Service kind，它将默认为 Service。如果 weight 字段(0-256 默认 100)设为零，则不会将流量发送到此后端。
`wildcardPolicy`	`字符串`	用于路由的通配符策略。目前只允许 'Subdomain' 或 'None'。

22.2.1.2. .spec.alternateBackends

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

22.2.1.3. .spec.alternateBackends[]

描述

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

类型

object

必填

kind
name

属性	类型	描述
`kind`	`字符串`	路由引用的目标种类。目前，只允许 'Service'
`name`	`字符串`	要引用的服务/目标的名称，如服务的名称
`weight`	`整数`	weight 作为 0 到 256 之间的整数，默认 100 指定针对其他目标引用对象的目标相对权重。0 会阻止请求进入此后端。

22.2.1.4. .spec.port

描述

如果指定，路由器要使用的端口。大多数路由器默认使用服务公开的所有端点 - 设置此值以指示要使用的端口的路由器。

类型

object

必填

targetPort

属性	类型	描述
`targetPort`	`integer-or-string`

22.2.1.5. .spec.tls

描述

tls 字段提供为路由配置证书和终止的功能。

类型

object

必填

termination

属性	类型	描述
`caCertificate`	`字符串`	caCertificate 提供证书颁发机构证书内容
`certificate`	`字符串`	证书提供证书内容。这应该是单一服务证书，而不是证书链。不要包括 CA 证书。
`destinationCACertificate`	`字符串`	destinationCACertificate 提供最终目的地的 ca 证书的内容。使用重新加密终止时，应提供此文件，以便让路由器将它用于安全连接上的健康检查。如果没有指定此字段，路由器可能会提供自己的目标 CA，并使用短服务名称(service.namespace.svc)执行主机名验证，它允许基础架构生成的证书自动验证。
`insecureEdgeTerminationPolicy`	`字符串`	insecureEdgeTerminationPolicy 表示路由不安全连接所需的行为。虽然每个路由器可能会对要公开的端口做出自己的决定，但通常这是端口 80。* allow - 流量发送到不安全端口上的服务器（仅用于边缘/重新加密终止）（默认）。* None - 在不安全的端口上不允许流量。* Redirect - 客户端被重定向到安全端口。
`key`	`字符串`	密钥提供密钥文件内容
`termination`	`字符串`	termination 表示终止类型。* edge - TLS 终止由路由器完成，http 用于与后端通信（默认）= 透传 - 在不提供 TLS 终止的路由器时直接发送到目的地，TLS 终止由路由器完成，https 用于与后端通信

22.2.1.6. .spec.to

描述

to 是路由应用作主后端的对象。只允许 Service kind，它将默认为 Service。如果 weight 字段(0-256 默认 100)设为零，则不会将流量发送到此后端。

类型

object

必填

kind
name

属性	类型	描述
`kind`	`字符串`	路由引用的目标种类。目前，只允许 'Service'
`name`	`字符串`	要引用的服务/目标的名称，如服务的名称
`weight`	`整数`	weight 作为 0 到 256 之间的整数，默认 100 指定针对其他目标引用对象的目标相对权重。0 会阻止请求进入此后端。

22.2.1.7. .status

描述: Status 是路由的当前状态
类型: object

属性	类型	描述
`ingress`	`array`	Ingress 描述了可公开路由的位置。ingress 点列表可能包含重复的主机或 RouterName 值。路由在就绪后被视为 `Ready`
`ingress[]`	`对象`	RouteIngress 包含有关公开路由的位置的信息。

22.2.1.8. .status.ingress

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

22.2.1.9. .status.ingress[]

描述: RouteIngress 包含有关公开路由的位置的信息。
类型: object

属性	类型	描述
`conditions`	`array`	条件是路由的状态，可能为空。
`conditions[]`	`对象`	RouteIngressCondition 包含特定路由器上此路由的当前条件的详情。
`主机`	`字符串`	host 是公开路由的主机字符串；需要这个值
`routerCanonicalHostname`	`字符串`	CanonicalHostname 是路由器的外部主机名，可用作为此路由请求的主机的 CNAME。这个值是可选的，可能不会在所有情况下设置。
`routerName`	`字符串`	名称是路由器选择以标识自身的名称；需要这个值
`wildcardPolicy`	`字符串`	通配符策略是允许公开此路由的通配符策略。

22.2.1.10. .status.ingress[].conditions

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

22.2.1.11. .status.ingress[].conditions[]

描述

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

类型

object

必填

status
type

属性	类型	描述
`lastTransitionTime`	`string`	当条件最后转换时的 RFC 3339 日期和时间
`message`	`字符串`	人类可读的消息，指示最后一次转换的详细信息。
`reason`	`字符串`	(简洁) 条件最后一次转换的原因，通常是机器和人类可读的常量。
`status`	`字符串`	status 是条件的状态。可以是 True, False, Unknown。
`type`	`字符串`	type 是条件的类型。目前只有 Admited。

22.2.2. API 端点

可用的 API 端点如下：

/apis/route.openshift.io/v1/routes
- GET ：列出类型为 Route 的对象
/apis/route.openshift.io/v1/namespaces/{namespace}/routes
- DELETE ：删除路由的集合
- GET ：列出类型为 Route 的对象
- POST ：创建路由
/apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}
- DELETE ：删除路由
- GET ：读指定的路由
- PATCH ：部分更新指定的路由
- PUT ：替换指定的路由
/apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}/status
- GET ：指定 Route 的读取状态
- PATCH ：部分更新指定路由的状态
- PUT ：替换指定路由的状态

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

表 22.1. 全局查询参数
参数	类型	描述
`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
描述: 列出类型为 Route 的对象

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

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

表 22.3. 全局路径参数
参数	类型	描述
`namespace`	`字符串`	对象名称和身份验证范围，如团队（team）和项目（project）

表 22.4. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

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

表 22.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。

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

HTTP 方法: GET
描述: 列出类型为 Route 的对象

表 22.7. 查询参数
参数	类型	描述
`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。

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

HTTP 方法: POST
描述: 创建路由

表 22.9. 查询参数
参数	类型	描述
`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 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 22.10. 主体参数
参数	类型	描述
`正文（body）`	`Route` 模式

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

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

表 22.12. 全局路径参数
参数	类型	描述
`name`	`字符串`	路由的名称
`namespace`	`字符串`	对象名称和身份验证范围，如团队（team）和项目（project）

表 22.13. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除路由

表 22.14. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值为 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	deprecated ：请使用 PropagationPolicy，此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false，则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置这两个字段。
`propagationPolicy`	`字符串`	是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为：'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项；'Foreground' - 一个级联策略，会删除前台所有依赖的级联策略。

表 22.15. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

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

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

表 22.17. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

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

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

表 22.19. 查询参数
参数	类型	描述
`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 标志。

表 22.20. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

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

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

表 22.22. 查询参数
参数	类型	描述
`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 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 22.23. 主体参数
参数	类型	描述
`正文（body）`	`Route` 模式

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

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

表 22.25. 全局路径参数
参数	类型	描述
`name`	`字符串`	路由的名称
`namespace`	`字符串`	对象名称和身份验证范围，如团队（team）和项目（project）

表 22.26. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

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

表 22.27. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

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

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

表 22.29. 查询参数
参数	类型	描述
`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 标志。

表 22.30. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

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

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

表 22.32. 查询参数
参数	类型	描述
`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 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 22.33. 主体参数
参数	类型	描述
`正文（body）`	`Route` 模式

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

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

22.2.1. 规格

22.2.1.1. .spec

22.2.1.2. .spec.alternateBackends

22.2.1.3. .spec.alternateBackends[]

22.2.1.4. .spec.port

22.2.1.5. .spec.tls

22.2.1.6. .spec.to

22.2.1.7. .status

22.2.1.8. .status.ingress

22.2.1.9. .status.ingress[]

22.2.1.10. .status.ingress[].conditions

22.2.1.11. .status.ingress[].conditions[]

22.2.2. API 端点

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

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

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

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

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Red Hat legal and privacy links

Red Hat legal and privacy links