創(chuàng)建監(jiān)聽。
接口說明
CreateListener 接口屬于異步接口,即系統(tǒng)返回一個請求 ID,但該 HTTP、HTTPS 或 QUIC 監(jiān)聽尚未創(chuàng)建成功,系統(tǒng)后臺的創(chuàng)建任務(wù)仍在進行。您可以調(diào)用 GetListenerAttribute 查詢 HTTP、HTTPS 或 QUIC 監(jiān)聽的創(chuàng)建狀態(tài):
- 當(dāng) HTTP、HTTPS 或 QUIC 監(jiān)聽處于 Provisioning 狀態(tài)時,表示 HTTP、HTTPS 或 QUIC 監(jiān)聽正在創(chuàng)建中。
- 當(dāng) HTTP、HTTPS 或 QUIC 監(jiān)聽處于 Running 狀態(tài)時,表示 HTTP、HTTPS 或 QUIC 監(jiān)聽創(chuàng)建成功。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
alb:CreateListener | create | *LoadBalancer acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId} *SecurityPolicy acs:alb:{#regionId}:{#accountId}:securitypolicy/{#securitypolicyId} *ServerGroup acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId} |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
LoadBalancerId | string | 是 | 應(yīng)用型負(fù)載均衡實例 ID。 | alb-n5qw04uq8vavfe**** |
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數(shù)值,確保不同請求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統(tǒng)自動使用 API 請求的 RequestId 作為 ClientToken 標(biāo)識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-426655440000 |
DryRun | boolean | 否 | 是否只預(yù)檢此次請求,取值:
| false |
ListenerProtocol | string | 是 | 監(jiān)聽協(xié)議。 取值:HTTP、HTTPS 或 QUIC。 | HTTP |
ListenerPort | integer | 是 | 負(fù)載均衡實例前端使用的端口。 取值:1~65535。 | 80 |
ListenerDescription | string | 否 | 自定義監(jiān)聽名稱。 長度為 2~256 個字符,必須是中文和無害字符串中的字符,可包含中文、字母、數(shù)字、短劃線(-)、正斜線(/)、半角句號(.)、下劃線(_)。 | HTTP_80 |
RequestTimeout | integer | 否 | 指定請求超時時間。單位:秒。 取值:1~180。 默認(rèn)值:60。 如果在超時時間內(nèi)后端服務(wù)器一直沒有響應(yīng),負(fù)載均衡將放棄等待,并給客戶端返回 | 60 |
IdleTimeout | integer | 否 | 指定連接空閑超時時間。單位:秒。 取值范圍:1~60。 默認(rèn)值:15。 如果在超時時間內(nèi)一直沒有訪問請求,負(fù)載均衡會暫時中斷當(dāng)前連接,直到一下次請求來臨時重新建立新的連接。 | 3 |
GzipEnabled | boolean | 否 | 是否開啟
| true |
Http2Enabled | boolean | 否 | 是否開啟
說明
僅 HTTPS 監(jiān)聽支持此參數(shù)。
| true |
SecurityPolicyId | string | 否 | 安全策略 ID。支持系統(tǒng)安全策略和自定義安全策略。 默認(rèn)值:tls_cipher_policy_1_0(系統(tǒng)安全策略)。 說明
僅 HTTPS 監(jiān)聽支持此參數(shù)。
| tls_cipher_policy_1_0 |
CaEnabled | boolean | 否 | 是否開啟雙向認(rèn)證。取值:
| false |
XForwardedForConfig | object | 否 | XForward 字段配置信息。 | |
XForwardedForClientCertClientVerifyAlias | string | 否 | 自定義頭名稱,只有當(dāng) XForwardedForClientCertClientVerifyEnabled 的值為 true 的時候,該值才會生效;否則該值不會生效。 取值:1~40 個字符。支持字母 a~z、短劃線(-)、下劃線(_)和數(shù)字。 說明
僅 HTTPS 監(jiān)聽支持此參數(shù)。
| test_client-verify-alias_123456 |
XForwardedForClientCertClientVerifyEnabled | boolean | 否 | 是否通過
說明
僅 HTTPS 監(jiān)聽支持此參數(shù)。
| true |
XForwardedForClientCertFingerprintAlias | string | 否 | 自定義頭名稱,只有當(dāng) XForwardedForClientCertFingerprintEnabled 的值為 true 時生效。 取值:1~40 個字符。支持字母 a~z、短劃線(-)、下劃線(_)和數(shù)字。 說明
僅 HTTPS 監(jiān)聽支持此參數(shù)。
| test_finger-print-alias_123456 |
XForwardedForClientCertFingerprintEnabled | boolean | 否 | 是否通過
說明
僅 HTTPS 監(jiān)聽支持此參數(shù)。
| true |
XForwardedForClientCertIssuerDNAlias | string | 否 | 自定義頭名稱,只有當(dāng) XForwardedForClientCertIssuerDNEnabled 的值為 true 的時候,此值才會生效。 取值:1~40 個字符。支持字母 a~z、短劃線(-)、下劃線(_)和數(shù)字。 說明
僅 HTTPS 監(jiān)聽支持此參數(shù)。
| test_issue-dn-alias_123456 |
XForwardedForClientCertIssuerDNEnabled | boolean | 否 | 是否通過
說明
僅 HTTPS 監(jiān)聽支持此參數(shù)。
| true |
XForwardedForClientCertSubjectDNAlias | string | 否 | 自定義頭名稱,只有當(dāng) XForwardedForClientCertSubjectDNEnabled 的值為 true 時,此值才會生效。 取值:1~40 個字符。支持字母 a~z、短劃線(-)、下劃線(_)和數(shù)字。 說明
僅 HTTPS 監(jiān)聽支持此參數(shù)。
| test_subject-dn-alias_123456 |
XForwardedForClientCertSubjectDNEnabled | boolean | 否 | 是否通過
說明
僅 HTTPS 監(jiān)聽支持此參數(shù)。
| true |
XForwardedForClientSrcPortEnabled | boolean | 否 | 是否通過
說明
HTTP 和 HTTPS 監(jiān)聽支持此參數(shù)。
| true |
XForwardedForEnabled | boolean | 否 | 是否通過
說明
X-Forwarded-For 頭字段,不做額外處理。 | true |
XForwardedForProcessingMode | string | 否 | 處理
說明
X-Forwarded-For 頭字段。X-Forwarded-For 標(biāo)頭,無論請求是否攜帶X-Forwarded-For 頭字段。 | append |
XForwardedForProtoEnabled | boolean | 否 | 是否通過
說明
HTTP、HTTPS 和 QUIC 監(jiān)聽支持此參數(shù)。
| false |
XForwardedForSLBIdEnabled | boolean | 否 | 是否通過
說明
HTTP、HTTPS 和 QUIC 監(jiān)聽支持此參數(shù)。
| false |
XForwardedForSLBPortEnabled | boolean | 否 | 是否通過
說明
HTTP、HTTPS 和 QUIC 監(jiān)聽支持此參數(shù)。
| false |
XForwardedForClientSourceIpsEnabled | boolean | 否 | 是否允許 ALB 從 X-Forwarded-For 頭字段中查找真實客戶端 IP。取值:
說明
HTTP、HTTPS 監(jiān)聽支持此參數(shù)。
| false |
XForwardedForClientSourceIpsTrusted | string | 否 | 指定可信的代理 IP。 應(yīng)用型負(fù)載均衡 ALB 會從后往前遍歷 | 10.1.1.0/24 |
XForwardedForHostEnabled | boolean | 否 | 是否開啟通過
說明
HTTP、HTTPS 和 QUIC 監(jiān)聽支持此參數(shù)。
| false |
QuicConfig | object | 否 | 配置關(guān)聯(lián)的 QUIC 監(jiān)聽。 | |
QuicListenerId | string | 否 | 需要關(guān)聯(lián)的 QUIC 監(jiān)聽 ID,HTTPS 監(jiān)聽時有效,當(dāng) QuicUpgradeEnabled 為 true 時該參數(shù)必選。 說明
原始監(jiān)聽和關(guān)聯(lián)的 QUIC 監(jiān)聽必須屬于同一個 ALB 實例,并且此 QUIC 監(jiān)聽之前沒有被關(guān)聯(lián)過。
| lsn-o4u54y73wq7b****** |
QuicUpgradeEnabled | boolean | 否 | 是否開啟 QUIC 升級。取值:
說明
僅 HTTPS 監(jiān)聽支持此參數(shù)。
| false |
Certificates | array<object> | 否 | 證書列表信息。 | |
object | 否 | 證書結(jié)構(gòu)體。 | ||
CertificateId | string | 否 | 證書 ID,當(dāng)前僅支持服務(wù)器證書。最多支持添加 20 個證書 ID。 說明
當(dāng) ListenerProtocol 參數(shù)取值為 HTTPS 或 QUIC 的時候,此參數(shù)為必填。
| 103705******* |
CaCertificates | array<object> | 否 | 監(jiān)聽配置的 CA 證書列表。目前僅支持添加 1 個 CA 證書。 | |
object | 否 | 監(jiān)聽配置的 CA 證書結(jié)構(gòu)。 | ||
CertificateId | string | 否 | CA 證書 ID。 說明
當(dāng) CaEnabled 參數(shù)取值為 true 的時候,此參數(shù)為必填。
| 123157******* |
DefaultActions | array<object> | 是 | 規(guī)則動作列表。 | |
object | 是 | 規(guī)則動作列表。 | ||
ForwardGroupConfig | object | 是 | 轉(zhuǎn)發(fā)動作對應(yīng)的配置。最多支持添加 20 個轉(zhuǎn)發(fā)動作對應(yīng)的配置。 | |
ServerGroupTuples | array<object> | 是 | 轉(zhuǎn)發(fā)目標(biāo)服務(wù)器元組。 | |
object | 是 | 轉(zhuǎn)發(fā)目標(biāo)服務(wù)器元組。 | ||
ServerGroupId | string | 是 | 轉(zhuǎn)發(fā)到的目的服務(wù)器組 ID。 | sgp-8ilqs4axp6****** |
Type | string | 是 | 動作類型。最多支持添加 1 個動作類型。 取值:ForwardGroup,表示轉(zhuǎn)發(fā)至多個服務(wù)器組。 | ForwardGroup |
Tag | array<object> | 否 | 標(biāo)簽。 | |
object | 否 | 標(biāo)簽結(jié)構(gòu)。 | ||
Key | string | 否 | 標(biāo)簽鍵。最多支持 128 個字符,不能以 aliyun 或 acs:開頭,不能包含 http://或 https://。 | env |
Value | string | 否 | 標(biāo)簽值。最多支持 128 個字符,不能以 aliyun 或 acs:開頭,不能包含 http://或 https://。 | product |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"ListenerId": "lsn-o4u54y73wq7b******",
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876*******"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ResourceAlreadyExist.Listener | The specified resource %s is already exist. | 同端口監(jiān)聽已存在。 |
400 | IncorrectStatus.LoadBalancer | The status of %s [%s] is incorrect. | 實例的當(dāng)前狀態(tài)不支持本次操作。 |
400 | IncorrectBusinessStatus.LoadBalancer | The business status of %s [%s] is incorrect. | 資源%s [%s]的業(yè)務(wù)狀態(tài)無效。 |
400 | ResourceQuotaExceeded.LoadBalancerListenersNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 配額%s已超額度限制,資源是%s,目前已使用%s,配額為%s。 |
400 | OperationDenied.CrossLoadBalancerQUICListener | The operation is not allowed because of %s. | 操作被拒絕,原因是%s。 |
400 | ResourceAlreadyAssociated.Listener | The specified resource %s is already associated. | 資源%s已被關(guān)聯(lián)。 |
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. | 服務(wù)器組可被關(guān)聯(lián)數(shù)已超額度限制。 |
400 | ResourceQuotaExceeded.LoadBalancerServersNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 后端服務(wù)器數(shù)已超額度限制。 |
400 | ResourceQuotaExceeded.ServerAddedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | 服務(wù)器添加到組已超額度限制。 |
400 | Mismatch.VpcId | The %s is mismatched for %s and %s. | %s在%s和%s中不匹配。 |
400 | OperationDenied.ServerGroupProtocolNotSupport | The operation is not allowed because of ServerGroupProtocolNotSupport. | 操作被拒絕,原因是ServerGroupProtocolNotSupport。 |
400 | OperationDenied.GRPCServerGroup | The operation is not allowed because of %s. | 操作被拒絕,原因是存在綁定本GRPC服務(wù)器組的監(jiān)聽沒有啟用HTTP2.0。 |
400 | Mismatch.LoadBalancerEditionAndConnectionDrain | The %s and %s are mismatched. | 參數(shù)%s和%s不匹配。 |
400 | Mismatch.LoadBalancerEditionAndSlowStartEnable | The %s and %s are mismatched. | 參數(shù)%s和%s不匹配。 |
400 | InvalidParameter | Invalid parameter, please check the parameter input. | 無效參數(shù),請檢查參數(shù)輸入。 |
403 | Forbidden.SecurityPolicy | Authentication has failed for SecurityPolicy. | 對SecurityPolicy鑒權(quán)失敗 |
403 | Forbidden.LoadBalancer | Authentication is failed for %s. | 負(fù)載均衡操作鑒權(quán)失敗。 |
403 | Forbidden.Listener | Authentication is failed for %s. | 監(jiān)聽鑒權(quán)失敗。 |
404 | ResourceNotFound.LoadBalancer | The specified resource %s is not found. | 資源%s不存在。 |
404 | ResourceNotFound.ServerGroup | The specified resource %s is not found. | 后端服務(wù)器組不存在。 |
404 | ResourceNotFound.SecurityPolicy | The specified resource %s is not found. | 資源%s不存在。 |
404 | ResourceNotFound.Listener | The specified resource %s is not found. | 監(jiān)聽不存在。 |
404 | ResourceNotFound.Certificate | The specified resource %s is not found. | 資源%s不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-12-20 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2024-09-03 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2024-01-29 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2024-01-29 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2024-01-18 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-11-06 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |