通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Kubernetes 适用于容器的应用程序网关 API 规范

  • 项目

包

包 v1 是 API 的 v1 版本。

alb.networking.azure.io/v1

本文档定义 alb.networking.azure.io/v1 的每个资源类型。

资源类型：

AffinityType （string 别名）

（出现于：SessionAffinity）

AffinityType 定义服务的关联类型

值 说明

"application-cookie"

AffinityTypeApplicationCookie 是应用程序 Cookie 的会话相关性类型

"managed-cookie"

AffinityTypeManagedCookie 是托管 cookie 的会话相关性类型

AlbConditionReason （string 别名）

AlbConditionReason 定义了解释为何适用于容器的应用程序网关资源引发特定条件类型的一系列原因。

值 说明

"Accepted"

AlbReasonAccepted 指示控制器接受适用于容器的应用程序网关资源。

“就绪”

AlbReasonDeploymentReady 指示容器资源部署状态的应用程序网关。

"InProgress"

AlbReasonInProgress 指示适用于容器的应用程序网关资源是处于创建过程、更新过程，还是删除过程中。

AlbConditionType （string 别名）

AlbConditionType 是与用于容器资源的应用程序网关关联的条件类型。 此类型应与 AlbStatus.Conditions 字段一起使用。

值 说明

"Accepted"

AlbConditionTypeAccepted 指示控制器是否接受适用于容器的应用程序网关资源。

"Deployment"

AlbConditionTypeDeployment 指示用于容器资源的应用程序网关的部署状态。

AlbSpec

（出现于：ApplicationLoadBalancer）

AlbSpec 定义用于容器资源的应用程序网关的规范。

字段 说明
associations
[]string

关联是适用于容器的应用程序网关资源与之关联的子网资源 ID。

AlbStatus

（出现于：ApplicationLoadBalancer）

AlbStatus 定义容器资源的应用程序网关的观察状态。

字段 说明
conditions
[]Kubernetes meta/v1.Condition 		（可选）

已知条件类型包括：

  • “”已接受
  • “就绪”

ApplicationLoadBalancer

ApplicationLoadBalancer 是适用于容器资源的应用程序网关的架构。

字段 说明
metadata
Kubernetes meta/v1.ObjectMeta 		（可选）

对象’元数据。

有关 metadata 字段的字段，请参阅 Kubernetes API 文档。
spec
AlbSpec

规范是用于容器资源的应用程序网关的规范。



associations
[]string

关联是适用于容器的应用程序网关资源与之关联的子网资源 ID。
status
AlbStatus

状态定义容器资源的应用程序网关的观察状态。

BackendTLSPolicy

BackendTLSPolicy 是 BackendTLSPolicys API 的架构。

字段 说明
metadata
Kubernetes meta/v1.ObjectMeta 		（可选）

对象’元数据。

有关 metadata 字段的字段，请参阅 Kubernetes API 文档。
spec
BackendTLSPolicySpec

规范是 BackendTLSPolicy 规范。



targetRef
CustomTargetRef

TargetRef 标识要向其应用策略的 API 对象。
override
BackendTLSPolicyConfig 		（可选）

替代定义策略配置，该配置应覆盖层次结构中目标资源下方附加的策略配置。

注意：当前不支持替代，因为替代会导致验证错误。 将在未来版本中添加对替代的支持。
default
BackendTLSPolicyConfig 		（可选）

默认定义目标资源的默认策略配置。
status
BackendTLSPolicyStatus

状态定义 BackendTLSPolicy 的当前状态。

BackendTLSPolicyConditionReason （string 别名）

BackendTLSPolicyConditionReason 定义了解释为何引发特定 BackendTLSPolicy 条件类型的原因集。

值 说明

"Accepted"

BackendTLSPolicyReasonAccepted 用于在正确配置给定 BackendTLSPolicy 时将 BackendTLSPolicyConditionReason 设置为 Accepted

"InvalidBackendTLSPolicy"

BackendTLSPolicyReasonInvalid 是后端TLSPolicy’ 未接受的原因

"InvalidCertificateRef"

引用无效证书时使用 BackendTLSPolicyReasonInvalidCertificateRef

"InvalidGroup"

当组无效时，将使用 BackendTLSPolicyReasonInvalidGroup

"InvalidKind"

当类型/组无效时，将使用 BackendTLSPolicyReasonInvalidKind

"InvalidName"

当名称无效时，将使用 BackendTLSPolicyReasonInvalidName

"InvalidSecret"

当机密无效时，将使用 BackendTLSPolicyReasonInvalidSecret

"InvalidService"

当服务无效时，将使用 BackendTLSPolicyReasonInvalidGroup

"NoTargetReference"

当没有目标引用时，将使用 BackendTLSPolicyReasonNoTargetReference

"OverrideNotSupported"

不支持替代时使用 BackendTLSPolicyReasonOverrideNotSupported

"RefNotPermitted"

不允许 ref’ 时使用 BackendTLSPolicyReasonRefNotPermitted

"SectionNamesNotPermitted"

不允许节名称时使用 BackendTLSPolicyReasonSectionNamesNotPermitted

BackendTLSPolicyConditionType （string 别名）

BackendTLSPolicyConditionType 是与 BackendTLSPolicy 关联的条件类型。 此类型应与 BackendTLSPolicyStatus.Conditions 字段一起使用。

值 说明

"Accepted"

BackendTLSPolicyConditionAccepted 用于将 BackendTLSPolicyConditionType 设置为 Accepted

"ResolvedRefs"

BackendTLSPolicyConditionResolvedRefs 用于将 BackendTLSPolicyCondition 设置为 ResolvedRefs

BackendTLSPolicyConfig

（出现于：BackendTLSPolicySpec）

BackendTLSPolicyConfig 定义后端 TLS 策略的策略规范。

字段 说明
CommonTLSPolicy
CommonTLSPolicy

（CommonTLSPolicy 的成员已嵌入到此类型中。）

sni
字符串 		（可选）

Sni 是用于与后端建立 TLS 连接的服务器名称。
ports
[]BackendTLSPolicyPort

端口指定应用策略的端口列表。
clientCertificateRef
网关 API .SecretObjectReference 		（可选）

ClientCertificateRef 是对客户端证书的引用，用于与后端建立 TLS 连接。

BackendTLSPolicyPort

（出现于：BackendTLSPolicyConfig）

BackendTLSPolicyPort 定义用于与后端的 TLS 连接的端口

字段 说明
port
int

端口是用于与后端的 TLS 连接的端口

BackendTLSPolicySpec

（出现于：BackendTLSPolicy）

BackendTLSPolicySpec 定义了 BackendTLSPolicy 的所需状态。

字段 说明
targetRef
CustomTargetRef

TargetRef 标识要向其应用策略的 API 对象。
override
BackendTLSPolicyConfig 		（可选）

替代定义策略配置，该配置应覆盖层次结构中目标资源下方附加的策略配置。

注意：当前不支持替代，因为替代会导致验证错误。 将在未来版本中添加对替代的支持。
default
BackendTLSPolicyConfig 		（可选）

默认定义目标资源的默认策略配置。

BackendTLSPolicyStatus

（出现于：BackendTLSPolicy）

BackendTLSPolicyStatus 定义 BackendTLSPolicy 的观察状态。

字段 说明
conditions
[]Kubernetes meta/v1.Condition 		（可选）

条件描述 BackendTLSPolicy 的当前条件。

实现应倾向于使用 BackendTLSPolicyConditionType 和 BackendTLSPolicyConditionReason 常量来表达 BackendTLSPolicy 条件，以便运算符和工具可以聚合在描述 BackendTLSPolicy 状态的常见词汇上。

已知条件类型包括：

  • “”已接受

CommonTLSPolicy

（出现于：BackendTLSPolicyConfig）

CommonTLSPolicy 是 CommonTLSPolicy API 的架构。

字段 说明
verify
CommonTLSPolicyVerify 		（可选）

验证可提供用于验证对等证书的选项。

CommonTLSPolicyVerify

（出现于：CommonTLSPolicy）

CommonTLSPolicyVerify 定义 CommonTLSPolicyVerify API 的架构。

字段 说明
caCertificateRef
网关 API .SecretObjectReference

CaCertificateRef 是用于验证对等证书的 CA 证书。
subjectAltName
字符串 		（可选）

SubjectAltName 是用于验证对等证书的使用者可选名称。

CustomTargetRef

（在以下项上出现：BackendTLSPolicySpec、FrontendTLSPolicySpec、HealthCheckPolicySpec、RoutePolicySpec）

CustomTargetRef 是对’不属于 Kubernetes 核心 API 的自定义资源的引用。

字段 说明
NamespacedPolicyTargetReference
网关 API alpha2.NamespacedPolicyTargetReference

（NamespacedPolicyTargetReference 的成员已嵌入到此类型中。）

sectionNames
[]string 		（可选）

SectionNames 是目标资源中节的名称。 如果未指定，此 targetRef 将面向整个资源。 在以下资源中，SectionNames 的解释如下：

  • 网关：侦听器名称
  • 服务：端口名称

如果指定了 SectionNames，但它在目标对象上不’存在，则策略将无法附加，并且策略实现将在策略’状态中记录 ResolvedRefs 或类似条件。

FrontendTLSPolicy

FrontendTLSPolicy 是 FrontendTLSPolicy API 的架构

字段 说明
metadata
Kubernetes meta/v1.ObjectMeta 		（可选）

对象’元数据。

有关 metadata 字段的字段，请参阅 Kubernetes API 文档。
spec
FrontendTLSPolicySpec

规范是 FrontendTLSPolicy 规范。



targetRef
CustomTargetRef

TargetRef 标识要向其应用策略的 API 对象。
default
FrontendTLSPolicyConfig 		（可选）

默认定义目标资源的默认策略配置。
override
FrontendTLSPolicyConfig 		（可选）

替代定义策略配置，该配置应覆盖层次结构中目标资源下方附加的策略配置。

注意：当前不支持替代，因为替代会导致验证错误。 将在未来版本中添加对替代的支持。
status
FrontendTLSPolicyStatus

状态定义 FrontendTLSPolicy 的当前状态。

FrontendTLSPolicyConditionReason （string 别名）

FrontendTLSPolicyConditionReason 定义了解释为何引发特定 FrontendTLSPolicy 条件类型的原因集。

值 说明

"Accepted"

FrontendTLSPolicyReasonAccepted 用于在正确配置给定 FrontendTLSPolicy 时将 FrontendTLSPolicyConditionReason 设置为 Accepted

"InvalidFrontendTLSPolicy"

FrontendTLSPolicyReasonInvalid 是 FrontendTLSPolicy’ 未接受的原因

"InvalidCertificateRef"

引用无效的证书时，将使用 FrontendTLSPolicyReasonInvalidCertificateRef

“InvalidDefault”

当默认值无效时，将使用 FrontendTLSPolicyReasonInvalidDefault

"InvalidGateway"

当网关无效时，将使用 FrontendTLSPolicyReasonInvalidGateway

"InvalidGroup"

当组无效时，将使用 FrontendTLSPolicyReasonInvalidGroup

"InvalidKind"

当类型/组无效时，将使用 FrontendTLSPolicyReasonInvalidKind

"InvalidName"

当名称无效时，将使用 FrontendTLSPolicyReasonInvalidName

"InvalidPolicyName"

当策略名称无效时，将使用 FrontendTLSPolicyReasonInvalidPolicyName

"InvalidPolicyType"

当策略类型无效时，将使用 FrontendTLSPolicyReasonInvalidPolicyType

“InvalidTargetReference”

目标引用无效时，将使用 FrontendTLSPolicyReasonInvalidTargetReference

"NoTargetReference"

当没有目标引用时，将使用 FrontendTLSPolicyReasonNoTargetReference

"OverrideNotSupported"

不支持替代时使用 FrontendTLSPolicyReasonOverrideNotSupported

"RefNotPermitted"

不允许 ref’ 时使用 FrontendTLSPolicyReasonRefNotPermitted

"SectionNamesNotPermitted"

不允许节名称时使用 FrontendTLSPolicyReasonSectionNamesNotPermitted

FrontendTLSPolicyConditionType （string 别名）

FrontendTLSPolicyConditionType 是与 FrontendTLSPolicy 关联的条件类型。 此类型应与 FrontendTLSPolicyStatus.Conditions 字段一起使用。

值 说明

"Accepted"

FrontendTLSPolicyConditionAccepted 用于将 FrontendTLSPolicyConditionType 设置为 Accepted

"ResolvedRefs"

FrontendTLSPolicyConditionResolvedRefs 用于将 FrontendTLSPolicyCondition 设置为 ResolvedRefs

FrontendTLSPolicyConfig

（出现于：FrontendTLSPolicySpec）

FrontendTLSPolicyConfig 定义前端 TLS 策略的策略规范。

字段 说明
verify
MTLSPolicyVerify 		（可选）

验证可提供用于验证对等证书的选项。
policyType
PolicyType 		（可选）

类型是策略的类型。

FrontendTLSPolicySpec

（出现于：FrontendTLSPolicy）

FrontendTLSPolicySpec 定义 FrontendTLSPolicy 的所需状态

字段 说明
targetRef
CustomTargetRef

TargetRef 标识要向其应用策略的 API 对象。
default
FrontendTLSPolicyConfig 		（可选）

默认定义目标资源的默认策略配置。
override
FrontendTLSPolicyConfig 		（可选）

替代定义策略配置，该配置应覆盖层次结构中目标资源下方附加的策略配置。

注意：当前不支持替代，因为替代会导致验证错误。 将在未来版本中添加对替代的支持。

FrontendTLSPolicyStatus

（出现于：FrontendTLSPolicy）

FrontendTLSPolicyStatus 定义 FrontendTLSPolicy 的观察状态。

字段 说明
conditions
[]Kubernetes meta/v1.Condition 		（可选）

条件描述 FrontendTLSPolicy 的当前条件。

实现应倾向于使用 FrontendTLSPolicyConditionType 和 FrontendTLSPolicyConditionReason 常量来表达 FrontendTLSPolicy 条件，以便运算符和工具可以聚合在描述 FrontendTLSPolicy 状态的常见词汇上。

已知条件类型包括：

  • “”已接受

FrontendTLSPolicyType （string 别名）

（出现于：PolicyType）

FrontendTLSPolicyType 是前端 TLS 策略的类型。

值 说明

"predefined"

PredefinedFrontendTLSPolicyType 是预定义的前端 TLS 策略的类型。

FrontendTLSPolicyTypeName（string 别名）

（出现于：PolicyType）

FrontendTLSPolicyTypeName 是前端 TLS 策略的名称。

值 说明

"2023-06"

PredefinedPolicy202306 是策略 “2023-06” 的预定义前端 TLS 策略的名称。

"2023-06-S"

PredefinedPolicy202306Strict 是策略 “2023-06-S” 的预定义前端 TLS 策略的名称。 这是策略 “2023-06” 的严格版本。

GRPCSpecifiers

（出现于：HealthCheckPolicyConfig）

GRPCSpecifiers 定义 GRPC HealthCheck 的架构。

字段 说明
authority
字符串 		（可选）

如果存在，则颁发机构会在运行状况检查中用作 Authority 标头的值。
service
字符串 		（可选）

服务允许配置在不同的服务名称下注册的运行状况检查。

HTTPHeader

（出现于：HeaderFilter）

HTTPHeader 表示 RFC 7230 定义的 HTTP 标头名称和值。

字段 说明
name
HTTPHeaderName

名称是要匹配的 HTTP 标头的名称。 名称匹配必须不区分大小写。 （请参阅 https://tools.ietf.org/html/rfc7230#section-3.2）。

如果多个条目指定等效的标头名称，则必须为匹配考虑具有等效名称的第一个条目。 必须忽略具有等效标头名称的后续条目。 由于标头名称不区分大小写，“foo” 和 “Foo” 被视为等效项。
value
字符串

值是要匹配的 HTTP 标头的值。

HTTPHeaderName （string 别名）

（出现于：HTTPHeader）

HTTPHeaderName 是 HTTP 标头的名称。

有效值包括：

  • “授权”
  • “Set-Cookie”

无效值包括：

  • ”:method” - “:” 是无效字符。 这意味着此类型当前不支持 HTTP/2 伪标头。
  • ”/invalid” - “/ ” 是无效字符

HTTPMatch

（出现于：HTTPSpecifiers）

HTTPMatch 定义用于 HealthCheck 检查的 HTTP 匹配程序。

字段 说明
body
字符串 		（可选）

正文定义用于 HealthCheck 检查的 HTTP 正文。
statusCodes
[]StatusCodes 		（可选）

StatusCodes 定义用于 HealthCheck 检查的 HTTP 状态代码。

HTTPPathModifier

（出现于：重定向，URLRewriteFilter）

HTTPPathModifier 定义路径修饰符的配置。

字段 说明
type
HTTPPathModifierType

类型定义路径修饰符的类型。 可以在 API 的未来版本中添加更多类型。

可以将值添加到此枚举中，实现必须确保未知值不会导致崩溃。

此处的未知值必须造成实现设置规则为 false 的接受条件
replaceFullPath
字符串 		（可选）

ReplaceFullPath 指定在重写或重定向期间替换请求的完整路径的值。
replacePrefixMatch
字符串 		（可选）

ReplacePrefixMatch 指定在重写或重定向期间替换请求的前缀匹配的值。 例如，对前缀匹配为 “/foo” 且 ReplacePrefixMatch 为 “/xyz” 的 “/foo/bar” 的请求会被修改为 “/xyz/bar”。

这与 PathPrefix 匹配类型的行为匹配。 这与完整路径元素匹配。 路径元素是指由 / 分隔符拆分的路径中的标签列表。 指定后，将忽略尾随 /。 例如，路径 /abc、/abc/ 和 /abc/def 都与前缀 /abc 匹配，但路径 /abcd 不匹配。

ReplacePrefixMatch 仅与 PathPrefix HTTPRouteMatch 兼容。 在同一 HTTPRouteRule 上使用任何其他 HTTPRouteMatch 类型将导致实现设置路由到 status: False 的接受条件。

请求路径 前缀匹配 替换前缀 修改的路径
/foo/bar /foo /xyz /xyz/bar
/foo/bar /foo /xyz/ /xyz/bar
/foo/bar /foo/ /xyz /xyz/bar
/foo/bar /foo/ /xyz/ /xyz/bar
/foo /foo /xyz /xyz
/foo/ /foo /xyz /xyz/
/foo/bar /foo /bar
/foo/ /foo /
/foo /foo /
/foo/ /foo / /
/foo /foo / /

HTTPPathModifierType （string 别名）

（出现于：HTTPPathModifier）

HTTPPathModifierType 定义路径重定向或重写的类型。

值 说明

"ReplaceFullPath"

FullPathHTTPPathModifier 将完整路径替换为指定的值。

"ReplacePrefixMatch"

PrefixMatchHTTPPathModifier 将任何前缀路径替换为替换值。 例如，前缀匹配为 “/foo” 的路径和 “/bar” 的 ReplacePrefixMatch 替代项在匹配的请求中将 “/foo” 替换为 “/bar”。

这与 PathPrefix 匹配类型的行为匹配。 这与完整路径元素匹配。 路径元素是指由 / 分隔符拆分的路径中的标签列表。 指定后，将忽略尾随 /。 例如，路径 /abc、/abc/ 和 /abc/def 都与前缀 /abc 匹配，但路径 /abcd 不匹配。

HTTPSpecifiers

（出现于：HealthCheckPolicyConfig）

HTTPSpecifiers 定义 HTTP HealthCheck 检查规范的框架。

字段 说明
host
字符串 		（可选）

主机是用于 HealthCheck 检查的主机标头值。
path
字符串 		（可选）

路径是用于 HealthCheck 检查的路径。
match
HTTPMatch 		（可选）

匹配定义用于 HealthCheck 检查的 HTTP 匹配程序。

HeaderFilter

（出现于：IngressRewrites）

HeaderFilter 定义修改 HTTP 请求或响应标头的筛选器。 只允许对给定标头名称执行一个操作。 为任意一个标头名称指定相同或不同类型的多个操作的筛选器无效，并且将被拒绝。 要设置或添加标头的多个值的配置必须使用 RFC 7230 标头值格式，以逗号分隔每个值。

字段 说明
set
[]HTTPHeader 		（可选）

设置在操作之前使用给定标头（名称、值）覆盖请求。

输入：GET /foo HTTP/1.1 my-header: foo

Config: set: - name: “my-header” value: “bar”

输出：GET /foo HTTP/1.1 my-header: bar
add
[]HTTPHeader 		（可选）

添加在操作之前将给定标头（名称、值）添加到请求。 它将追加到与标头名称关联的任何现有值。

输入：GET /foo HTTP/1.1 my-header: foo

Config: add: - name: “my-header” value: “bar,baz”

输出：GET /foo HTTP/1.1 my-header: foo,bar,baz
remove
[]string 		（可选）

在操作之前，从 HTTP 请求中删除给定标头。 移除的值是 HTTP 标头名称的列表。 标头名称不区分大小写（请参阅 https://datatracker.ietf.org/doc/html/rfc2616#section-4.2)。

输入：GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz

Config: remove: [“my-header1”, “my-header3”]

输出：GET /foo HTTP/1.1 my-header2: bar

HeaderName （string 别名）

HeaderName 是标头或查询参数的名称。

HealthCheckPolicy

HealthCheckPolicy 是 HealthCheckPolicy API 的架构。

字段 说明
metadata
Kubernetes meta/v1.ObjectMeta 		（可选）

对象’元数据。

有关 metadata 字段的字段，请参阅 Kubernetes API 文档。
spec
HealthCheckPolicySpec

规范是 HealthCheckPolicy 规范。



targetRef
CustomTargetRef

TargetRef 标识要向其应用策略的 API 对象。
override
HealthCheckPolicyConfig 		（可选）

替代定义策略配置，该配置应覆盖层次结构中目标资源下方附加的策略配置。

注意：当前不支持替代，替代将导致验证错误。 将在未来版本中添加对替代的支持。
default
HealthCheckPolicyConfig 		（可选）

默认定义目标资源的默认策略配置。
status
HealthCheckPolicyStatus

状态定义 HealthCheckPolicy 的当前状态。

HealthCheckPolicyConditionReason （string 别名）

HealthCheckPolicyConditionReason 定义了解释为何引发特定 HealthCheckPolicy 条件类型的原因集。

值 说明

“BackendTLSPolicyNotFound”

找不到服务的 BackendTLSPolicy 时，将使用 BackendTLSPolicyConditionNotFound。

"Accepted"

HealthCheckPolicyReasonAccepted 用于将 HealthCheckPolicyConditionReason 设置为“已接受”。 当正确配置给定的 HealthCheckPolicy 时。

"InvalidHealthCheckPolicy"

HealthCheckPolicyReasonInvalid 是 HealthCheckPolicy 不’被接受的原因。

"InvalidGroup"

当组无效时，将使用 HealthCheckPolicyReasonInvalidGroup。

"InvalidKind"

当种类/组无效时，将使用 HealthCheckPolicyReasonInvalidKind。

"InvalidName"

当名称无效时，将使用 HealthCheckPolicyReasonInvalidName。

"InvalidPort"

当端口无效时，将使用 HealthCheckPolicyReasonInvalidPort。

"InvalidService"

当服务无效时，将使用 HealthCheckPolicyReasonInvalidService。

"NoTargetReference"

当没’有任何目标引用时，将使用 HealthCheckPolicyReasonNoTargetReference。

"OverrideNotSupported"

当替代不’受支持时，将使用 HealthCheckPolicyReasonOverrideNotSupported。

"RefNotPermitted"

不’允许使用 ref 时，将使用 HealthCheckPolicyReasonRefNotPermitted。

"SectionNamesNotPermitted"

不’允许使用节名称时，将使用 HealthCheckPolicyReasonSectionNamesNotPermitted。

HealthCheckPolicyConditionType （string 别名）

HealthCheckPolicyConditionType 是与 HealthCheckPolicy 关联的条件类型。 此类型应与 HealthCheckPolicyStatus.Conditions 字段一起使用。

值 说明

"Accepted"

HealthCheckPolicyConditionAccepted 用于将 HealthCheckPolicyConditionType 设置为“已接受”。

"ResolvedRefs"

HealthCheckPolicyConditionResolvedRefs 用于将 HealthCheckPolicyCondition 设置为 ResolvedRefs。

HealthCheckPolicyConfig

（出现于：HealthCheckPolicySpec）

HealthCheckPolicyConfig 定义 HealthCheck 检查规范的框架。

字段 说明
interval
Kubernetes meta/v1.Duration 		（可选）

间隔是两次 HealthCheck 检查之间的秒数。
timeout
Kubernetes meta/v1.Duration 		（可选）

超时是 HealthCheck 检查失败后的秒数。
port
int32 		（可选）

端口是用于 HealthCheck 检查的端口。
unhealthyThreshold
int32 		（可选）

UnhealthyThreshold 是连续的失败 HealthCheck 检查次数。
healthyThreshold
int32 		（可选）

HealthyThreshold 是连续的成功 HealthCheck 检查次数。
useTLS
bool 		（可选）

UseTLS 指示运行状况检查是否应强制实施 TLS。 默认情况下，如果使用相同的端口进行运行状况检查，则运行状况检查将使用与服务相同的协议。 如果端口不同，则运行状况检查将是纯文本。
http
HTTPSpecifiers 		（可选）

HTTP 定义目标资源的 HealthCheck 的 HTTP 约束规范。
grpc
GRPCSpecifiers

GRPC 针对目标资源配置 gRPC v1 HealthCheck（https://github.com/grpc/grpc-proto/blob/master/grpc/health/v1/health.proto）。

HealthCheckPolicySpec

（出现于：HealthCheckPolicy）

HealthCheckPolicySpec 定义 HealthCheckPolicy 的所需状态。

字段 说明
targetRef
CustomTargetRef

TargetRef 标识要向其应用策略的 API 对象。
override
HealthCheckPolicyConfig 		（可选）

替代定义策略配置，该配置应覆盖层次结构中目标资源下方附加的策略配置。

注意：当前不支持替代，替代将导致验证错误。 将在未来版本中添加对替代的支持。
default
HealthCheckPolicyConfig 		（可选）

默认定义目标资源的默认策略配置。

HealthCheckPolicyStatus

（出现于：HealthCheckPolicy）

HealthCheckPolicyStatus 定义 HealthCheckPolicy 的观察状态。

字段 说明
conditions
[]Kubernetes meta/v1.Condition 		（可选）

条件描述 HealthCheckPolicy 的当前条件。

实现应倾向于使用 HealthCheckPolicyConditionType 和 HealthCheckPolicyConditionReason 常量来表达 HealthCheckPolicy 条件，以便运算符和工具可以聚合在描述 HealthCheckPolicy 状态的常见词汇上。

已知条件类型包括：

  • “”已接受

IngressBackendPort

（出现于：IngressBackendSettings）

IngressBackendPort 描述后端上的端口。 应只定义一个名称/数字。

字段 说明
port
int32 		（可选）

端口指示后端服务上的端口
name
字符串 		（可选）

名称必须引用后端服务端口上的名称
protocol
协议

协议应为 “HTTP”、“HTTPS” 之一

IngressBackendSettingStatus

（出现于：IngressExtensionStatus）

IngressBackendSettingStatus 描述 BackendSetting 的状态

字段 说明
service
字符串

服务标识此状态描述的 BackendSetting
validationErrors
[]string 		（可选）

错误是与此设置相关的错误列表
valid
bool

有效指示此 BackendSetting 上不存在验证错误

IngressBackendSettings

（出现于：IngressExtensionSpec）

IngressBackendSettings 为后端服务提供扩展配置选项

字段 说明
service
字符串

服务是此配置适用的后端服务的名称
ports
[]IngressBackendPort 		（可选）

端口可用于指示后端服务是否正在侦听 HTTP 或 HTTPS
trustedRootCertificate
字符串 		（可选）

与指定为 https 的端口上的后端通信时，TrustedRootCertificate 可用于为网关提供要信任的证书
sessionAffinity
SessionAffinity 		（可选）

SessionAffinity 允许向同一后端提供的客户端请求一致
timeouts
IngressTimeouts 		（可选）

超时定义一组要应用于入口的超时参数

IngressExtension

IngressExtension 是 IngressExtension API 的架构

字段 说明
metadata
Kubernetes meta/v1.ObjectMeta 		（可选）

对象’元数据。

有关 metadata 字段的字段，请参阅 Kubernetes API 文档。
spec
IngressExtensionSpec

规范是 IngressExtension 规范。



rules
[]IngressRuleSetting 		（可选）

规则定义每个主机的规则
backendSettings
[]IngressBackendSettings 		（可选）

BackendSettings 为入口服务后端定义一组配置选项
status
IngressExtensionStatus

IngressExtensionConditionReason （string 别名）

IngressExtensionConditionReason 定义了解释为何引发特定 IngressExtension 条件类型的原因集。

值 说明

"Accepted"

IngressExtensionReasonAccepted 用于将 IngressExtensionConditionAccepted 设置为 Accepted

"HasValidationErrors"

IngressExtensionReasonHasErrors 指示存在一些验证错误

"NoValidationErrors"

IngressExtensionReasonNoErrors 指示没有验证错误

"PartiallyAcceptedWithErrors"

IngressExtensionReasonPartiallyAccepted 用于将 IngressExtensionConditionAccepted 设置为 Accepted，但存在非致命验证错误

IngressExtensionConditionType （string 别名）

IngressExtensionConditionType 是与 IngressExtension 关联的条件类型。 此类型应与 IngressExtensionStatus.Conditions 字段一起使用。

值 说明

"Accepted"

IngressExtensionConditionAccepted 指示控制器是否已接受 IngressExtension（协调）

"Errors"

IngressExtensionConditionErrors 指示扩展上是否存在验证或生成错误

IngressExtensionSpec

（出现于：IngressExtension）

IngressExtensionSpec 定义 IngressExtension 的所需配置

字段 说明
rules
[]IngressRuleSetting 		（可选）

规则定义每个主机的规则
backendSettings
[]IngressBackendSettings 		（可选）

BackendSettings 为入口服务后端定义一组配置选项

IngressExtensionStatus

（出现于：IngressExtension）

IngressExtensionStatus 描述 IngressExtension 的当前状态

字段 说明
rules
[]IngressRuleStatus 		（可选）

规则包含有关每个规则的详细状态信息
backendSettings
[]IngressBackendSettingStatus 		（可选）

BackendSettings 包含有关每个 BackendSettings 的详细状态信息
conditions
[]Kubernetes meta/v1.Condition 		（可选）

条件描述 IngressExtension 的当前条件。 已知条件类型包括：

  • “”已接受
  • “错误”

IngressRewrites

（出现于：IngressRuleSetting）

IngressRewrites 提供规则支持的各种重写

字段 说明
type
RewriteType

类型标识重写的类型
requestHeaderModifier
HeaderFilter 		（可选）

RequestHeaderModifier 定义修改请求标头的架构。
responseHeaderModifier
HeaderFilter 		（可选）

RequestHeaderModifier 定义修改回应标头的架构。
urlRewrite
URLRewriteFilter 		（可选）

URLRewrite 定义在转发期间修改请求的架构。

IngressRuleSetting

（出现于：IngressExtensionSpec）

IngressRuleSetting 为规则提供配置选项

字段 说明
host
字符串

主机用于与具有相同主机名的入口规则匹配，以便识别哪些规则影响这些设置
additionalHostnames
[]string 		（可选）

AdditionalHostnames 指定要侦听的更多主机名
rewrites
[]IngressRewrites 		（可选）

重写定义规则的重写
requestRedirect
重定向 		（可选）

RequestRedirect 定义规则的重定向行为

IngressRuleStatus

（出现于：IngressExtensionStatus）

IngressRuleStatus 描述规则的状态

字段 说明
host
字符串

主机标识此状态描述的规则
validationErrors
[]string 		（可选）

错误是与此设置相关的错误列表
valid
bool 		（可选）

有效指示此规则上不存在验证错误

IngressTimeouts

（出现于：IngressBackendSettings）

IngressTimeouts 可用于配置入口的超时属性

字段 说明
requestTimeout
Kubernetes meta/v1.Duration 		（可选）

RequestTimeout 定义将请求转发到后端服务时负载均衡器使用的超时

MTLSPolicyVerify

（出现于：FrontendTLSPolicyConfig）

MTLSPolicyVerify 定义 MTLSPolicyVerify API 的架构。

字段 说明
caCertificateRef
网关 API .SecretObjectReference

CaCertificateRef 是用于验证对等证书的 CA 证书。
subjectAltNames
[]string 		（可选）

SubjectAltNames 是用于验证对等证书的使用者可选名称列表。

PolicyType

（出现于：FrontendTLSPolicyConfig）

PolicyType 是策略的类型。

字段 说明
name
FrontendTLSPolicyTypeName

名称是策略的名称。
type
FrontendTLSPolicyType

PredefinedFrontendTLSPolicyType 是预定义的前端 TLS 策略的类型。

PortNumber （int32 别名）

（出现于：重定向）

PortNumber 定义网络端口。

PreciseHostname （string 别名）

（出现于：重定向，URLRewriteFilter）

PreciseHostname 是网络主机的完全限定域名。 这与主机名的 RFC 1123 定义匹配，其中一个值得注意的例外是不允许数字 IP 地址。

根据RFC1035和RFC1123，标签必须包含小写字母数字字符或 ‘-’，并且必须以字母数字字符开头和结尾。 不允许使用其他标点符号。

协议（string 别名）

（出现于：IngressBackendPort）

协议定义用于某些属性的协议。 有效的协议值为：

  • HTTP
  • HTTPS
  • TCP
值 说明

"HTTP"

ProtocolHTTP 表示服务使用 HTTP。

“HTTPS”

ProtocolHTTPS 表示服务使用 HTTPS。

"TCP"

ProtocolTCP 表示服务使用普通 TCP。

重定向

（出现于：IngressRuleSetting）

重定向定义重定向请求的筛选器。 这不能用于同时具有 URLRewriteFilter 的同一规则。

字段 说明
scheme
字符串 		（可选）

方案是要在响应中 Location 标头的值中使用的方案。 如果为空，则使用请求的方案。
hostname
PreciseHostname 		（可选）

主机名是要在响应中 Location 标头的值中使用的主机名。 当为空时，将使用请求 Host 标头中的主机名。
path
HTTPPathModifier 		（可选）

路径定义用于修改传入请求路径的参数。 然后，修改的路径用于构造 Location 标头。 如果为空，则按原样使用请求路径。
port
PortNumber 		（可选）

端口是要在响应中 Location 标头的值中使用的端口。

如果未指定端口，则必须使用以下规则派生重定向端口：

  • 如果重定向方案不为空，则重定向端口必须是与重定向方案关联的已知端口。 具体来说，“http” 使用端口 80，“https” 使用端口 443。 如果重定向方案没有已知的端口，则应使用网关的侦听器端口。
  • 如果重定向方案为空，则重定向端口必须是网关侦听器端口。

实现不应在以下情况下在‘位置’标头中添加端口号：

  • 使用 HTTP（无论是通过侦听器协议还是方案字段确定）且使用端口 80 的位置标头。
  • 使用 HTTPS（无论是通过侦听器协议还是方案字段确定）且使用端口 443 的位置标头。
statusCode
int 		（可选）

StatusCode 是响应中使用的 HTTP 状态代码。

可以将值添加到此枚举中，实现必须确保未知值不会导致崩溃。

RewriteType （string 别名）

（出现于：IngressRewrites）

RewriteType 标识重写类型

值 说明

"RequestHeaderModifier"

RequestHeaderModifier 可用于在将 HTTP 标头发送到上游目标之前从 HTTP 请求添加或删除该标头。

"ResponseHeaderModifier"

ResponseHeaderModifier 可用于在将 HTTP 标头发送到客户端之前从 HTTP 响应添加或删除该标头。

"URLRewrite"

URLRewrite 可用于在转发期间修改请求。

RoutePolicy

RoutePolicy 是 RoutePolicy API 的架构。

字段 说明
metadata
Kubernetes meta/v1.ObjectMeta 		（可选）

对象’元数据。

有关 metadata 字段的字段，请参阅 Kubernetes API 文档。
spec
RoutePolicySpec

规范是 RoutePolicy 规范。



targetRef
CustomTargetRef

TargetRef 标识要向其应用策略的 API 对象。
override
RoutePolicyConfig 		（可选）

替代定义策略配置，该配置应覆盖层次结构中目标资源下方附加的策略配置。

注意：当前不支持替代，因为替代会导致验证错误。 将在未来版本中添加对替代的支持。
default
RoutePolicyConfig 		（可选）

默认定义目标资源的默认策略配置。
status
RoutePolicyStatus

状态定义 RoutePolicy 的当前状态。

RoutePolicyConditionReason （string 别名）

RoutePolicyConditionReason 定义了解释为何引发特定 RoutePolicy 条件类型的原因集。

值 说明

"Accepted"

RoutePolicyReasonAccepted 用于在正确配置给定 RoutePolicy 时将 RoutePolicyConditionReason 设置为 Accepted

"InvalidRoutePolicy"

RoutePolicyReasonInvalid 是 RoutePolicy’ 未接受的原因

“InvalidGRPCRoute”

GRPCRoute 无效时，将使用 RoutePolicyReasonInvalidGRPCRoute

"InvalidGroup"

当组无效时，将使用 RoutePolicyReasonInvalidGroup

"InvalidHTTPRoute"

当 HTTPRoute 无效时，将使用 RoutePolicyReasonInvalidHTTPRoute

"InvalidKind"

当类型/组无效时，将使用 RoutePolicyReasonInvalidKind

"InvalidName"

当名称无效时，将使用 RoutePolicyReasonInvalidName

"NoTargetReference"

当没有目标引用时，将使用 RoutePolicyReasonNoTargetReference

"OverrideNotSupported"

不支持替代时使用 RoutePolicyReasonOverrideNotSupported

"RefNotPermitted"

不允许 ref’ 时使用 RoutePolicyReasonRefNotPermitted

"SectionNamesNotPermitted"

不允许节名称时使用 RoutePolicyReasonSectionNamesNotPermitted

RoutePolicyConditionType （string 别名）

RoutePolicyConditionType 是与 RoutePolicy 关联的条件类型。 此类型应与 RoutePolicyStatus.Conditions 字段一起使用。

值 说明

"Accepted"

RoutePolicyConditionAccepted 用于将 RoutePolicyConditionType 设置为 Accepted

"ResolvedRefs"

RoutePolicyConditionResolvedRefs 用于将 RoutePolicyCondition 设置为 ResolvedRefs

RoutePolicyConfig

（出现于：RoutePolicySpec）

RoutePolicyConfig 定义 RoutePolicy 规范的架构。 这允许以下属性的规范：*超时 *会话相关性

字段 说明
timeouts
RouteTimeouts 		（可选）

目标资源的自定义超时。
sessionAffinity
SessionAffinity

SessionAffinity 定义会话相关性规范的架构

RoutePolicySpec

（出现于：RoutePolicy）

RoutePolicySpec 定义了 RoutePolicy 的所需状态。

字段 说明
targetRef
CustomTargetRef

TargetRef 标识要向其应用策略的 API 对象。
override
RoutePolicyConfig 		（可选）

替代定义策略配置，该配置应覆盖层次结构中目标资源下方附加的策略配置。

注意：当前不支持替代，因为替代会导致验证错误。 将在未来版本中添加对替代的支持。
default
RoutePolicyConfig 		（可选）

默认定义目标资源的默认策略配置。

RoutePolicyStatus

（出现于：RoutePolicy）

RoutePolicyStatus 定义 RoutePolicy 的观察状态。

字段 说明
conditions
[]Kubernetes meta/v1.Condition 		（可选）

条件描述 RoutePolicy 的当前条件。

实现应倾向于使用 RoutePolicyConditionType 和 RoutePolicyConditionReason 常量来表达 RoutePolicy 条件，以便运算符和工具可以聚合在描述 RoutePolicy 状态的常见词汇上。

已知条件类型包括：

  • “”已接受

RouteTimeouts

（出现于：RoutePolicyConfig）

RouteTimeouts 定义了超时规范的架构。

字段 说明
routeTimeout
Kubernetes meta/v1.Duration 		（可选）

RouteTimeout 是路由的超时。

SessionAffinity

（出现于：IngressBackendSettings、RoutePolicyConfig）

SessionAffinity 定义了会话亲和性规范的架构。

字段 说明
affinityType
AffinityType
cookieName
字符串 		（可选）
cookieDuration
Kubernetes meta/v1.Duration 		（可选）

StatusCodes

（出现于：HTTPMatch）

StatusCodes 定义用于 HealthCheck 检查的 HTTP 状态代码。

字段 说明
start
int32 		（可选）

开始定义用于 HealthCheck 检查的状态代码范围的开始。 这是包容性的。
end
int32 		（可选）

结束定义用于 HealthCheck 检查的状态代码范围的结束。 这是包容性的。

URLRewriteFilter

（出现于：IngressRewrites）

URLRewriteFilter 定义在转发期间修改请求的筛选器。 这些筛选器最多有一个可用于规则。 这不能用于具有 sslRedirect 的同一规则。

字段 说明
hostname
PreciseHostname 		（可选）

主机名是用于在转发期间替换 Host 标头值的值。
path
HTTPPathModifier 		（可选）

路径定义路径重写。