Annotation

說明

alb.ingress.kubernetes.io/healthcheck-enabled

是否開啟后端服務器組的健康檢查。健康檢查的配置示例，請參見配置健康檢查。

• true：開啟健康檢查。

• false：不開啟健康檢查。

默認值：false。

alb.ingress.kubernetes.io/healthcheck-path

健康檢查路徑。

默認值：/。

alb.ingress.kubernetes.io/healthcheck-protocol

健康檢查使用的協議。

• HTTP：使用HTTP協議，通過發送HEAD或GET請求模擬瀏覽器的訪問行為檢查服務器應用是否健康。

• HTTPS：使用HTTPS協議，通過發送HEAD或GET請求模擬瀏覽器的訪問行為檢查服務器應用是否健康。

• TCP：使用TCP協議，通過發送SYN握手報文檢測服務器端口是否存活。

• GRPC：使用gRPC協議，通過發送POST或GET請求檢查服務器應用是否健康。

默認值：HTTP。

alb.ingress.kubernetes.io/healthcheck-httpversion

HTTP協議版本，healthcheck-protocol為HTTP或HTTPS時生效。

• HTTP1.0

• HTTP1.1

默認值：HTTP1.1。

alb.ingress.kubernetes.io/healthcheck-method

健康檢查的方法。

• HEAD

• POST

• GET

默認值：HEAD。

alb.ingress.kubernetes.io/healthcheck-httpcode

健康檢查狀態碼。僅當探測請求成功且返回指定狀態碼時，才認為該后端服務器狀態正常。

可以填入以下選項中的任意一個或多個組合，多個狀態碼用英文半角逗號（,）分隔：

• http_2xx

• http_3xx

• http_4xx

• http_5xx

默認值：http_2xx。

alb.ingress.kubernetes.io/healthcheck-code

健康檢查狀態碼，僅當探測請求成功且返回指定狀態碼時，才認為該后端服務器狀態正常。

與healthcheck-httpcode同時使用時，以此字段為準。

可選參數依賴于healthcheck-protocol中填入的值：

• HTTP或HTTPS：

  可以填入以下選項中的任意一個或多個組合，多個狀態碼用英文半角逗號（,）分隔：

  • http_2xx

  • http_3xx

  • http_4xx

  • http_5xx

  默認值：http_2xx。

• GRPC：

  取值范圍：[0, 99]。

  默認值：0。

  支持范圍輸入，最多填入20個范圍值，多個范圍值使用英文半角逗號（,）分隔。

alb.ingress.kubernetes.io/healthcheck-timeout-seconds

健康檢查超時時間，單位秒（s）。

取值范圍：[1, 300]。

默認值：5。

alb.ingress.kubernetes.io/healthcheck-interval-seconds

健康檢查間隔周期，單位秒（s）。

取值范圍：[1, 50]。

默認值：2。

alb.ingress.kubernetes.io/healthy-threshold-count

健康檢查成功多少次判定為成功。

取值范圍：[2, 10]。

默認值：3。

alb.ingress.kubernetes.io/unhealthy-threshold-count

健康檢查失敗多少次判定為失敗。

取值范圍：[2, 10]。

默認值：3。

alb.ingress.kubernetes.io/healthcheck-connect-port

健康檢查使用的端口。

默認值：0。

Annotation

說明

alb.ingress.kubernetes.io/ssl-redirect

是否對HTTP請求返回308狀態碼，重定向到HTTPS監聽（443端口）。重定向的配置示例，請參見配置HTTP重定向至HTTPS。

• true：重定向到HTTPS。

• false：不重定向到HTTPS。

默認值：false。

Annotation

說明

alb.ingress.kubernetes.io/backend-protocol

后端服務器組所使用的協議。配置示例請參見支持后端HTTPS和gRPC協議。

• http：使用HTTP協議。

• https：使用HTTPS協議。

• grpc：使用gRPC協議。

默認值：http。

Annotation

說明

alb.ingress.kubernetes.io/rewrite-target

路徑重寫的地址。使用重寫的配置示例，請參見Rewrite重寫。

Annotation

說明

alb.ingress.kubernetes.io/listen-ports

Ingress資源關聯的監聽端口與協議。配置示例請參見配置自定義監聽端口。

可以填寫希望ingress規則配置的監聽協議及監聽端口（下方為示例）：

• '[{"HTTP": 80}]' ：關聯80端口的HTTP監聽。

• '[{"HTTPS": 443}]' ：關聯443端口的HTTPS監聽。

• '[{"QUIC": 443}]' ：關聯443端口的QUIC監聽。

• '[{"HTTP": 80}, {"HTTPS": 443}]' ：同時關聯80端口的HTTP監聽與443端口的HTTPS監聽。

• '[{"HTTPS": 443}, {"QUIC": 443}]' ：同時關聯443端口的HTTPS監聽與QUIC監聽。

Annotation

說明

alb.ingress.kubernetes.io/slow-start-enabled

是否啟用慢啟動功能。啟用慢啟動后，ALB Ingress在新增Pod被添加到Service后端時，會逐步將流量分配到新增Pod中，以避免造成Pod啟動后瞬時CPU與內存高壓造成的異常。慢啟動的配置示例請參見后端慢啟動。

• true：啟用慢啟動功能。

• false：不啟用慢啟動功能。

默認不開啟。

alb.ingress.kubernetes.io/slow-start-duration

慢啟動完成流量逐步增加所花費的時間，時間越長，流量增加的速度越慢，單位秒（s）。

取值范圍：[30, 900]。

默認值：30。

Annotation

說明

alb.ingress.kubernetes.io/order

轉發規則的相對優先級，數字越小優先級越高。優先級的配置示例，請參見配置轉發規則優先級。

取值范圍：[1, 1000]。

默認值：10。

Annotation

說明

alb.ingress.kubernetes.io/canary

是否啟用Canary灰度。使用Canary進行灰度發布的具體操作，請參見通過ALB Ingress實現灰度發布。

• true：啟用灰度。

• false：不啟用灰度。

默認值：false。

alb.ingress.kubernetes.io/canary-by-header

啟用灰度時所命中的請求標頭。

alb.ingress.kubernetes.io/canary-by-header-value

啟用灰度時命中的請求標頭對應的標頭值。

alb.ingress.kubernetes.io/canary-by-cookie

啟用灰度時的Cookie標記。

Annotation

說明

alb.ingress.kubernetes.io/sticky-session

是否開啟后端服務器組會話保持。會話保持的配置示例，請參見通過注解實現會話保持。

• true：開啟會話保持。

• false：不開啟會話保持。

默認值：false。

alb.ingress.kubernetes.io/sticky-session-type

開啟會話保持的類型。

• Insert：植入Cookie模式。客戶端第一次訪問時，ALB實例會在返回請求中植入Cookie。

• Server：重寫Cookie模式。當ALB實例發現用戶自定義了Cookie，將會對原來的Cookie進行重寫。

默認值：Insert。

alb.ingress.kubernetes.io/cookie-timeout

會話保持超時時間，單位秒（s）。

取值范圍：[1, 86400]。

默認值：1000。

Annotation

說明

alb.ingress.kubernetes.io/connection-drain-enabled

是否開啟連接優雅中斷。開啟優雅中斷后，ALB Ingress在后端Pod進入Terminating狀態或健康檢查報告異常時保持一定時間的正常傳輸，在到達超時時間后再中斷連接，可以防止后端突然移除對業務的影響。優雅中斷的具體工作原理請參見連接優雅中斷。

• true：開啟優雅中斷。

• false：不開啟優雅中斷。

默認不開啟。

alb.ingress.kubernetes.io/connection-drain-timeout

優雅中斷超時時間，單位秒（s）。

取值范圍：[0, 900]。

默認值：300。

Annotation

說明

alb.ingress.kubernetes.io/backend-scheduler

后端服務器組負載均衡算法。負載均衡算法的配置示例，請參見指定服務器組負載均衡算法。

• wrr：加權輪詢。權重值越高的后端服務器，被輪詢到的概率越高。

• wlc：加權最小連接數。當權重值相同時，當前連接數越小的后端服務器被輪詢到的概率越高。

• sch：源IP哈希。相同的源IP地址會調度到相同的后端服務器。

• uch：URL哈希。相同的URL參數會調度到相同的后端服務器。

默認值：wrr。

alb.ingress.kubernetes.io/backend-scheduler-uch-value

負載均衡算法為“uch”時，使用的URL哈希參數。

Annotation

說明

alb.ingress.kubernetes.io/enable-cors

是否啟用跨域配置。配置示例，請參見跨域配置。

• true：啟用跨域配置。

• false：不啟用跨域配置。

默認值：false。

alb.ingress.kubernetes.io/cors-allow-origin

允許跨域的源。

默認值：*。

alb.ingress.kubernetes.io/cors-expose-headers

允許暴露的Header列表。

alb.ingress.kubernetes.io/cors-allow-methods

允許跨域的請求方法。

可以填入以下選項中的任意一個或多個組合：

• GET

• POST

• PUT

• DELETE

• HEAD

• OPTIONS

• PATCH

默認值："GET, PUT, POST, DELETE, PATCH, OPTIONS"。

alb.ingress.kubernetes.io/cors-allow-credentials

跨域是否允許攜帶憑證信息。

• true：允許攜帶。

• false：不允許攜帶。

默認值：true。

alb.ingress.kubernetes.io/cors-max-age

預檢請求在瀏覽器中的最大的緩存時間，單位秒（s）。

取值范圍：[-1, 172800]。

默認值：172800。

alb.ingress.kubernetes.io/cors-allow-headers

允許跨域的Header列表。

默認值："DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization"。

Annotation

說明

alb.ingress.kubernetes.io/actions.{svcName}

自定義轉發動作。自定義轉發的具體操作，請參見自定義ALB Ingress的轉發規則。

alb.ingress.kubernetes.io/conditions.{svcName}

自定義轉發條件。

alb.ingress.kubernetes.io/rule-direction.{svcName}

自定義轉發方向。

• Request：接收請求時的自定義轉發。

• Response：響應時的自定義轉發。

默認值：Request。

Annotation

說明

alb.ingress.kubernetes.io/backend-keepalive

是否啟用后端長鏈接。配置示例請參見后端長連接。

默認值：false。

alb.ingress.kubernetes.io/traffic-limit-qps

QPS限速配置。

取值范圍：[1, 100000]。

alb.ingress.kubernetes.io/use-regex

允許Path字段使用正則，僅在Prefix類型下生效。

默認值：false。

字段

取值類型

說明

apiVersion

固定取值

APIVersion定義了該對象的版本化模式。

固定取值：alibabacloud.com/v1。

kind

固定取值

Kind表示該對象所代表的REST資源。

固定取值：AlbConfig。

metadata

ObjectMeta

標準對象的metadata。

關于metadata的更多信息，請參見metadata。

spec

AlbConfigSpec

用來描述ALB實例屬性和監聽屬性的參數列表。

status

AlbConfigStatus

在調和成功后，會將實例狀態寫入status中，寫入的值表示實例的當前狀態。

字段

取值類型

說明

config

LoadBalancerSpec

ALB實例的屬性。

listeners

ListenerSpec[]

實例下的監聽屬性。

字段

取值類型

說明

id

string

ALB實例ID，填寫代表啟用復用模式。置空表示不指定，會由controller創建一個ALB實例。創建新ALB實例或復用已有實例的具體操作，請參見創建AlbConfig。

默認值：""。

name

string

ALB實例名。

默認值：使用以下規則自動生成：k8s-{namespace}-{name}-{hashCode}。

addressAllocatedMode

enum

ALB實例的地址模式。

• Dynamic：ALB實例在每個可用區至少有一個IP，隨著業務請求的增加，會自動擴展IP數量。此模式下最大支持100萬QPS。

• Fixed：每個可用區有且只有一個IP，并且IP地址保持固定不變。此模式下實例彈性能力有限，最大支持10萬QPS。

默認值：Dynamic。

addressType

enum

ALB實例的IPv4網段地址類型。

• Internet：公網模式。會自動擁有一個公網域名。

• Intranet：私網模式。

默認值：Internet。

ipv6AddressType

enum

ALB的IPv6網段地址類型。不需要與IPv4網段地址類型保持一致。

• Internet：公網模式。會自動擁有一個公網域名。

• Intranet：私網模式。

默認值：Intranet。

addressIpVersion

enum

ALB實例是否支持雙棧。

• IPv4：只支持IPv4。

• DualStack：雙棧，同時支持IPv4與IPv6。

默認值：IPv4

resourceGroupId

string

實例所屬的資源組ID。

默認值：""。

edition

enum

實例的功能版本。復用模式不支持修改實例的功能版本。

• Standard：標準版。

• StandardWithWaf：WAF增強版實例，請參見使用ALB WAF增強版實例保護服務。

默認值：Standard。

deletionProtectionEnabled

bool

保留字段，請勿修改。

forceOverride

bool

復用模式下強制覆蓋實例屬性。

• true：強制覆蓋。

• false：不強制覆蓋。

• null：不強制覆蓋。

默認值：false。

listenerForceOverride

bool

復用模式下強制覆蓋監聽屬性。

• true：強制覆蓋。

• false：不強制覆蓋。

• null：不強制覆蓋。

默認值：null。

zoneMappings

ZoneMapping[]

可用區和EIP配置。

accessLogConfig

AccessLogConfig

日志收集。

billingConfig

BillingConfig

計費方式。

modificationProtectionConfig

ModificationProtectionConfig

配置修改保護。

tags

Tag[]

實例標簽。

字段

取值類型

說明

vSwitchId

string

（必填）虛擬交換機的ID。

默認值：""。

zoneId

string

虛擬交換機的可用區。

默認值：""。

allocationId

string

彈性公網EIP的ID。

默認值：""。

eipType

string

保留字段，請勿修改。

字段

取值類型

說明

logProject

string

SLS日志項目的名稱。

默認值：""。

logStore

string

SLS日志庫的名稱，必須以alb_開頭。如果不存在此日志庫，則會自動創建。SLS日志庫的配置示例，請參見開啟日志服務訪問日志。

默認值：""。

字段

取值類型

說明

internetBandwidth

int

保留字段，請勿修改。

internetChargeType

string

保留字段，請勿修改。

payType

enum

保留字段，請勿修改。

bandWidthPackageId

string[]

綁定共享帶寬包ID。綁定后不支持解綁。

默認值：""。

字段

取值類型

說明

reason

string

保留字段。

status

string

保留字段。

字段

取值類型

說明

key

string

標簽的Key值。

默認值：""。

value

string

標簽的Value值。

默認值：""。

字段

取值類型

說明

gzipEnabled

bool

是否開啟數據壓縮功能。數據壓縮的配置示例，請參見使用數據壓縮功能。

• true：開啟壓縮。

• false：不開啟壓縮。

• null：開啟壓縮。

默認值：null。

http2Enabled

bool

是否開啟HTTP/2協議。

• true：開啟HTTP/2。

• false：不開啟HTTP/2。

• null：開啟HTTP/2。

默認值：null。

port

int

（必填）監聽使用的端口。

默認值：0。

protocol

enum

（必填）監聽使用的協議。

• HTTP：使用HTTP協議。

• HTTPS：使用HTTPS協議。

• QUIC：使用QUIC協議。

securityPolicyId

string

TLS安全策略的ID。

默認值：""。

idleTimeout

int

空閑鏈接超時時間，單位秒（s）。

默認值：15。

loadBalancerId

string

保留字段，請勿修改。

description

string

監聽的名稱。

默認值：使用以下規則自動生成：ingress-auto-listener-{port}。

caEnabled

bool

是否開啟雙向認證功能。

• true：開啟雙向認證。

• false：不開啟雙向認證。

默認值：false。

requestTimeout

int

請求超時時間，單位秒（s）。

默認值：60。

quicConfig

QuicConfig

Quic監聽配置。

defaultActions

Action[]

保留字段，請勿修改。

caCertificates

Certificate[]

監聽的根CA證書。

certificates

Certificate[]

監聽的服務器證書。

xForwardedForConfig

XForwardedForConfig

XForward字段配置信息。

logConfig

LogConfig

監聽日志相關配置。

aclConfig

AclConfig

訪問控制。

字段

取值類型

說明

quicUpgradeEnabled

bool

是否開啟QUIC升級。在聯合使用QUIC與HTTPS監聽的場景中，quicUpgradeEnabled用于關聯或解關聯QUIC與HTTPS監聽。詳細操作，請參見使用QUIC監聽兼容HTTP/3協議。

• true：開啟QUIC升級，關聯QUIC與HTTPS監聽。

• false：不開啟QUIC升級，不關聯QUIC與HTTPS監聽。

默認值：false。

quicListenerId

string

QUIC監聽關聯的HTTPS監聽。

默認值：""。

字段

取值類型

說明

IsDefault

bool

指定證書是否為默認證書。配置證書的具體操作，請參見配置HTTPS證書以實現加密通信。

• true：指定為默認證書。

• false：不指定為默認證書。

默認值：false。

CertificateId

string

證書的CertIdentifier。

默認值：""。

字段

取值類型

說明

XForwardedForClientCertSubjectDNEnabled

bool

是否在經過ALB實例轉發的HTTP報文的請求頭中添加X-Forwarded-Clientcert-subjectdn字段，以保留客戶端證書的所有者信息。

• true：添加字段。

• false：不添加字段。

默認值：false。

XForwardedForProtoEnabled

bool

是否在經過ALB實例轉發的HTTP報文的請求頭中添加X-Forwarded-Proto字段，以記錄ALB實例所使用的監聽協議。

• true：添加字段。

• false：不添加字段。

默認值：false。

XForwardedForClientCertIssuerDNEnabled

bool

是否在經過ALB實例轉發的HTTP報文的請求頭中添加X-Forwarded-Clientcert-issuerdn字段，以保留客戶端證書的發行者信息。

• true：添加字段。

• false：不添加字段。

默認值：false。

XForwardedForSLBIdEnabled

bool

是否在經過ALB實例轉發的HTTP報文的請求頭中添加X-Forwarded-For-SLB-ID字段，以記錄ALB實例的ID。

• true：添加字段。

• false：不添加字段。

默認值：false。

XForwardedForClientSrcPortEnabled

bool

是否在經過ALB實例轉發的HTTP報文的請求頭中添加X-Forwarded-Client-Port字段，以保留客戶端的端口信息。

• true：添加字段。

• false：不添加字段。

默認值：false。

XForwardedForClientCertFingerprintEnabled

bool

是否在經過ALB實例轉發的HTTP報文的請求頭中添加X-Forwarded-Clientcert-fingerprint字段，以保留客戶端證書的指紋取值信息。

• true：添加字段。

• false：不添加字段。

默認值：false。

XForwardedForEnabled

bool

是否在經過ALB實例轉發的HTTP報文的請求頭中添加X-Forwarded-For字段，以保留客戶端真實IP信息。該功能暫不支持關閉。

XForwardedForSLBPortEnabled

bool

是否在經過ALB實例轉發的HTTP報文的請求頭中添加X-Forwarded-Port字段，以記錄ALB實例的監聽端口。

• true：添加字段。

• false：不添加字段。

默認值：false。

XForwardedForClientCertClientVerifyEnabled

bool

是否在經過ALB實例轉發的HTTP報文的請求頭中添加X-Forwarded-Clientcert-clientverify字段，以保留客戶端證書的校驗結果。

• true：添加字段。

• false：不添加字段。

默認值：false。

XForwardedForClientCertSubjectDNAlias

string

自定義字段名稱。填入值后，會將XForwardedForClientCertSubjectDNEnabled添加的X-Forwarded-Clientcert-subjectdn字段名稱替換為填入的值。

僅當XForwardedForClientCertSubjectDNEnabled的值為true時，該字段才會生效。

默認值：""。

XForwardedForClientCertClientVerifyAlias

string

自定義字段名稱。填入值后，會將XForwardedForClientCertClientVerifyEnabled添加的X-Forwarded-Clientcert-clientverify字段名稱替換為填入的值。

僅當XForwardedForClientCertClientVerifyEnabled的值為true的時候，該字段才會生效。

默認值：""。

XForwardedForClientCertIssuerDNAlias

string

自定義字段名稱。填入值后，會將XForwardedForClientCertIssuerDNEnabled添加的X-Forwarded-Clientcert-issuerdn字段名稱替換為填入的值。

僅當XForwardedForClientCertIssuerDNEnabled的值為true的時候，此字段才會生效。

默認值：""。

XForwardedForClientCertFingerprintAlias

string

自定義字段名稱。填入值后，會將XForwardedForClientCertFingerprintEnabled添加的X-Forwarded-Clientcert-fingerprint字段名稱替換為填入的值。

僅當XForwardedForClientCertFingerprintEnabled的值為true時，該字段才會生效。

默認值：""。

XForwardedForClientSourceIpsEnabled

bool

是否允許ALB從X-Forwarded-For頭字段中查找真實客戶端 IP。

• true：允許。此時必須配置XForwardedForClientSourceIpsTrusted并寫入格式正確的內容。

• false：不允許。

默認值：false。

XForwardedForClientSourceIpsTrusted

string

指定可信的代理IP。

請輸入正確格式的IP或網段，并以英文半角分號;分隔，IP或網段之間無需添加空格。僅在XForwardedForClientSourceIpsEnabled為true時生效。

• 可信IP列表設置為0.0.0.0/0：獲取X-Forwarded-For請求標頭中最左邊的地址，即真實客戶端源IP。

• 可信IP列表設置為proxy1 IP; proxy2 IP,..：從右往左獲取第一個不在列表中的值，并將其作為真實客戶端源IP。

示例值：192.168.x.x;192.168.x.x/16

字段

取值類型

說明

aclName

string

AclEntry模式下關聯的ACL策略名。配置ACL的具體操作，請參見配置ACL實現訪問控制。

默認值：""。

aclType

enum

訪問控制的模式。

• Black：黑名單模式，阻止特定IP訪問服務。

• White：白名單模式，只允許特定IP訪問服務。

aclEntries

string[]

訪問策略條目。

默認值：""。

aclIds

string[]

關聯已經存在的策略ID列表。

默認值：""。

字段

取值類型

說明

accessLogRecordCustomizedHeadersEnabled

bool

是否在ALB實例的訪問日志中使用自定義Header。

• true：使用自定義Header。

• false：不使用自定義Header。

默認值：false。

accessLogTracingConfig

AccessLogTracingConfig

鏈路追蹤相關配置參數。鏈路追蹤的具體操作，請參見通過Albconfig開啟Xtrace實現鏈路追蹤。

字段

取值類型

說明

tracingEnabled

bool

是否啟用鏈路追蹤功能。

• true：開啟鏈路追蹤。

• false：不開啟鏈路追蹤。

默認值：false。

tracingSample

int

鏈路追蹤采樣率，單位為0.01%。

取值范圍：[1, 10000]。

tracingType

enum

鏈路追蹤的采樣算法。

• Zipkin：使用Zipkin算法。

字段

輸出內容

說明

loadBalancer

LoadBalancerStatus

保留字段，請勿修改。

ALB實例的狀態。

字段

輸出內容

說明

dnsname

string

保留字段，請勿修改。

ALB實例的DNS地址。

id

string

保留字段，請勿修改。

ALB實例的ID。

listeners

ListenerStatus

保留字段，請勿修改。

ALB實例的監聽屬性。

字段

輸出內容

說明

portAndProtocol

string

保留字段，請勿修改。

監聽使用的端口與協議。

certificates

AppliedCertificate

保留字段，請勿修改。

監聽關聯的證書。

字段

輸出內容

說明

certificateId

string

保留字段，請勿修改。

證書的CertIdentifier。

isDefault

bool

保留字段，請勿修改。

證書是否為默認證書。