Kubernetes 適用於容器的應用程式閘道 API 規格

Packages

套件 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 指出控制器接受適用於容器的應用程式閘道資源。
"Ready"	AlbReasonDeploymentReady 指出適用於容器的應用程式閘道資源部署狀態。
"InProgress"	AlbReasonInProgress 指出是否正在建立、更新或刪除適用於容器的應用程式閘道資源。

AlbConditionType (string 別名)

AlbConditionType 是與適用於容器的應用程式閘道資源相關聯的條件類型。 此類型應該與 AlbStatus.Conditions 欄位搭配使用。

值	描述
"Accepted"	AlbConditionTypeAccepted 指出控制器是否接受適用於容器的應用程式閘道資源。
"Deployment"	AlbConditionTypeDeployment 指出適用於容器的應用程式閘道資源的部署狀態。

AlbSpec

(出現於：ApplicationLoadBalancer)

AlbSpec 定義適用於容器的應用程式閘道資源的規格。

欄位	描述
associations []字串	關聯性是與適用於容器的應用程式閘道資源相關聯的子網路資源識別碼。

AlbStatus

(出現於：ApplicationLoadBalancer)

AlbStatus 定義適用於容器的應用程式閘道資源的觀察狀態。

欄位	描述
conditions []Kubernetes meta/v1.Condition	(選擇性) 已知條件類型為： “已接受” “就緒”

ApplicationLoadBalancer

ApplicationLoadBalancer 是適用於容器的應用程式閘道資源的結構描述。

欄位	描述
metadata Kubernetes meta/v1.ObjectMeta	(選擇性) 物件的中繼資料。 如需 metadata 欄位的各欄位，請參閱 Kubernetes API 文件。
spec AlbSpec	Spec 是適用於容器的應用程式閘道資源的規格。 associations []字串 關聯性是與適用於容器的應用程式閘道資源相關聯的子網路資源識別碼。
status AlbStatus	Status 定義適用於容器的應用程式閘道資源的目前狀態。

後端負載平衡策略

BackendLoadBalancingPolicy 代表後端負載平衡的設定。

欄位	描述
metadata Kubernetes meta/v1.ObjectMeta	(選擇性) 物件的中繼資料。 如需 metadata 欄位的各欄位，請參閱 Kubernetes API 文件。
spec 後端負載平衡政策規格	Spec 是 BackendLoadBalancingPolicy 規格。 targetRefs []目標參考規格 TargetRefs 會識別要套用原則的 API 物件清單。 loadBalancing 負載平衡配置 (選擇性) LoadBalancing 會定義配置負載平衡選項的結構描述
status BackendLoadBalancingPolicy狀態	狀態會定義 BackendLoadBalancingPolicy 的目前狀態。

BackendLoadBalancingPolicyConditionReason（string 別名）

BackendLoadBalancingPolicyConditionReason 會定義一組原因，說明引發特定 BackendLoadBalancingPolicy 條件類型的原因。

值	描述
"Accepted"	當指定的 BackendLoadBalancingPolicy 正確配置時，BackendLoadBalancingPolicyReasonAccepted 用於將 BackendLoadBalancingPolicyConditionReason 設定為 Accepted。
「矛盾」	當目標引用與預先存在的原則目標衝突時，會使用 BackendLoadBalancingPolicyReasonConflicted
「無效的後端負載平衡原則」	BackendLoadBalancingPolicyReasonInvalid 是 BackendLoadBalancingPolicy’未接受的原因
"InvalidGroup"	如果群組無效，則會使用 BackendLoadBalancingPolicyReasonInvalidGroup
"InvalidKind"	當類型/群組無效時，會使用 BackendLoadBalancingPolicyReasonInvalidKind
"InvalidName"	如果名稱無效，則會使用 BackendLoadBalancingPolicyReasonInvalidName
"InvalidService"	當服務無效時，會使用 BackendLoadBalancingPolicyReasonInvalidService。
"NoTargetReference"	當沒有目標參考時，會使用 BackendLoadBalancingPolicyReasonNoTargetReference。
"RefNotPermitted"	’不允許引用時，會使用 BackendLoadBalancingPolicyReasonRefNotPermitted
"ResolvedRefs"	當指定的 BackendLoadBalancingPolicy 具有正確的參考時，會使用BackendLoadBalancingPolicyReasonResolvedRefs 來將 BackendLoadBalancingPolicyConditionReason 設定為 ResolvedRefs

BackendLoadBalancingPolicyConditionType （string 別名）

BackendLoadBalancingPolicyConditionType 是與 BackendLoadBalancingPolicy 相關聯的條件類型。 此類型應該與 BackendLoadBalancingPolicyStatus.Conditions 欄位搭配使用。

值	描述
"Accepted"	BackendLoadBalancingPolicyConditionAccepted 用於將 BackendLoadBalancingPolicyConditionType 設定為 Accepted
"ResolvedRefs"	BackendLoadBalancingPolicyConditionResolvedRefs 用於將 BackendLoadBalancingPolicyCondition 設定為 ResolvedRefs

後端負載平衡策略連接埠

（出現在：TargetRefSpec）

BackendLoadBalancingPolicyPort 會定義後端負載平衡原則的連接埠組態。

欄位	描述
port 整數32	連接埠是用於連線到後端的連接埠

後端負載平衡政策規格

（出現在：BackendLoadBalancingPolicy， IngressBackendSettings）

BackendLoadBalancingPolicySpec 會定義 BackendLoadBalancingPolicy 的規格。

欄位	描述
targetRefs []目標參考規格	TargetRefs 會識別要套用原則的 API 物件清單。
loadBalancing 負載平衡配置	(選擇性) LoadBalancing 會定義配置負載平衡選項的結構描述

Backend負載平衡策略狀態

（出現在：BackendLoadBalancingPolicy）

BackendLoadBalancingPolicyStatus 會定義 BackendLoadBalancingPolicy 的觀察狀態。

欄位	描述
targets []BackendLoadBalancingPolicyTargetStatus

後端負載平衡政策目標狀態

（出現在：BackendLoadBalancingPolicyStatus）

BackendLoadBalancingPolicyTargetStatus 會定義目標參考的觀察狀態

欄位	描述
targetRef 自訂目標參考
conditions []Kubernetes meta/v1.Condition

BackendTLSPolicy

BackendTLSPolicy 是 BackendTLSPolicies API 的結構描述。

欄位	描述
metadata Kubernetes meta/v1.ObjectMeta	(選擇性) 物件的中繼資料。 如需 metadata 欄位的各欄位，請參閱 Kubernetes API 文件。
spec 後端TLSPolicySpec	Spec 是 BackendTLSPolicy 規格。 targetRef 自訂目標參考 TargetRef 可識別要套用原則的 API 物件。 override 後端TLSPolicyConfig (選擇性) Override 定義原則組態，該組態應該覆寫階層中目標資源下方所附加的原則組態。 注意：目前不支援覆寫，而且會導致驗證錯誤。 未來版本將新增覆寫的支援。 default 後端TLSPolicyConfig (選擇性) Default 定義目標資源的預設原則組態。
status 後端TLSPolicyStatus	Status 定義 BackendTLSPolicy 的目前狀態。

BackendTLSPolicyConfig

(出現於：BackendTLSPolicySpec)

BackendTLSPolicyConfig 定義後端 TLS 原則的原則規格。

欄位	描述
CommonTLSPolicy CommonTLSPolicy	(CommonTLSPolicy 的成員會內嵌在此類型中。)
sni 繩子	(選擇性) Sni 是用於後端 TLS 連線的伺服器名稱。
ports []後端TLSPolicyPort	Ports 指定套用原則的連接埠清單。
clientCertificateRef Gateway API .SecretObjectReference	(選擇性) ClientCertificateRef 是用戶端憑證的參考，用於後端的 TLS 連線。

BackendTLSPolicyPort

(出現於：BackendTLSPolicyConfig)

BackendTLSPolicyPort 定義用於後端 TLS 連線的連接埠

欄位	描述
port 整數	Port 是用於後端 TLS 連線的連接埠

BackendTLSPolicySpec

(出現於：BackendTLSPolicy)

BackendTLSPolicySpec 定義 BackendTLSPolicy 的預期狀態。

欄位	描述
targetRef 自訂目標參考	TargetRef 可識別要套用原則的 API 物件。
override 後端TLSPolicyConfig	(選擇性) Override 定義原則組態，該組態應該覆寫階層中目標資源下方所附加的原則組態。 注意：目前不支援覆寫，而且會導致驗證錯誤。 未來版本將新增覆寫的支援。
default 後端TLSPolicyConfig	(選擇性) Default 定義目標資源的預設原則組態。

BackendTLSPolicyStatus

(出現於：BackendTLSPolicy)

BackendTLSPolicyStatus 定義 BackendTLSPolicy 的觀察狀態。

欄位	描述
conditions []Kubernetes meta/v1.Condition	(選擇性) Conditions 描述 BackendTLSPolicy 的目前條件。 實作應偏好使用 BackendTLSPolicyConditionType 和 BackendTLSPolicyConditionReason 常數來表達 BackendTLSPolicy 條件，讓運算子和工具可以聚合到常見詞彙來描述 BackendTLSPolicy 狀態。 已知條件類型為： “已接受” “已解決的參考”

CommonTLSPolicy

(出現於：BackendTLSPolicyConfig)

CommonTLSPolicy 是 CommonTLSPolicy API 的結構描述。

欄位	描述
verify CommonTLSPolicy驗證	(選擇性) Verify 提供驗證同儕節點憑證的選項。

CommonTLSPolicyVerify

(出現於：CommonTLSPolicy)

CommonTLSPolicyVerify 定義 CommonTLSPolicyVerify API 的結構描述。

欄位	描述
caCertificateRef Gateway API .SecretObjectReference	CaCertificateRef 是用來驗證同儕節點憑證的 CA 憑證。
subjectAltName 繩子	(選擇性) SubjectAltName 是用來驗證同儕節點憑證的主體別名。

CustomTargetRef

（出現在：BackendLoadBalancingPolicyTargetStatus、 BackendTLSPolicySpec、 FrontendTLSPolicySpec、 HealthCheckPolicySpec、 PolicyRefStatus、 RoutePolicySpec、 TargetRefSpec、 WebApplicationFirewallPolicySpec）

CustomTargetRef 是不屬於 Kubernetes 核心 API 的自訂資源參考。

欄位	描述
NamespacedPolicyTargetReference 閘道 API alpha2.NamespacedPolicyTargetReference	(NamespacedPolicyTargetReference 的成員會內嵌在此類型中。)
sectionNames []字串	(選擇性) SectionNames 是目標資源內區段的名稱。 未指定時，此 targetRef 會以整個資源為目標。 在下列資源中，會將 SectionNames 會解譯為下列內容： 閘道：接聽程式名稱 服務：連接埠名稱 如果指定了 SectionNames 但不存在於目標物件上，原則會無法連結，且原則實作會在原則狀態中記錄 ’ 或類似條件。

FrontendTLSPolicy

FrontendTLSPolicy 是 FrontendTLSPolicy API 的結構描述

欄位	描述
metadata Kubernetes meta/v1.ObjectMeta	(選擇性) 物件的中繼資料。 如需 metadata 欄位的各欄位，請參閱 Kubernetes API 文件。
spec 前端TLSPolicySpec	Spec 是 FrontendTLSPolicy 規格。 targetRef 自訂目標參考 TargetRef 可識別要套用原則的 API 物件。 default 前端TLSPolicyConfig (選擇性) Default 定義目標資源的預設原則組態。 override 前端TLSPolicyConfig (選擇性) Override 定義原則組態，該組態應該覆寫階層中目標資源下方所附加的原則組態。 注意：目前不支援覆寫，而且會導致驗證錯誤。 未來版本將新增覆寫的支援。
status 前端TLSPolicyStatus	Status 定義 FrontendTLSPolicy 的目前狀態。

FrontendTLSPolicyConfig

(出現於：FrontendTLSPolicySpec)

FrontendTLSPolicyConfig 定義前端 TLS 原則的原則規格。

欄位	描述
verify MTLSPolicy驗證	(選擇性) Verify 提供驗證同儕節點憑證的選項。
policyType 原則類型	(選擇性) Type 是原則的類型。

FrontendTLSPolicySpec

(出現於：FrontendTLSPolicy)

FrontendTLSPolicySpec 定義 FrontendTLSPolicy 的預期狀態

欄位	描述
targetRef 自訂目標參考	TargetRef 可識別要套用原則的 API 物件。
default 前端TLSPolicyConfig	(選擇性) Default 定義目標資源的預設原則組態。
override 前端TLSPolicyConfig	(選擇性) Override 定義原則組態，該組態應該覆寫階層中目標資源下方所附加的原則組態。 注意：目前不支援覆寫，而且會導致驗證錯誤。 未來版本將新增覆寫的支援。

FrontendTLSPolicyStatus

(出現於：FrontendTLSPolicy)

FrontendTLSPolicyStatus 定義 FrontendTLSPolicy 的觀察狀態。

欄位	描述
conditions []Kubernetes meta/v1.Condition	(選擇性) Conditions 描述 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	Name 是要比對的 HTTP 標頭名稱。 名稱比對必須不區分大小寫。 (請參閱 https://tools.ietf.org/html/rfc7230#section-3.2)。 如果多個項目指定對等的標頭名稱，則必須將具有對等名稱的第一個項目視為相符項目。 必須忽略具有對等標頭名稱的後續項目。 由於標頭名稱不區分大小寫，因此 “foo” 和 “Foo” 視為對等項目。
value 繩子	Value 是要比對的 HTTP 標頭值。

HTTPHeaderName (string 別名)

(出現於：HTTPHeader)

HTTPHeaderName 是 HTTP 標頭的名稱。

有效值包括：

• “授權”
• “Set-Cookie”

無效值包括：

• ”:method” - “:” 是無效的字元。 這表示此類型目前不’支援 HTTP/2 虛擬標頭。
• ”/invalid” - “/ ” 是無效的字元

HTTPMatch

(出現於：HTTPSpecifiers)

HTTPMatch 定義用於 HealthCheck 檢查的 HTTP 比對器。

欄位	描述
body 繩子	(選擇性) Body 定義用於 HealthCheck 檢查的 HTTP 本文比對器。
statusCodes []狀態代碼	(選擇性) StatusCodes 定義用於 HealthCheck 檢查的 HTTP 狀態碼比對器。

HTTPPathModifier

(出現於：Redirect、URLRewriteFilter)

HTTPPathModifier 定義路徑修飾元的組態。

欄位	描述
type HTTPPathModifierType	Type 定義路徑修飾元的類型。 可能會在未來版本的 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 定義路徑重新導向或重寫的類型。

值	描述
“替換全路徑”	FullPathHTTPPathModifier 會將完整路徑取代為指定的值。
"ReplacePrefixMatch"	PrefixMatchHTTPPathModifier 會將任何前置詞路徑取代為替代值。 例如，前置詞相符項目為 “/foo” 且 ReplacePrefixMatch 替代值為 “/bar” 的路徑會在比對要求中將 “/foo” 取代為 “/bar”。 這符合 PathPrefix 比對類型的行為。 這會比對完整路徑元素。 路徑元素是指路徑中依 / 分隔符號分割的標籤清單。 指定時，將會忽略後置 /。 例如，路徑 /abc、/abc/ 和 /abc/def 全都符合前置詞 /abc，但路徑 /abcd 不’符合。

HTTPSpecifiers

(出現於：HealthCheckPolicyConfig)

HTTPSpecifiers 會定義 HTTP HealthCheck 檢查規格的綱目。

欄位	描述
host 繩子	(選擇性) Host 是用於健康檢查檢查的主機標頭值。
path 繩子	(選擇性) Path 是用於 HealthCheck 檢查的路徑。
match HTTPMatch	(選擇性) Match 定義要用於 HealthCheck 檢查的 HTTP 比對器。

標頭篩選器

（出現在：IngressRewrites）

HeaderFilter 定義了一個過濾器，用於修改 HTTP 請求或回應的標頭。 只容許針對指定的標頭名稱執行一個動作。 為任何一個標頭名稱指定相同或不同類型的多個動作的過濾器無效且被拒絕。 設定或新增標頭多個值的設定必須使用 RFC 7230 標頭值格式，並以逗號分隔每個值。

欄位	描述
set []HTTP標頭	(選擇性) Set 會在動作之前使用指定的標頭 （名稱、值） 覆寫要求。 輸入：GET /foo HTTP/1.1 my-header：foo 配置：設定：- 名稱： “my-header” 值： “bar” 輸出：GET /foo HTTP/1.1 my-header: bar
add []HTTP Header	(選擇性) 添加會在動作之前將指定的標頭（名稱、值）添加到請求中。 它會附加至與標頭名稱相關聯的任何現有值。 輸入：GET /foo HTTP/1.1 my-header：foo 配置：添加：- 名稱： “my-header” 值： “bar，baz” 輸出：GET /foo HTTP/1.1 my-header: foo,bar,baz
remove []字串	(選擇性) 在動作之前，從 HTTP 要求中移除指定的標頭。 Remove 的值是 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 配置：刪除：[“my-header1”， “my-header3”] 輸出：GET /foo HTTP/1.1 my-header2: bar

HeaderName （string 暱稱）

HeaderName 是標頭或查詢參數的名稱。

健康檢查政策

HealthCheckPolicy 是 HealthCheckPolicy API 的結構描述。

欄位	描述
metadata Kubernetes meta/v1.ObjectMeta	(選擇性) 物件的中繼資料。 如需 metadata 欄位的各欄位，請參閱 Kubernetes API 文件。
spec 健康檢查政策規範	Spec 是 HealthCheckPolicy 規格。 targetRef 自訂目標參考 TargetRef 可識別要套用原則的 API 物件。 override 健康檢查原則設定 (選擇性) Override 定義原則組態，該組態應該覆寫階層中目標資源下方所附加的原則組態。 注意：目前不支援覆寫，且會導致驗證錯誤。 未來版本將新增覆寫的支援。 default 健康檢查原則設定 (選擇性) Default 定義目標資源的預設原則組態。
status 健康檢查政策狀態	狀態 定義 HealthCheckPolicy 的目前狀態。

HealthCheckPolicyConditionReason (string 別名)

HealthCheckPolicyConditionReason 會定義一組原因，以說明引發特定 HealthCheckPolicy 條件類型的原因。

值	描述
後端TLS政策未找到	當找不到服務的 BackendTLSPolicy 時，會使用 BackendTLSPolicyConditionNotFound。
"Accepted"	HealthCheckPolicyReasonAccepted 可用來將 HealthCheckPolicyConditionReason 設定為 Accepted。 當指定的「HealthCheckPolicy」已正確設定時。
"InvalidHealthCheckPolicy"	HealthCheckPolicyReasonInvalid 是未接受 HealthCheckPolicy 時的原因。
"InvalidGroup"	HealthCheckPolicyReasonInvalidGroup 用於群組無效時。
"InvalidKind"	當類型/群組無效時，會用 HealthCheckPolicyReasonInvalidKind。
"InvalidName"	如果名稱無效，則會使用 HealthCheckPolicyReasonInvalidName。
「無效連接埠」	如果連接埠無效，則會使用 HealthCheckPolicyReasonInvalidPort。
"InvalidService"	如果服務無效，則會使用 HealthCheckPolicyReasonInvalidService。
"NoTargetReference"	HealthCheckPolicyReasonNoTargetReference 會在沒有’目標參考時使用。
「覆寫不支援」	不支援覆寫時，會使用 HealthCheckPolicyReasonOverrideNotSupported。
"RefNotPermitted"	不允許 ref 時，會使用 HealthCheckPolicyReasonRefNotPermitted。
"ResolvedRefs"	當成功解析 targetRef 時，會使用 HealthCheckPolicyReasonResolvedRefs。
"SectionNamesNotPermitted"	不允許區段名稱時，會使用 HealthCheckPolicyReasonSectionNamesNotPermitted。
不支援的狀態碼	當 HealthCheckPolicy 相符項目 StatusCodes 不受支援時，會使用 HealthCheckPolicyReasonUnsupportedStatusCodes。

HealthCheckPolicyConditionType （string 的別名）

HealthCheckPolicyConditionType 是與 HealthCheckPolicy 相關聯的條件類型。 此類型應該與 HealthCheckPolicyStatus.Conditions 欄位搭配使用。

值	描述
"Accepted"	HealthCheckPolicyConditionAccepted 用於將 HealthCheckPolicyConditionType 設定為 Accepted。
"ResolvedRefs"	HealthCheckPolicyConditionResolvedRefs 可用來將 HealthCheckPolicyCondition 設定為 ResolvedRefs。

健康檢查策略設定

（出現在：HealthCheckPolicySpec）

HealthCheckPolicyConfig 會定義 HealthCheck 檢查規格的結構描述。

欄位	描述
interval Kubernetes meta/v1.Duration	(選擇性) 間隔是 HealthCheck 檢查之間的秒數。
timeout Kubernetes meta/v1.Duration	(選擇性) Timeout 是 HealthCheck 檢查視為失敗之前的秒數。
port 整數32	(選擇性) Port 是用於 HealthCheck 檢查的連接埠。
unhealthyThreshold 整數32	(選擇性) UnhealthyThreshold 是連續失敗的 HealthCheck 檢查次數。
healthyThreshold 整數32	(選擇性) HealthyThreshold 是連續成功的 HealthCheck 檢查次數。
useTLS 布爾	(選擇性) UseTLS 指示健康檢查是否應強制執行 TLS。 根據預設，如果使用相同的連接埠進行運作狀態檢查，則運作狀態檢查將使用與服務相同的通訊協定。 如果連接埠不同，健康檢查將是純文本。
http HTTPSpecifiers	(選擇性) HTTP 會定義目標資源 HealthCheck 的 HTTP 限制規格。
grpc GRPC規格	GRPC 會針對目標資源設定 gRPC v1 HealthCheck （https://github.com/grpc/grpc-proto/blob/master/grpc/health/v1/health.proto）。

健康檢查策略規範

（出現在：HealthCheckPolicy）

HealthCheckPolicySpec 會定義 HealthCheckPolicy 的所需狀態。

欄位	描述
targetRef 自訂目標參考	TargetRef 可識別要套用原則的 API 物件。
override 健康檢查原則設定	(選擇性) Override 定義原則組態，該組態應該覆寫階層中目標資源下方所附加的原則組態。 注意：目前不支援覆寫，且會導致驗證錯誤。 未來版本將新增覆寫的支援。
default 健康檢查原則設定	(選擇性) Default 定義目標資源的預設原則組態。

健康檢查策略狀態

（出現在：HealthCheckPolicy）

HealthCheckPolicyStatus 會定義 HealthCheckPolicy 的觀察狀態。

欄位	描述
conditions []Kubernetes meta/v1.Condition	(選擇性) 條件描述 HealthCheckPolicy 的目前條件。 實作應該偏好使用 和 HealthCheckPolicyConditionTypeHealthCheckPolicyConditionReason 常數來表達 HealthCheckPolicy 條件，讓運算子和工具可以收斂在通用詞彙上，以描述 HealthCheckPolicy 狀態。 已知條件類型為： “已接受”

IngressBackendPort

（出現在：IngressBackendSettings）

IngressBackendPort 描述後端上的連接埠。 只能定義名稱/號碼中的一個。

欄位	描述
port 整數32	(選擇性) 連接埠表示後端服務上的連接埠
name 繩子	(選擇性) 名稱必須參照後端服務上連接埠上的名稱
protocol 協議	通訊協定應為HTTP、“”HTTPS之一“”

IngressBackendSetting 的狀態

（出現在：IngressExtensionStatus）

IngressBackendSettingStatus 描述 BackendSetting 的狀態

欄位	描述
service 繩子	服務會識別出此狀態描述的 BackendSetting 內容。
validationErrors []字串	(選擇性) 錯誤是與此設定相關的錯誤清單
valid 布爾	Valid 表示此 BackendSetting 上沒有驗證錯誤

IngressBackend設置

（出現在：IngressExtensionSpec）

IngressBackendSettings 為後端服務提供擴充組態選項

欄位	描述
service 繩子	服務是此組態所套用的後端服務的名稱
ports []IngressBackendPort	(選擇性) Ports 用來指出後端服務是否在 HTTP 或 HTTPS 上接聽
trustedRootCertificate 繩子	(選擇性) TrustedRootCertificate 可用來提供閘道在指定為 https 的埠上與後端通訊時要信任的憑證
sessionAffinity SessionAffinity	(選擇性) SessionAffinity 允許將客戶端請求一致地提供給相同的後端
timeouts IngressTimeouts	(選擇性) Timeouts 定義一組要套用至輸入的逾時參數
loadBalancingPolicySpec 後端負載平衡政策規格	(選擇性) LoadBalancing 會定義後端服務的負載平衡原則

Ingress擴充功能

IngressExtension 是 IngressExtension API 的結構描述

欄位	描述
metadata Kubernetes meta/v1.ObjectMeta	(選擇性) 物件的中繼資料。 如需 metadata 欄位的各欄位，請參閱 Kubernetes API 文件。
spec IngressExtensionSpec	Spec 是 IngressExtension 規格。 rules []IngressRuleSetting (選擇性) 規則會定義每個主機的規則 backendSettings []Ingress後端設定 (選擇性) BackendSettings 會定義一組 Ingress 服務後端的組態選項
status IngressExtensionStatus

IngressExtensionConditionReason (string 別名)

IngressExtensionConditionReason 會定義一組原因，以說明引發特定 IngressExtension 條件類型的原因。

值	描述
"Accepted"	IngressExtensionReasonAccepted 可用來將 IngressExtensionConditionAccepted 設定為 Accepted
是否有驗證錯誤	IngressExtensionReasonHasErrors 表示有一些驗證錯誤
無驗證錯誤	IngressExtensionReasonNoErrors 表示沒有驗證錯誤
部分接受但存在錯誤	IngressExtensionReasonPartiallyAccepted 用於將 IngressExtensionConditionAccepted 設定為 Accepted，但存在非嚴重的驗證錯誤。

IngressExtensionConditionType （string 別名）

IngressExtensionConditionType 是與 IngressExtension 相關聯的條件類型。 此類型應該與 IngressExtensionStatus.Conditions 欄位搭配使用。

值	描述
"Accepted"	IngressExtensionConditionAccepted 指出 IngressExtension 是否被控制器接受並協調
“錯誤”	IngressExtensionConditionErrors 指出延伸模組上是否有驗證或建置錯誤

IngressExtensionSpec

（出現在：IngressExtension）

IngressExtensionSpec 定義了 IngressExtension 所需的配置

欄位	描述
rules []IngressRuleSetting	(選擇性) 規則會定義每個主機的規則
backendSettings []Ingress後端設定	(選擇性) BackendSettings 會定義一組 Ingress 服務後端的組態選項

Ingress擴充狀態

（出現在：IngressExtension）

IngressExtensionStatus 描述 IngressExtension 的目前狀態

欄位	描述
rules []IngressRuleStatus	(選擇性) 規則具有有關每個規則的詳細狀態資訊
backendSettings []IngressBackendSetting狀態	(選擇性) BackendSettings 具有有關每個 BackendSettings 的詳細狀態資訊
conditions []Kubernetes meta/v1.Condition	(選擇性) 條件描述 IngressExtension 的目前條件。 已知條件類型為： “已接受” “錯誤”

IngressRewrites

（出現在：IngressRuleSetting）

IngressRewrites 提供規則支援的各種重寫

欄位	描述
type 重寫類型	類型會識別重寫的類型
requestHeaderModifier 標頭篩選器	(選擇性) RequestHeaderModifier 定義修改請求標頭的結構描述。
responseHeaderModifier 標頭篩選器	(選擇性) RequestHeaderModifier 會定義修改回應標頭的結構描述。
urlRewrite URLRewrite篩選器	(選擇性) URLRewrite 定義了在轉送期間修改請求的結構描述。

IngressRule設定

（出現在：IngressExtensionSpec）

IngressRuleSetting 提供規則的組態選項

欄位	描述
host 繩子	主機用於與具有相同主機名的 Ingress 規則進行匹配，以識別哪些規則影響這些設定。
additionalHostnames []字串	(選擇性) AdditionalHostnames 指定更多要監控的主機名稱
rewrites []Ingress 重寫	(選擇性) Rewrites 定義規則的重寫
requestRedirect 重新導向	(選擇性) RequestRedirect 會定義規則的重新導向行為

IngressRuleStatus

（出現在：IngressExtensionStatus）

IngressRuleStatus 描述規則的狀態

欄位	描述
host 繩子	主機辨識此狀態所描述的規則
validationErrors []字串	(選擇性) 錯誤是與此設定相關的錯誤清單
valid 布爾	(選擇性) 有效 表示此規則上沒有驗證錯誤

IngressTimeouts

（出現在：IngressBackendSettings）

IngressTimeouts 可用來配置 Ingress 的超時屬性

欄位	描述
requestTimeout Kubernetes meta/v1.Duration	(選擇性) RequestTimeout 定義負載平衡器在將請求轉送至後端服務時使用的逾時

負載均衡設定

（出現在：BackendLoadBalancingPolicySpec）

LoadBalancingConfig 會定義負載平衡的組態。

欄位	描述
strategy 負載平衡策略	(選擇性) 策略會定義在將流量負載平衡至後端服務時要使用的原則。 預設值為 round-robin。
slowStart 慢速啟動配置	(選擇性) SlowStart 會定義慢速啟動規格的架構

LoadBalancingStrategy （string 別名）

（出現在：LoadBalancingConfig）

LoadBalancingStrategy 定義了在服務之間平衡流量時要使用的策略

值	描述
"least-request"	LoadBalancingLeastRequest 用於將 LoadBalancingStrategy 設定為 least-request
“環哈希”	LoadBalancingRingHash 用於將 LoadBalancingStrategy 設定為 ring-hash
"round-robin"	LoadBalancingRoundRobin 用於將 LoadBalancingStrategy 設定為 round-robin

MTLSPolicyVerify

（出現在：FrontendTLSPolicyConfig）

MTLSPolicyVerify定義MTLSPolicyVerify API的綱目。

欄位	描述
caCertificateRef Gateway API .SecretObjectReference	CaCertificateRef 是用來驗證同儕節點憑證的 CA 憑證。
subjectAltNames []字串	(選擇性) SubjectAltNames 是用來驗證對等憑證的主體替代名稱清單。

PolicyConditionReason （string 別名）

PolicyConditionReason 是用於不同 ALB 相關原則 CRD 的原因類型。

值	描述
"Accepted"
「矛盾」
「已部署」
「部署失敗」
「無效」
"InvalidCertificateRef"
"InvalidGroup"
"InvalidKind"
"InvalidName"
"InvalidService"
「無效目標參考」
“無部署”
"NoTargetReference"
「作業失敗」
"OverrideNotSupported"
「待處理」
"Programmed"
“編程失敗”
"RefNotPermitted"
"ResolvedRefs"
"SectionNamesNotPermitted"

PolicyConditionType （string 別名）

PolicyConditionType 是用於不同 ALB 相關原則 CRD 的條件類型。

值	描述
"Accepted"
"Deployment"
已編程
"ResolvedRefs"

政策參考狀態

PolicyRefStatus 會定義支援多個目標參考之原則的單一目標參考狀態。

欄位	描述
targetRef 自訂目標參考	TargetRef 是套用此原則的目標物件的參考
conditions []Kubernetes meta/v1.Condition	(選擇性) 條件描述容器應用程式閘道 IP 存取規則的目前條件，因為它們與特定 targetRef 相關。

原則類型

（出現在：FrontendTLSPolicyConfig）

PolicyType 是原則的類型。

欄位	描述
name 前端TLSPolicyTypeName	名稱是政策的名稱。
type 前端TLSPolicyType	FrontendTLSPolicyType 指定前端 TLS 原則類型

PortNumber （int32 別名）

（出現於：重新導向）

PortNumber 會定義網路埠。

PreciseHostname（string 別名）

(出現於：Redirect、URLRewriteFilter)

PreciseHostname 是網路主機的完整網域名稱。 這與主機名的 RFC 1123 定義相符，但有一個值得注意的例外，即不允許使用數字 IP 地址’。

根據 RFC1035 和 RFC1123， 標籤 必須由小寫英數字元或 ‘-’ 組成，並且必須以英數字元開頭和結尾。 不允許使用其他標點符號。

通訊協定 （string 別名）

（出現在：IngressBackendPort）

通訊協定 定義用於特定內容的通訊協定。 有效的通訊協定值為：

• HTTP
• HTTPS
• TCP

值	描述
“HTTP”	ProtocolHTTP 表示服務使用 HTTP。
“HTTPS”	ProtocolHTTPS 表示服務使用 HTTPS。
“TCP”	ProtocolTCP 表示服務使用純 TCP。

重新導向

（出現在：IngressRuleSetting）

重新導向會定義重新導向要求的篩選器。 這「不得」用於同樣具有 URLRewriteFilter 的相同規則。

欄位	描述
scheme 繩子	(選擇性) Scheme 是用於回應 Location 標頭值的配置。 如果為空，將使用請求的架構。
hostname 精確主機名稱	(選擇性) Hostname 是用於回應 Location 標頭值的主機名稱。 當為空時，會使用請求標頭中的 Host 主機名稱。
path HTTPPath修改器	(選擇性) 路徑 定義用來修改傳入要求路徑的參數。 然後使用修改後的路徑來建構 Location 標頭。 請求路徑一旦為空，即按原樣使用。
port 連接埠號碼	(選擇性) Port 是用於回應 Location 標頭值的連接埠。 如果未指定埠，則必須使用下列規則衍生重新導向埠： 如果重新導向配置不是空的，則重新導向埠必須是與重新導向配置相關聯的已知連接埠。 具體來說，“http” 到連接埠 80，https “” 到連接埠 443。 如果重新導向配置’沒有已知連接埠，則應使用閘道的接聽器連接埠。 如果重新導向配置是空的，則重新導向埠必須是閘道偵聽程式埠。 實作不應該在下列情況下，於 ‘Location’ 標頭中新增連接埠號碼： 使用 HTTP 的 [位置] 標頭 (無論是透過接聽程式通訊協定或 [配置] 欄位來決定) 與 使用連接埠 80。 使用 HTTPS [位置] 標頭 (無論是透過接聽程式通訊協定或 [配置] 欄位來決定) 與 使用連接埠 443。
statusCode 整數	(選擇性) StatusCode 是要用於回應的 HTTP 狀態碼。 可以將值新增至此列舉，實作必須確保未知值’不會造成當機。

RewriteType （string 別名）

（出現在：IngressRewrites）

RewriteType 會識別重寫類型

值	描述
“請求標頭修改器”	RequestHeaderModifier 可用來在將 HTTP 要求傳送至上游目標之前，先’從 HTTP 要求中新增或移除 HTTP 標頭。
回應標頭修改器	ResponseHeaderModifier 可用來在將 HTTP 回應傳送至用戶端之前，在’HTTP 回應中新增或移除 HTTP 標頭。
“網址重寫”	URLRewrite 可用於在轉送期間修改請求。

路由策略

RoutePolicy 是 RoutePolicy API 的架構。

欄位	描述
metadata Kubernetes meta/v1.ObjectMeta	(選擇性) 物件的中繼資料。 如需 metadata 欄位的各欄位，請參閱 Kubernetes API 文件。
spec 路由原則規格	Spec 是 RoutePolicy 規格。 targetRef 自訂目標參考 TargetRef 可識別要套用原則的 API 物件。 override 路由策略配置 (選擇性) Override 定義原則組態，該組態應該覆寫階層中目標資源下方所附加的原則組態。 注意：目前不支援覆寫，而且會導致驗證錯誤。 未來版本將新增覆寫的支援。 default 路由策略配置 (選擇性) Default 定義目標資源的預設原則組態。
status RoutePolicyStatus	狀態 定義 RoutePolicy 的目前狀態。

RoutePolicyConditionReason （string 別名）

RoutePolicyConditionReason 會定義一組原因，說明引發特定 RoutePolicy 條件類型的原因。

值	描述
"Accepted"	RoutePolicyReasonAccepted 用來在指定的 RoutePolicy 正確設定時，將 RoutePolicyConditionReason to Accepted 設定為 Accepted
"AcceptedWithTimeoutConflict"	當指定的 RoutePolicy 已正確設定，但與目標路由發生逾時衝突時，RoutePolicyReasonAcceptedWithTimeoutConflict 會用於將 RoutePolicyConditionReason 設定為 AcceptedWithTimeoutConflict
「無效路由原則」	RoutePolicyReasonInvalid 是未接受 RoutePolicy 時的原因
"InvalidGRPCRoute"	當 GRPCRoute 無效時，將使用 RoutePolicyReasonInvalidGRPCRoute。
"InvalidGroup"	如果群組無效，則會使用 RoutePolicyReasonInvalidGroup
「無效的HTTPRoute」	當 HTTPRoute 無效時，會使用 RoutePolicyReasonInvalidHTTPRoute
"InvalidKind"	當種類/群組無效時，RoutePolicyReasonInvalidKind 會被使用。
"InvalidName"	當名稱無效時，RoutePolicyReasonInvalidName 會被使用。
"NoTargetReference"	當沒有’目標參考時，會使用 RoutePolicyReasonNoTargetReference
「覆寫不支援」	不支援’覆寫時，會使用 RoutePolicyReasonOverrideNotSupported
"RefNotPermitted"	RoutePolicyReasonRefNotPermitted 用於當參考’不被允許時。
"SectionNamesNotPermitted"	不’允許區段名稱時，會使用 RoutePolicyReasonSectionNamesNotPermitted

RoutePolicyConditionType （string 別名）

RoutePolicyConditionType 是與 RoutePolicy 相關聯的條件類型。 此類型應該與 RoutePolicyStatus.Conditions 欄位搭配使用。

值	描述
"Accepted"	RoutePolicyConditionAccepted 可用來將 RoutePolicyConditionType 設定為 Accepted
"ResolvedRefs"	RoutePolicyConditionResolvedRefs 用於將 RoutePolicyCondition 設定為 ResolvedRefs

路由策略配置

（出現在：RoutePolicySpec）

RoutePolicyConfig 會定義 RoutePolicy 規格的結構描述。 這允許下列屬性的規格：* 逾時 * 工作階段親和性

欄位	描述
timeouts 路由超時	(選擇性) 自訂超時設定 目標資源的超時設定。
sessionAffinity SessionAffinity	(選擇性) SessionAffinity 定義會話黏性規格的架構描述

路由策略規範

（出現在：RoutePolicy）

RoutePolicySpec 定義 RoutePolicy 的所需狀態。

欄位	描述
targetRef 自訂目標參考	TargetRef 可識別要套用原則的 API 物件。
override 路由策略配置	(選擇性) Override 定義原則組態，該組態應該覆寫階層中目標資源下方所附加的原則組態。 注意：目前不支援覆寫，而且會導致驗證錯誤。 未來版本將新增覆寫的支援。
default 路由策略配置	(選擇性) Default 定義目標資源的預設原則組態。

路由策略狀態

（出現在：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 親和性類型
cookieName 繩子	(選擇性)
cookieDuration Kubernetes meta/v1.Duration	(選擇性)

慢速啟動配置

（出現在：LoadBalancingConfig）

SlowStartConfig 會定義慢速啟動的組態。

欄位	描述
window Kubernetes meta/v1.Duration	緩慢啟動視窗的持續時間。
aggression 繩子	(選擇性) 在緩慢啟動時段期間增加的流量速度必須大於 0.0。 如果未指定，則預設為 1.0。
startWeightPercent uint32	(選擇性) 要傳送至新端點的流量的最小百分比或起始百分比。 如果未指定，則預設為 10%。

狀態代碼

（出現在：HTTPMatch）

StatusCodes 定義用於 HealthCheck 檢查的 HTTP 狀態碼比對器。

欄位	描述
start 整數32	(選擇性) Start 定義用於 HealthCheck 檢查的狀態碼範圍開頭。 此值也包含在內。
end 整數32	(選擇性) End 定義要用於 HealthCheck 檢查的狀態碼範圍的結尾。 此值也包含在內。

目標參考規格

（出現在：BackendLoadBalancingPolicySpec）

TargetRefSpec 會定義後端負載平衡原則的目標參考和連接埠。

欄位	描述
targetRef 自訂目標參考	TargetRef 可識別要套用原則的 API 物件。
ports []後端負載平衡原則連接埠	(選擇性) Ports 指定在目標上套用原則的連接埠列表。

URLRewrite篩選器

（出現在：IngressRewrites）

URLRewriteFilter 會定義在轉送期間修改要求的篩選條件。 這些過濾器最多只能在一個規則上使用一個。 這「不得」用於具有 sslRedirect 的相同規則。

欄位	描述
hostname 精確主機名稱	(選擇性) Hostname 是在轉送期間用來取代主機標頭值的值。
path HTTPPath修飾詞	(選擇性) Path 定義路徑重寫。

WebApplicationFirewallConfig

（出現在：WebApplicationFirewallPolicySpec）

WebApplicationFirewallConfig 會定義容器安全性原則子資源的應用程式閘道 Web 應用程式防火牆原則設定。

欄位	描述
id 繩子

WebApplication防火牆原則

WebApplicationFirewallPolicy 是容器應用程式閘道安全性原則子資源的架構。

欄位	描述
metadata Kubernetes meta/v1.ObjectMeta	(選擇性) 物件的中繼資料。 如需 metadata 欄位的各欄位，請參閱 Kubernetes API 文件。
spec WebApplication防火牆原則規格	規格是「容器應用程式閘道安全性原則」子資源的規格。 targetRef 自訂目標參考 TargetRef 可識別要套用原則的 API 物件。 webApplicationFirewall WebApplicationFirewallConfig WebApplicationFirewallPolicy 用來指定 WebApplicationPolicy 資源
status WebApplicationFirewallPolicy狀態	狀態會定義容器安全性原則子資源的應用程式閘道目前狀態。

WebApplication防火牆原則規格

（出現在：WebApplicationFirewallPolicy）

WebApplicationFirewallPolicySpec 定義 WebApplicationFirewallPolicy 的所需狀態。

欄位	描述
targetRef 自訂目標參考	TargetRef 可識別要套用原則的 API 物件。
webApplicationFirewall WebApplicationFirewallConfig	WebApplicationFirewallPolicy 用來指定 WebApplicationPolicy 資源

Web 應用程式防火牆政策狀態

（出現在：WebApplicationFirewallPolicy）

WebApplicationFirewallPolicyStatus 會定義容器安全性原則子資源的應用程式閘道觀察到的狀態。

欄位	描述
conditions []Kubernetes meta/v1.Condition	(選擇性) 已知條件類型為： “已接受” “部署” “已解決的參考” “Programmed”