更新監聽的配置，如名稱、默認動作等。
接口說明
UpdateListenerAttribute 接口屬于異步接口，即系統返回一個請求 ID，但該監聽的配置尚未更新成功，系統后臺的更新任務仍在進行。您可以調用 GetListenerAttribute 查詢監聽的配置的更新狀態：
- 當監聽器處于 Configuring 狀態時，表示監聽的配置正在更新中。
- 當監聽器處于 Running 狀態時，表示監聽的配置更新成功。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| alb:UpdateListenerAttribute | update | *LoadBalancer acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}*SecurityPolicy acs:alb:{#regionId}:{#accountId}:securitypolicy/{#securitypolicyId}*ServerGroup acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ListenerId | string | 是 | 應用型負載均衡實例監聽 ID。 | lsn-o4u54y73wq7b****** |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 5A2CFF0E-5718-45B5-9D4D-70B****** |
| DryRun | boolean | 否 | 是否只預檢此次請求。取值：
| false |
| ListenerDescription | string | 否 | 自定義監聽名稱。 長度為 2~256 個字符，可包含英文字母、數字、中文、半角逗號（,）、半角句號（.）、半角分號（;）、正斜線（/）、at（@）、下劃線（_）和短劃線（-）。 | HTTP_80 |
| RequestTimeout | integer | 否 | 指定請求超時時間。單位：秒。取值范圍：1~180。 如果在超時時間內后端服務器一直沒有響應，負載均衡將放棄等待，給客戶端返回 | 3 |
| IdleTimeout | integer | 否 | 指定連接空閑超時時間。單位：秒。取值范圍：1~60。 如果在超時時間內一直沒有訪問請求，負載均衡會暫時中斷當前連接，直到一下次請求來臨時重新建立新的連接。 | 15 |
| GzipEnabled | boolean | 否 | 是否開啟 Gzip 壓縮，對特定文件類型進行壓縮。取值：
| true |
| Http2Enabled | boolean | 否 | 是否開啟 HTTP/2 特性。取值：
說明
僅 HTTPS 監聽支持此參數。
| true |
| SecurityPolicyId | string | 否 | 安全策略，支持系統安全策略和自定義安全策略。 說明
僅 HTTPS 監聽支持此參數。
| tls_cipher_policy_1_0 |
| CaEnabled | boolean | 否 | 是否開啟雙向認證。取值：
| false |
| XForwardedForConfig | object | 否 | XForwardedFor 相關屬性配置。 | |
| XForwardedForClientCertClientVerifyAlias | string | 否 | 自定義頭字段名稱，只有當 XForwardedForClientCertClientVerifyEnabled 的值為 true 時，此值才會生效。 取值限制：長度 1~40 個字符。支持字母 a~z、短劃線（-）、下劃線（_）和數字。 說明
僅 HTTPS 監聽支持此參數。
| test_client-verify-alias_123456 |
| XForwardedForClientCertClientVerifyEnabled | boolean | 否 | 是否通過
說明
僅 HTTPS 監聽支持此參數。
| false |
| XForwardedForClientCertFingerprintAlias | string | 否 | 自定義頭字段名稱，只有當 XForwardedForClientCertFingerprintEnabled 的值為 true 時生效。 取值限制：長度為 1~40 個字符。支持字母 a~z、短劃線（-）、下劃線（_）和數字。 說明
僅 HTTPS 監聽支持此參數。
| test_finger-print-alias_123456 |
| XForwardedForClientCertFingerprintEnabled | boolean | 否 | 是否通過
說明
僅 HTTPS 監聽支持此參數。
| false |
| XForwardedForClientCertIssuerDNAlias | string | 否 | 自定義頭字段名稱，只有當 XForwardedForClientCertIssuerDNEnabled 的值為 true 時才生效。 取值限制：長度為 1~40 個字符。支持字母 a~z、短劃線（-）、下劃線（_）和數字。 說明
僅 HTTPS 監聽支持此參數。
| test_issue-dn-alias_123456 |
| XForwardedForClientCertIssuerDNEnabled | boolean | 否 | 是否通過
說明
僅 HTTPS 監聽支持此參數。
| false |
| XForwardedForClientCertSubjectDNAlias | string | 否 | 自定義頭字段名稱，只有當 XForwardedForClientCertSubjectDNEnabled 的值為 true 時才生效。 取值限制：長度為 1~40 字符。支持字母 a~z、短劃線（-）、下劃線（_）和數字。 說明
僅 HTTPS 監聽支持此參數。
| test_subject-dn-alias_123456 |
| XForwardedForClientCertSubjectDNEnabled | boolean | 否 | 是否通過
說明
僅 HTTPS 監聽支持此參數。
| false |
| XForwardedForClientSrcPortEnabled | boolean | 否 | 是否通過
說明
HTTP 和 HTTPS 監聽支持此參數。
| false |
| XForwardedForEnabled | boolean | 否 | 是否通過
說明
X-Forwarded-For頭字段，不做額外處理。 | true |
| XForwardedForProcessingMode | string | 否 | 處理
說明
X-Forwarded-For頭字段。X-Forwarded-For標頭，無論請求是否攜帶X-Forwarded-For頭字段。 | append |
| XForwardedForProtoEnabled | boolean | 否 | 是否通過
說明
HTTP、HTTPS 和 QUIC 監聽支持此參數。
| false |
| XForwardedForSLBIdEnabled | boolean | 否 | 是否通過
說明
HTTP、HTTPS 和 QUIC 監聽支持此參數。
| false |
| XForwardedForSLBPortEnabled | boolean | 否 | 是否通過
說明
HTTP、HTTPS 和 QUIC 監聽支持此參數。
| false |
| XForwardedForClientSourceIpsEnabled | boolean | 否 | 是否允許 ALB 從 X-Forwarded-For 頭字段中查找真實客戶端 IP。取值：
說明
HTTP、HTTPS 監聽支持此參數。
| false |
| XForwardedForClientSourceIpsTrusted | string | 否 | 指定可信的代理 IP。 應用型負載均衡 ALB 會從后往前遍歷 | 10.1.1.0/24 |
| XForwardedForHostEnabled | boolean | 否 | 是否開啟通過
說明
HTTP、HTTPS 和 QUIC 監聽支持此參數。
| false |
| QuicConfig | object | 否 | 啟用關聯 QUIC 監聽時的配置信息。 | |
| QuicListenerId | string | 否 | 需要關聯的 QUIC 監聽 ID。QuicUpgradeEnabled 值為 true 時必選。HTTPS 監聽時有效。 說明
原始監聽和關聯的 QUIC 監聽必須屬于同一個 ALB 實例，并且此 QUIC 監聽之前沒有被關聯過。
| lsn-333 |
| QuicUpgradeEnabled | boolean | 否 | 是否開啟 QUIC 升級。取值：
說明
僅 HTTPS 監聽時有效。
| false |
| Certificates | array<object> | 否 | 證書列表。最多支持添加 20 個證書。 說明
當前僅支持服務器證書。
| |
| object | 否 | 證書結構。 | ||
| CertificateId | string | 否 | 證書 ID。 | 123157****** |
| CaCertificates | array<object> | 否 | CA 證書列表。目前僅支持添加 1 個 CA 證書。 | |
| object | 否 | CA 證書結構。 | ||
| CertificateId | string | 否 | CA 證書 ID。 說明
當 CaEnabled 參數取值為 true 的時候，此參數為必填。
| 123359****** |
| DefaultActions | array<object> | 否 | 默認規則動作列表。 | |
| object | 否 | 默認規則動作結構。 | ||
| ForwardGroupConfig | object | 否 | 轉發動作對應的配置，Type 類型為 ForwardGroup 時必填且有效。最多支持添加 20 個轉發動作對應的配置。 | |
| ServerGroupTuples | array<object> | 是 | 轉發目標服務器元組列表。 | |
| object | 否 | 轉發目標服務器元組結構。 | ||
| ServerGroupId | string | 是 | 轉發到的目的服務器組 ID。 | sgp-i5qt20****** |
| Type | string | 是 | 動作類型。最多支持添加 1 個動作類型。 取值：ForwardGroup，表示轉發至多個服務器組。 | ForwardGroup |
返回參數
示例
正常返回示例
JSON格式
{
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"RequestId": "365F4154-92F6-4AE4-92F8-7FF******"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | IncorrectStatus.LoadBalancer | The status of %s [%s] is incorrect. | 實例的當前狀態不支持本次操作。 |
| 400 | IncorrectBusinessStatus.LoadBalancer | The business status of %s [%s] is incorrect. | 資源%s [%s]的業務狀態無效。 |
| 400 | IncorrectStatus.Listener | The status of %s [%s] is incorrect. | 監聽的當前狀態不支持本次操作。 |
| 400 | OperationDenied.CrossLoadBalancerQUICListener | The operation is not allowed because of %s. | 操作被拒絕，原因是%s。 |
| 400 | ResourceAlreadyAssociated.Listener | The specified resource %s is already associated. | 資源%s已被關聯。 |
| 400 | OperationDenied.GRPCServerGroup | The operation is not allowed because of %s. | 操作被拒絕，原因是存在綁定本GRPC服務器組的監聽沒有啟用HTTP2.0。 |
| 400 | ResourceAlreadyAssociated.Certificate | The specified resource %s is already associated. | 證書已被關聯。 |
| 400 | ResourceQuotaExceeded.SecurityPolicyAttachedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 配額%s已超額度限制，資源是%s，目前已使用%s，配額為%s。 |
| 400 | ResourceQuotaExceeded.ServerGroupAttachedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 服務器組可被關聯數已超額度限制。 |
| 400 | ResourceQuotaExceeded.LoadBalancerServersNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 后端服務器數已超額度限制。 |
| 400 | ResourceQuotaExceeded.ServerAddedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 服務器添加到組已超額度限制。 |
| 400 | OperationDenied.ServerGroupProtocolNotSupport | The operation is not allowed because of ServerGroupProtocolNotSupport. | 操作被拒絕，原因是ServerGroupProtocolNotSupport。 |
| 400 | UnsupportedFeature.FullTraceHttps | The feature of FullTraceHttps is not supported for current instance. | 當前實例版本不支持全鏈路HTTPS特性。 |
| 400 | ResourceInConfiguring.Listener | The specified resource of %s is being configured, please try again later. | 指定的資源%s正在配置中，請稍后再試。 |
| 400 | Mismatch.VpcId | The %s is mismatched for %s and %s. | %s在%s和%s中不匹配。 |
| 400 | InvalidParameter | Invalid parameter, please check the parameter input. | 無效參數，請檢查參數輸入。 |
| 403 | Forbidden.LoadBalancer | Authentication is failed for %s. | 負載均衡操作鑒權失敗。 |
| 404 | ResourceNotFound.Listener | The specified resource %s is not found. | 監聽不存在。 |
| 404 | ResourceNotFound.ServerGroup | The specified resource %s is not found. | 后端服務器組不存在。 |
| 404 | ResourceNotFound.SecurityPolicy | The specified resource %s is not found. | 資源%s不存在。 |
| 404 | ResourceNotFound.Certificate | The specified resource %s is not found. | 資源%s不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-12-20 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-01-29 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-01-24 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-11-06 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |