全部產品
Search
文件中心

Server Load Balancer:SetLoadBalancerHTTPSListenerAttribute

更新時間:Sep 08, 2026

修改HTTPS監聽的配置。

介面說明

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

slb:SetLoadBalancerHTTPSListenerAttribute

update

acl

acs:slb:{#regionId}:{#accountId}:acl/{#aclId}

*certificate

acs:slb:{#regionId}:{#accountId}:certificate/{#certificateId}

*loadbalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

  • slb:tag
  • slb:tag
  • slb:tag
無

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

否

傳統型負載平衡執行個體的地域 ID。

您可以呼叫 DescribeRegions 介面查詢地域 ID。

cn-hangzhou

LoadBalancerId

string

是

傳統型負載平衡執行個體的 ID。

lb-sjhfdji****

ListenerPort

integer

是

傳統型負載平衡執行個體前端使用的連接埠。

取值:1~65535。

80

Bandwidth

integer

否

監聽的頻寬峰值。單位:Mbps。

取值:

  • -1:不限制頻寬峰值。

-1

XForwardedFor

string

否

是否開啟透過X-Forwarded-For標頭欄位取得存取者真實 IP。取值:

  • on:是。

  • off:否。

on

Scheduler

string

否

排程演算法。取值:

  • wrr:權重值越高的後端伺服器,被輪詢到的機率也越高。

  • rr:按照存取順序依次將外部請求依序分發到後端伺服器。

wrr

StickySession

string

否

是否開啟工作階段保持。取值:

  • on:是。

  • off:否。

on

StickySessionType

string

否

Cookie 的處理方式。取值:

  • insert:植入 Cookie。

用戶端第一次存取時,負載平衡會在回應中植入 Cookie(即在 HTTP/HTTPS 回應報文中插入 SERVERID),下次用戶端攜帶此 Cookie 存取,負載平衡服務會將請求定向轉發給之前記錄到的後端伺服器上。

  • server:重寫 Cookie。

負載平衡發現使用者自訂了 Cookie,將會對原來的 Cookie 進行重寫,下次用戶端攜帶新的 Cookie 存取,負載平衡服務會將請求定向轉發給之前記錄到的後端伺服器。

說明

當 StickySession 的值為 on 時,必須指定該參數。

insert

CookieTimeout

integer

否

Cookie 逾時時間。

取值:1~86400(秒)。

說明

當 StickySession 為 on 且 StickySessionType 為 insert 時,該參數為必填。

500

Cookie

string

否

伺服器上設定的 Cookie。

長度為 1~200 個字元,只能包含 ASCII 英文字母和數字字元,不能包含半形逗號(,)、半形分號(;)或空白,不能以$開頭。

說明

當 StickySession 為 on 且 StickySessionType 為 server 時,該參數為必填。

testCookie

HealthCheck

string

否

是否開啟健康檢查。取值:

  • on:是。

  • off:否。

on

HealthCheckMethod

string

否

監聽 HTTP 類型健康檢查的健康檢查方法。取值:head 或 get。

說明

HealthCheck 值為 on 時才會有效。

get

HealthCheckDomain

string

否

用於健康檢查的網域,取值:

  • $_ip: 後端伺服器的私有 IP。當指定了 IP 或該參數未指定時,負載平衡會使用各後端伺服器的私有 IP 當作健康檢查使用的網域。

  • domain:網域長度為 1~80 字元,只能包含字母、數字、半形句號(.)和短橫線(-)。

說明

在 HealthCheck 值為 on 時才會有效。

172.XX.XX.16

HealthCheckURI

string

否

用於健康檢查的 URI。

長度限制為 1~80 字元,支援英文字母、數字、短橫線(-)、正斜線(/)、半形句號(.)、百分號(%)、半形問號(?)、井號(#)和(&)字元。URI 不能只包含正斜線(/),但必須以正斜線(/)開頭。

說明

在 HealthCheck 值為 on 時才會有效。

/test/index.html

HealthyThreshold

integer

否

健康檢查連續成功多少次後,將後端伺服器的健康檢查狀態由 fail 判定為 success。

取值:2~10。

說明

在 HealthCheck 值為 on 時才會有效。

4

UnhealthyThreshold

integer

否

健康檢查連續失敗多少次後,將後端伺服器的健康檢查狀態由 success 判定為 fail。

取值:2~10。

說明

在 HealthCheck 值為 on 時才會有效。

4

HealthCheckTimeout

integer

否

接收來自健康檢查的回應需要等待的時間。如果後端 ECS 在指定的時間內沒有正確回應,則判定為健康檢查失敗。單位:秒。取值:1~300。

說明

在 HealthCheck 值為 on 時才會有效。

3

HealthCheckInterval

integer

否

健康檢查的時間間隔。單位:秒。

取值:1~50。

說明

在 HealthCheck 值為 on 時才會有效。

5

HealthCheckConnectPort

integer

否

健康檢查使用的連接埠。

取值:1~65535。

說明

當 HealthCheck 值為 on 時才會有效。

8080

HealthCheckHttpCode

string

否

健康檢查正常的 HTTP 狀態碼,多個狀態碼用半形逗號(,)分隔。

取值:http_2xx或http_3xx或http_4xx或http_5xx。

說明

在 HealthCheck 值為 on 時才會有效。

http_2xx,http_3xx

ServerCertificateId

string

否

伺服器憑證的 ID。

idkp-123-cn-te****

CACertificateId

string

否

CA 憑證 ID。

  • 若既上傳 CA 憑證又上傳伺服器憑證,即採用雙向認證。

  • 若使用者只上傳伺服器憑證,即為單向認證。

139a00604ad-cn-east-****

VServerGroup

string

否

是否使用伺服器群組。取值:

  • on:是。

  • off:否。

on

VServerGroupId

string

否

虛擬伺服器群組 ID。

rsp-cige6j****

XForwardedFor_SLBIP

string

否

是否透過SLB-IP標頭欄位取得用戶端請求的 VIP(Virtual IP address)。取值:

  • on:是。

  • off:否。

on

XForwardedFor_SLBID

string

否

是否透過SLB-ID標頭欄位取得負載平衡執行個體 ID。取值:

  • on:是。

  • off:否。

on

XForwardedFor_proto

string

否

是否透過X-Forwarded-Proto標頭欄位取得負載平衡執行個體的監聽通訊協定。取值:

  • on:是。

  • off:否。

on

Gzip

string

否

是否開啟Gzip壓縮,對特定檔案類型進行壓縮。取值:

  • on:是。

  • off:否。

on

AclId

string

否

監聽綁定的存取策略群組 ID。

當 AclStatus 參數的值為 on 時,該參數為必填。

acl-a2do9e413e0spzasx****

AclType

string

否

存取控制類型:

  • white: 僅轉發來自所選存取控制策略群組中設定的 IP 位址或位址段的請求,白名單適用於只允許特定 IP 存取的場景。設定白名單存在一定業務風險。一旦設定白名單,就只有白名單中的 IP 可以存取負載平衡監聽。

如果開啟了白名單存取,但存取策略群組中沒有新增任何 IP,則負載平衡監聽會轉發全部請求。

  • black: 來自所選存取控制策略群組中設定的 IP 位址或位址段的所有請求都不會轉發,黑名單適用於只限制某些特定 IP 存取的場景。

如果開啟了黑名單存取,但存取策略群組中沒有新增任何 IP,則負載平衡監聽會轉發全部請求。

說明

當 AclStatus 參數的值為 on 時,該參數有效。

white

AclStatus

string

否

是否開啟存取控制功能。取值:

  • on:是。

  • off:否。

off

IdleTimeout

integer

否

指定連線空閒逾時時間,取值範圍為1~60秒,預設值為 15 秒。

在逾時時間內一直沒有存取請求,負載平衡會暫時中斷目前連線,直到下一次請求來臨時重新建立新的連線。

23

RequestTimeout

integer

否

指定請求逾時時間,取值範圍為1~180秒,預設值為 60 秒。

在逾時時間內後端伺服器一直沒有回應,負載平衡將放棄等待,給用戶端回傳 HTTP 504 錯誤碼。

223

EnableHttp2

string

否

是否開啟HTTP 2.0特性。取值:

  • on:是。

  • off:否。

off

TLSCipherPolicy

string

否

安全性策略包含 HTTPS 可選的 TLS 通訊協定版本和配套的加密演算法套件。

  • tls_cipher_policy_1_0:

    支援 TLS 版本: TLSv1.0、TLSv1.1 和 TLSv1.2。

    支援加密演算法套件:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA 和 DES-CBC3-SHA。

  • tls_cipher_policy_1_1:

    支援 TLS 版本: TLSv1.1 和 TLSv1.2。

    支援加密演算法套件:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA 和 DES-CBC3-SHA。

  • tls_cipher_policy_1_2

    支援 TLS 版本:TLSv1.2。

    支援加密演算法套件:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA 和 DES-CBC3-SHA。

  • tls_cipher_policy_1_2_strict

    支援 TLS 版本:TLSv1.2。

    支援加密演算法套件:ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-RSA-AES128-SHA 和 ECDHE-RSA-AES256-SHA。

  • tls_cipher_policy_1_2_strict_with_1_3

    支援 TLS 版本:TLSv1.2 及 TLSv1.3。

    支援的加密演算法套件:TLS_AES_128_GCM_SHA256、TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_CCM_SHA256、TLS_AES_128_CCM_8_SHA256、ECDHE-ECDSA-AES128-GCM-SHA256、ECDHE-ECDSA-AES256-GCM-SHA384、ECDHE-ECDSA-AES128-SHA256、ECDHE-ECDSA-AES256-SHA384、ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-ECDSA-AES128-SHA、ECDHE-ECDSA-AES256-SHA、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA。

tls_cipher_policy_1_2

Description

string

否

自訂監聽名稱。

長度限制為 1~256 個字元,支援中文、字母、數字、短橫線(-)、正斜線(/)、半形句號(.)和底線(_)。

https_80

XForwardedFor_SLBPORT

string

否

是否透過XForwardedFor_SLBPORT標頭欄位取得負載平衡執行個體的監聽連接埠。取值:

  • on:是。

  • off:否。

off

XForwardedFor_ClientSrcPort

string

否

是否透過XForwardedFor_ClientSrcPort標頭欄位取得存取負載平衡執行個體用戶端的連接埠。取值:

  • on:是。

  • off:否。

off

DryRun

boolean

否

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

樣本

正常返回樣本

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 ParamDuplicateError The specified parameter value of XForwardedFor_ClientCertSubjectDNAlias is duplicate. Please change to a different one. 參數XForwardedFor_ClientCertClientVerifyAlias重複。
400 IpVersionConflict The ip version of this LoadBalancer and the Acl is conflict. 指定負載平衡的 IP 版本與 ACL 支援的 IP 類型衝突。
400 InvalidParameter.IdleTimeout The specified IdleTimeout exceeds the limit. 指定的IdleTimeout無效。請檢查參數約束,並在修改後重試。
400 InvalidParameter.RequestTimeout The specified RequestTimeout exceeds the limit. 指定的RequestTimeout無效。請檢查參數約束,並在修改後重試。
400 ListenerForwardNotSupport X-Forward-For is not supported to a ipv6 instance. IPv6 負載平衡執行個體不支援 X-Forward-For。
400 InvalidParameter.RegionNotSupport The region does not support the parameter: %s. 目前區域不支援指定參數。
400 InvalidParameter.SpecNotSupport The loadBalancer of shared spec does not support the parameter: %s. 共享型負載平衡執行個體不支援目前參數。
400 OperationFailed.ServerGroupInUse The VServerGroup or MasterSlaveServerGroup can not be close for this listener. 操作失敗,原因是當前監聽不支援關閉伺服器群組。
400 InvalidParameter.VServerGroupId The MasterSlaveServerGroup can not be attached to HTTP or HTTPS listener. HTTP或HTTPS監聽不支援掛載主備伺服器群組。
400 MissingParam.HealthCheckDomain The HealthCheckDomain is required when HealthCheckHttpVersion is http1.1. 缺少參數 HealthCheckDomain。
400 InvalidParameter.HealthCheckHttpVersion The param HealthCheckHttpVersion is invalid. 指定的HealthCheckHttpVersion無效。請檢查參數約束,並在修改後重試。
400 Duplicated.AclEntry %s. %s
400 CertificateNotExist The specified CertificateId does not exist. 指定的憑證不存在。
400 InvalidTLSPolicyId.NotExist The specified TLS cipher policy does not exist. 指定的TLS策略不存在。
400 TLSPolicyConfiguring The specified TLS cipher policy is configuring. 指定的TLSCipherPolicy正在變更設定中。
400 TLSCipherPolicyVipRelationOverLimit The number of listeners associated with a policy has exceeded. 監聽關聯的TLSCipherPolicy數量已達到配額上限。
400 TooManyCertificates The number of certificates must not be greater than one. 憑證數量不得大於1個。
400 CertificateTypeMismatched The certificate type does not match. 指定憑證的類型不匹配。
400 MissingParam.ServerCertificates Server certificates are required. 缺少參數 ServerCertificates。
400 CnCertificateNotSupport The cn certificate is not support. 不支援國密憑證。
400 InvalidParam.CertificateBindingType The param CertificateBindingType is invalid. 指定的 CertificateBindingType 無效。請檢查參數約束,並在修改後重試。
400 InvalidParamSize.ServerCertificates The size of param ServerCertificates is invalid. 指定的ServerCertificates長度無效。請檢查參數約束,並在修改後重試。
400 TooManyCertificates.ServerCertificates The number of certificates must not be greater than one. 憑證數量不得大於1個。
400 AclListenerOverLimit This acl has reached the limit of binding to listeners. 指定的ACL可關聯監聽數量已達到配額上限。
400 QuotaLimitExceeds.AclAttachedToListener The number of Acl bound listeners has reached the quota limit Acl綁定監聽數已達到配額上限。
400 QuotaLimitExceeds.TotalAclEntry The number of Acl entries has reached the quota limit. Acl條目數已達到配額上限。
400 QuotaLimitExceeds.AclListenerOverLimit This acl has reached the limit of binding to listeners. 指定的ACL可關聯監聽數量已達到配額上限。
400 DryRunOperation Request validation has been passed with DryRun flag set. dryRun請求驗證已通過。
404 ResourceNotFound.Certificate The specified resource is not found.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情。