使用CreateListener API為Global Acceleration執行個體建立監聽-Global Acceleration-阿里雲 - Global Accelerator

建立監聽全球加速執行個體。

介面說明

在呼叫本介面時，請注意以下事項：

CreateListener 介面屬於非同步介面，即系統會先返回一個監聽 ID，但監聽並未建立完成，系統後台的建立任務仍在進行。您可以呼叫 DescribeListener 查詢監聽的狀態：
- 當監聽處於 init 狀態時，表示監聽正在建立中，在該狀態下，您只能執行查詢操作，不能執行其他操作。
- 當監聽處於 active 狀態時，表示監聽建立完成。
CreateListener 介面不支援在同一個全球加速執行個體內並發建立監聽。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ga:CreateListener

create

*Listener

acs:ga:{#regionId}:{#accountId}:listener/*

*Accelerator

acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}

ga:TLSVersion

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	全球加速執行個體所在的地域 ID，僅取值cn-hangzhou。	cn-hangzhou
ClientToken	string	否	用戶端 Token，用於保證請求的冪等性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 都不一樣。	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	是	全球加速執行個體 ID。	ga-bp1odcab8tmno0hdq****
Name	string	否	監聽的名稱。名稱長度為 1~128 個字元，以大小寫字母或中文開頭，可包含數字、半形句號（.）底線（_）和短橫線（-）。	Listener
Description	string	否	監聽的描述資訊。描述長度最大為 200 個字元，不能以`http://`和`https://`開頭。	Listener
ClientAffinity	string	否	用戶端親和性。不傳入值時，不保持用戶端親和性，即不能確保來自同一用戶端的連線請求始終定向到同一終端節點。取值為SOURCE_IP時，保持用戶端親和性。即用戶端存取有狀態的應用程式時，可以將來自同一用戶端的所有請求都定向到同一終端節點，而不考慮來源連接埠和通訊協定。	SOURCE_IP
Protocol	string	否	監聽的網路傳輸通訊協定類型，取值： tcp：TCP 通訊協定。 udp：UDP 通訊協定。 http：HTTP 通訊協定。 https：HTTPS 通訊協定。	tcp
PortRanges	array<object>	是	監聽連接埠資訊。可配置的監聽連接埠範圍為 1~65499。最多可配置連接埠數量與監聽路由類型和監聽通訊協定類型相關，更多資訊，請參見監聽連接埠。
	object	否	監聽連接埠資訊。可配置的監聽連接埠範圍為 1~65499。最多可配置連接埠數量與監聽路由類型和監聽通訊協定類型相關，更多資訊，請參見監聽連接埠。
FromPort	integer	是	用來接收請求並向終端節點進行轉送的起始監聽連接埠。可配置的監聽連接埠範圍為 1~65499，且需滿足 FromPort≤ToPort。最多可配置連接埠數量與監聽路由類型和監聽通訊協定類型相關，更多資訊，請參見監聽連接埠。說明對於 HTTP 或 HTTPS 通訊協定的監聽，只支援配置一個監聽連接埠，即起始監聽連接埠和結束監聽連接埠需相同。	20
ToPort	integer	是	用來接收請求並向終端節點進行轉送的結束監聽連接埠。可配置的監聽連接埠範圍為 1~65499，且需滿足 FromPort≤ToPort。最多可配置連接埠數量與監聽路由類型和監聽通訊協定類型相關，更多資訊，請參見監聽連接埠。說明對於 HTTP 或 HTTPS 通訊協定的監聽，只支援配置一個監聽連接埠，即起始監聽連接埠和結束監聽連接埠需相同。	20
Certificates	array<object>	否	SSL 憑證清單。
	object	否	SSL 憑證清單。
Id	string	否	SSL 憑證 ID。說明僅 HTTPS 通訊協定的監聽需要配置該參數。	449****-cn-hangzhou
XForwardedForConfig	object	否	`XForward`欄位配置資訊。
XForwardedForGaIdEnabled	boolean	否	是否透過`GA-ID`標頭欄位取得全球加速執行個體 ID。取值： true：是。 false（預設值）：否。說明僅 HTTP 和 HTTPS 監聽支援此參數。	false
XForwardedForGaApEnabled	boolean	否	是否透過`GA-AP`欄位取得加速地域資訊。取值： true：是。 false（預設值）：否。說明僅 HTTP 和 HTTPS 監聽支援此參數。	false
XForwardedForProtoEnabled	boolean	否	是否透過`GA-X-Forward-Proto`欄位取得全球加速執行個體的監聽通訊協定。取值： true：是。 false（預設值）：否。說明僅 HTTP 和 HTTPS 監聽支援此參數。	false
XForwardedForPortEnabled	boolean	否	是否透過`GA-X-Forward-Port`欄位取得全球加速執行個體的監聽連接埠。取值： true：是。 false（預設值）：否。說明僅 HTTP 和 HTTPS 監聽支援此參數。	false
XRealIpEnabled	boolean	否	是否透過`X-Real-IP`欄位取得真實的用戶端 IP。取值： true：是。 false（預設值）：否。說明僅 HTTP 和 HTTPS 監聽支援此參數。	false
SecurityPolicyId	string	否	安全策略執行個體 ID。取值： 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。說明僅 HTTPS 監聽支援此參數。	tls_cipher_policy_1_0
Type	string	否	監聽的路由類型。取值： Standard（預設值）：智慧路由類型。 CustomRouting：自訂路由類型。說明監聽支援自訂路由類型的功能邀測中，如需使用，請聯絡阿里雲客戶經理。同一個標準型全球加速執行個體，不支援同時配置兩種路由類型的監聽，且路由類型配置完成後不支援變更。更多資訊，請參見監聽概述。	Standard
EndpointGroupConfigurations	array<object>	否	智慧路由類型監聽的終端節點群組的配置資訊。您最多可以配置 10 個該類型終端節點群組。說明僅當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊。
	array<object>	否	智慧路由類型監聽的終端節點群組配置。您最多可以配置 10 個該類型終端節點群組。說明僅當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊。
EndpointGroupName	string	否	智慧路由類型監聽的終端節點群組名稱。名稱長度為 1~128 個字元，以大小寫字母或中文開頭，可包含數字、半形句號（.）底線（_）和短橫線（-）。您最多可以輸入 10 個終端節點群組名稱。說明僅當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊。	test
EndpointGroupDescription	string	否	智慧路由類型監聽的終端節點群組描述資訊。描述長度最大 200 字元，不能包含`http://`和`https://`字元。您最多可以輸入 10 個終端節點群組描述資訊。說明僅當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊。	test
EndpointGroupRegion	string	否	智慧路由類型監聽的終端節點群組所屬地域 ID。您最多可以輸入 10 個終端節點群組的地域 ID。說明僅當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊。	cn-hangzhou
TrafficPercentage	integer	否	流量調配值，即智慧路由類型監聽有多個終端節點群組時，配置到不同終端節點群組的流量比例。取值範圍：1~100。預設值：100。您最多可以輸入 10 個終端節點群組的流量調配值。說明僅當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊。	100
HealthCheckEnabled	boolean	否	是否為智慧路由類型監聽的終端節點群組開啟健康檢查。取值： true：開啟健康檢查。 false（預設值）：關閉健康檢查。您最多可以開啟 10 個終端節點群組的健康檢查。說明僅當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊。	false
HealthCheckIntervalSeconds	integer	否	健康檢查的時間間隔，單位：秒。您最多可以輸入 10 個健康檢查的時間間隔。說明僅當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊。	3
HealthCheckPath	string	否	健康檢查路徑。您最多可以輸入 10 個健康檢查路徑。說明僅當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊。	/healthcheck
HealthCheckPort	integer	否	健康檢查的連接埠。取值範圍：1~65535。您最多可以輸入 10 個健康檢查的連接埠。說明僅當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊。	20
HealthCheckProtocol	string	否	健康檢查的通訊協定。取值： tcp 或 TCP：TCP 通訊協定。 http 或 HTTP：HTTP 通訊協定。 https 或 HTTPS：HTTPS 通訊協定。您最多可以輸入 10 個健康檢查的通訊協定。說明僅當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊。	tcp
ThresholdCount	integer	否	針對健康檢查狀態變化所需要的連續健康檢查次數，即從成功到失敗的連續健康檢查失敗次數或從失敗到成功的連續健康檢查成功次數。取值範圍：2~10。預設值：3。您最多可以輸入 10 個健康檢查狀態變化所需要的連續健康檢查次數值。說明僅當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊。	3
EndpointConfigurations	array<object>	否	智慧路由類型監聽的終端節點配置資訊。
	object	否	智慧路由類型監聽的終端節點配置資訊。
Type	string	否	智慧路由類型監聽的終端節點類型。取值： Domain：自訂網域。 Ip：自訂 IP。 PublicIp：阿里雲公網 IP。 ECS：阿里雲 ECS 執行個體。 SLB：阿里雲 SLB 執行個體。 ALB：阿里雲 ALB 執行個體。 OSS：阿里雲 OSS 執行個體。 ENI：阿里雲彈性網卡。 NLB：阿里雲 NLB 執行個體。 IpTarget：自訂私網 IP。在智慧路由類型監聽的某個終端節點群組中，您最多可以輸入 100 個終端節點類型。說明當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊，且該參數必填。終端節點類型取值為 ECS、ENI、SLB、ALB、NLB 或 IpTarget 時，如果服務關聯角色不存在，系統會自動建立一個名稱為 AliyunServiceRoleForGaVpcEndpoint 的服務關聯角色。終端節點類型取值為 ALB 時，如果服務關聯角色不存在，系統會自動建立一個名稱為 AliyunServiceRoleForGaAlb 的服務關聯角色。終端節點類型取值為 OSS 時，如果服務關聯角色不存在，系統會自動建立一個名稱為 AliyunServiceRoleForGaOss 的服務關聯角色。終端節點類型取值為 NLB 時，如果服務關聯角色不存在，系統會自動建立一個名稱為 AliyunServiceRoleForGaNlb 的服務關聯角色。說明更多資訊，請參見服務關聯角色。	Ip
Weight	integer	否	智慧路由類型監聽的終端節點權重。取值範圍：0~255。在智慧路由類型監聽的某個終端節點群組中，您最多可以輸入 100 個終端節點的權重。說明當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊，且該參數必填。如果某個終端節點的權重設定為 0，全球加速將終止向該終端節點分發流量，請您謹慎操作。	20
Endpoint	string	否	智慧路由類型監聽的終端節點的 IP 或網域。在智慧路由類型監聽的某個終端節點群組中，您最多可以輸入 100 個終端節點的 IP 或網域。說明當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊，且該參數必填。	47.0.XX.XX
SubAddress	string	否	彈性網卡的私網 IP 位址。說明當終端節點類型為 ENI 時，可以選擇配置該參數，如果不配置預設為 ENI 的主私網 IP 位址。	172.168.XX.XX
EnableClientIPPreservation	boolean	否	是否使用自動取得方式開啟保持用戶端來源 IP 功能，取值： true：開啟保持用戶端來源 IP 功能。 false（預設值）：不開啟保持用戶端來源 IP 功能。說明 UDP/TCP 監聽對應的終端節點群組預設不開啟保持用戶端來源 IP，您可根據業務需要配置。 HTTP（S）監聽對應的終端節點群組預設開啟保持用戶端來源 IP，透過 X-Forwarded-For 標頭欄位取得。不支援關閉。 EnableClientIPPreservation 與 EnableProxyProtocol 不能同時為 true。更多資訊請參考保持用戶端來源 IP。
EnableProxyProtocol	boolean	否	是否使用 ProxyProtocol 方式開啟保持用戶端來源 IP 功能，取值： true：開啟保持用戶端來源 IP 功能。 false（預設值）：不開啟保持用戶端來源 IP 功能。說明僅支援 TCP 監聽對應的終端節點群組配置。 EnableClientIPPreservation 與 EnableProxyProtocol 不能同時為 true。更多資訊請參考保持用戶端來源 IP。
VpcId	string	否	專有網路 ID。在智慧路由類型監聽的某個終端節點群組中，您最多可以輸入 1 個專有網路 ID。說明僅當終端節點類型為 IpTarget 時有效且必填。	vpc-bp13r1kpr2lel****
VSwitchIds	array	否	VPC 下的交換器清單。
	string	否	虛擬交換器 ID。在智慧路由類型監聽的某個終端節點群組中，您最多可以輸入 2 個虛擬交換器 ID。說明僅當終端節點類型為 IpTarget 時有效且必填。該虛擬交換器屬於 VpcId 參數指定的專有網路。	vsw-0jlhcznhw5m7pz2fa****
Provider	string	否	端點配置的提供者。	BAILIAN
ApiKeys	array	否	端點群組配置中的 API 金鑰。
	string	否	端點群組配置中的 API 金鑰。	sk-******
EndpointRequestProtocol	string	否	智慧路由類型監聽的終端節點後端服務通訊協定。取值： HTTP（預設值）：HTTP 通訊協定。 HTTPS：HTTPS 通訊協定。您最多可以輸入 10 個後端服務通訊協定。說明僅當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊。僅為 HTTP 或 HTTPS 通訊協定的智慧路由類型監聽建立終端節點群組時才支援配置該項。對於 HTTP 通訊協定的監聽，後端服務通訊協定支援且僅支援 HTTP。	HTTP
EndpointProtocolVersion	string	否	智慧路由類型監聽的終端節點後端服務通訊協定版本。取值： HTTP1.1（預設值）：HTTP1.1 版本。 HTTP2：HTTP2 版本。說明僅當 EndpointRequestProtocol（終端節點後端服務通訊協定）值為 HTTPS 時，支援配置終端節點後端服務通訊協定版本。	HTTP1.1
EndpointGroupType	string	否	智慧路由類型監聽的終端節點群組類型。取值： default（預設值）：預設終端節點群組。 virtual：虛擬終端節點群組。您最多可以輸入 10 個終端節點群組類型。說明僅當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊。僅 HTTP 或 HTTPS 通訊協定的智慧路由類型監聽才支援建立虛擬終端節點群組。	default
PortOverrides	array<object>	否	連接埠映射關係。
	object	否	連接埠映射關係。
ListenerPort	integer	否	配置連接埠映射時的監聽連接埠。您最多可以輸入 5 個連接埠映射中的監聽連接埠。說明僅當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊。對於 TCP 監聽：虛擬終端節點群組不支援配置連接埠映射。如果監聽下已存在虛擬終端節點群組，則預設終端節點群組無法配置連接埠映射。如果預設終端節點群組已配置連接埠映射，則無法新增虛擬終端節點群組。配置連接埠映射後，後續監聽變更時有以下限制：除 HTTP 和 HTTPS 之間的通訊協定切換以外，不支援修改監聽通訊協定。監聽連接埠：您修改的監聽連接埠範圍必須包含目前所配置連接埠映射的全量監聽連接埠。例如，當監聽連接埠範圍為 80-82，並配置連接埠映射至終端節點連接埠 100-102 時，後續修改監聽連接埠範圍時，不支援修改為 80-81。	443
EndpointPort	integer	否	配置連接埠映射時的終端節點連接埠。您最多可以輸入 5 個連接埠映射中的終端節點連接埠。說明僅當 Type（監聽路由類型）值為 Standard（智慧路由類型）時，支援配置智慧路由類型監聽的終端節點群組和終端節點資訊。對於 TCP 監聽：虛擬終端節點群組不支援配置連接埠映射。如果監聽下已存在虛擬終端節點群組，則預設終端節點群組無法配置連接埠映射。如果預設終端節點群組已配置連接埠映射，則無法新增虛擬終端節點群組。配置連接埠映射後，後續監聽變更時有以下限制：除 HTTP 和 HTTPS 之間的通訊協定切換以外，不支援修改監聽通訊協定。監聽連接埠：您修改的監聽連接埠範圍必須包含目前所配置連接埠映射的全量監聽連接埠。例如，當監聽連接埠範圍為 80-82，並配置連接埠映射至終端節點連接埠 100-102 時，後續修改監聽連接埠範圍時，不支援修改為 80-81。	80
HealthCheckHost	string	否	健康檢查網域。	www.taobao.com
EndpointIpVersion	string	否	後端 IP 位址通訊協定。取值： IPv4（預設值）：GA 僅使用 IPv4 位址與終端節點服務通訊。 IPv6：GA 僅使用 IPv6 位址與終端節點服務通訊。 ProtocolAffinity：GA 與終端節點服務通訊的 IP 通訊協定與用戶端請求使用的 IP 通訊協定相同。	IPv4
HealthCheckMethod	string	否	健康檢查使用的 HTTP 請求方法。	GET
HealthCheckSuccessCodes	string	否	健康檢查判定為成功的狀態碼集合。	http_2xx,http_3xx
CustomRoutingEndpointGroupConfigurations	array<object>	否	自訂路由類型監聽的終端節點群組配置資訊。您最多可以配置 5 個該類型終端節點群組。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。
	array<object>	否	自訂路由類型監聽的終端節點群組配置資訊。您最多可以配置 5 個該類型終端節點群組。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。
EndpointGroupRegion	string	否	自訂路由類型監聽的終端節點群組所屬地域 ID。您最多可以輸入 5 個終端節點群組地域 ID。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。	cn-hangzhou
Name	string	否	自訂路由類型監聽的終端節點群組名稱。名稱長度為 1~128 個字元，以大小寫字母或中文開頭，可包含數字、半形句點（.）、底線（_）和短橫線（-）。最多可以輸入 5 個終端節點群組名稱。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。	test
Description	string	否	自訂路由類型監聽的終端節點群組的描述資訊。描述長度最大 200 字元，不能包含 `http://` 和 `https://` 字元。最多可以輸入 5 個終端節點群組的描述資訊。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。	test
DestinationConfigurations	array<object>	否	自訂路由類型監聽的終端節點群組的映射資訊配置。您需要輸入終端節點群組後端服務連接埠範圍和通訊協定類型，輸入資訊與關聯的監聽連接埠範圍將形成映射關係。自訂路由類型監聽的每個終端節點群組下，最多可輸入 20 條映射連接埠範圍和通訊協定類型資訊。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。
	object	否	自訂路由類型監聽的終端節點群組的映射資訊配置。您需要輸入終端節點群組後端服務連接埠範圍和通訊協定類型，輸入資訊與關聯的監聽連接埠範圍將形成映射關係。自訂路由類型監聽的每個終端節點群組下，最多可輸入 20 條映射連接埠範圍和通訊協定類型資訊。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。
Protocols	array	否	自訂路由類型監聽的終端節點群組後端服務的通訊協定類型。自訂路由類型監聽的每個終端節點群組映射連接埠範圍和通訊協定類型資訊中，最多可以輸入 4 個後端服務通訊協定類型。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。
	string	否	自訂路由類型監聽的終端節點群組後端服務通訊協定類型。取值： TCP：TCP 通訊協定。 UDP：UDP 通訊協定。 TCP,UDP：TCP 和 UDP 通訊協定。自訂路由類型監聽的每個終端節點群組映射連接埠範圍和通訊協定類型資訊中，最多可以輸入 4 個後端服務通訊協定類型。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。	TCP
FromPort	integer	否	自訂路由類型監聽的終端節點群組後端服務起始連接埠。取值範圍：1~65499，且需滿足 FromPort≤ToPort，即終端節點群組後端服務起始連接埠需小於等於終端節點群組後端服務結束連接埠。自訂路由類型監聽的每個終端節點群組下，最多可輸入 20 條後端服務起始連接埠資訊。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。	80
ToPort	integer	否	自訂路由類型監聽的終端節點群組後端服務結束連接埠。取值範圍：1~65499，且需滿足 FromPort≤ToPort，即終端節點群組後端服務起始連接埠需小於等於終端節點群組後端服務結束連接埠。自訂路由類型監聽的每個終端節點群組下，最多可輸入 20 條後端服務結束連接埠資訊。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。	80
EndpointConfigurations	array<object>	否	自訂路由類型監聽的終端節點資訊。自訂路由類型監聽的每個終端節點群組下，最多可輸入 10 個終端節點資訊。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。
	array<object>	否	自訂路由類型監聽的終端節點資訊。自訂路由類型監聽的每個終端節點群組下，最多可輸入 10 個終端節點資訊。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。
Type	string	否	自訂路由類型監聽的終端節點後端服務類型。取值： PrivateSubNet（預設值）：私網 CIDR。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。	PrivateSubNet
Endpoint	string	否	自訂路由類型監聽的終端節點交換器（vSwitch）執行個體名稱。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。	vsw-test01
TrafficToEndpointPolicy	string	否	自訂路由類型監聽的終端節點後端服務流量通行策略，取值： DenyAll（預設值）：拒絕所有存取流量存取指定後端服務。 AllowAll：允許所有存取流量存取指定後端服務。 AllowCustom：指定可以接收存取流量的通行目標。您需要指定該通訊目標的 IP 位址和連接埠範圍，連接埠範圍輸入為空時，表示支援該通行目標的所有連接埠。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。	DenyAll
PolicyConfigurations	array<object>	否	自訂路由類型監聽的終端節點流量通行目標配置。自訂路由類型監聽的每個終端節點下，最多可輸入 20 個通行目標。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。
	array<object>	否	自訂路由類型監聽的終端節點流量通行目標配置。自訂路由類型監聽的每個終端節點下，最多可輸入 20 個通行目標。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。
Address	string	否	指定可以接受存取流量的通行目標 IP 位址。僅當 TrafficToEndpointPolicy 取值為 AllowCustom 時，該項生效。自訂路由類型監聽的每個終端節點下，最多可輸入 20 個通行目標 IP 位址。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。	10.0.XX.XX
PortRanges	array<object>	否	指定可以接受存取流量的通行目標連接埠範圍。該連接埠範圍必須屬於終端節點群組後端服務連接埠範圍。輸入為空時，表示支援該通行目標的所有連接埠。僅當 TrafficToEndpointPolicy（流量通行策略）取值為 AllowCustom（指定可接受存取流量的通行目標）時，該項生效。自訂路由類型監聽的每個終端節點下，最多可輸入 20 個通行目標的連接埠範圍，每個通行目標最多可輸入 5 個連接埠範圍。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。
	object	否	指定可以接受存取流量的通行目標連接埠範圍。該連接埠範圍必須屬於終端節點群組後端服務連接埠範圍。輸入為空時，表示支援該通行目標的所有連接埠。僅當 TrafficToEndpointPolicy（流量通行策略）取值為 AllowCustom（指定可接受存取流量的通行目標）時，該項生效。自訂路由類型監聽的每個終端節點下，最多可輸入 20 個通行目標的連接埠範圍，每個通行目標最多可輸入 5 個連接埠範圍。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。
FromPort	integer	否	指定可以接受存取流量的通行目標的起始連接埠。該連接埠取值必須屬於終端節點群組後端服務連接埠範圍。僅當 TrafficToEndpointPolicy（流量通行策略）取值為 AllowCustom（指定可接受存取流量的通行目標）時，該項生效。自訂路由類型監聽的每個終端節點下，最多可輸入 20 個通行目標的連接埠範圍，每個通行目標最多可輸入 5 個起始連接埠。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。	80
ToPort	integer	否	指定可以接受存取流量的通行目標的結束連接埠。該連接埠取值必須屬於終端節點群組後端服務連接埠範圍。僅當 TrafficToEndpointPolicy（流量通行策略）取值為 AllowCustom（指定可接受存取流量的通行目標）時，該項生效。自訂路由類型監聽的每個終端節點下，最多可輸入 20 個通行目標的連接埠範圍，每個通行目標最多可輸入 5 個結束連接埠。說明僅當 Type（監聽路由類型）值為 CustomRouting（自訂路由類型）時，支援配置自訂路由類型監聽的終端節點群組和終端節點資訊。	80
IdleTimeout	integer	否	連線閒置逾時時間。單位：秒。 TCP：10-900s，預設 900s UDP：10-20s ，預設 20s HTTP/HTTPS：1-60 秒，預設 15s	900
RequestTimeout	integer	否	HTTP/HTTPS 的連線請求逾時時間。單位：秒。可選：1-180 秒，預設 60s。說明僅對 Protocol（網路傳輸通訊協定類型）為 HTTP 或 HTTPS 的監聽有效。如果在逾時時間內後端伺服器一直沒有回應，全球加速將放棄等待，並給用戶端傳回 HTTP 504 錯誤碼。	15
HttpVersion	string	否	HTTP 通訊協定的最大版本，取值： http3：HTTP/3。 http2（預設值）：HTTP/2。 http1.1：HTTP/1.1。說明僅 HTTPS 監聽支援此參數。	http2

返回參數

名稱	類型	描述	樣本值
	object	傳回資訊清單。
RequestId	string	請求 ID。	04F0F334-1335-436C-A1D7-6C044FE73368
ListenerId	string	監聽 ID。	lsr-bp1bpn0kn908w4nbw****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	Resource.QuotaFull	The resource quota is exceeded.
400	ProtocalIllegal.Listener	The specified listener protocol is invalid.
400	NotExist.Accelerator	The accelerated instance does not exist.
400	StateError.Accelerator	The state of the accelerated instance is invalid.
400	QuotaExceeded.Listener	The maximum number of listeners is exceeded.
400	QuotaExceeded.ListenerPort	The maximum number of listener ports is exceeded.
400	NotExist.ListenerPort	listener port %s is not exist
400	PortRangeIllegal.Listener	The specified listener port range is invalid.
400	PortRangeIllegal.Count	The hugePort listener only supports one port range.
400	PortConflict.Listener	The listener port configuration is in conflict.
400	PortRangeIllegal.ExceedGaAbility	The listener port range is invalid. For each accelerator instance, you can only create a listener with port range over 300 for each protocol (TCP and UDP).
400	PortRangeIllegal.UDP	UDP ports 250, 4789, and 4790 are system reserved ports.
400	SystemPort.Listener	Ports 65500-65535 are system reserved ports.
400	PortRanges.MustOne	The portRanges must be one for HTTPS and HTTP type listener.
400	SecurityPolicyId.NotNeed	No security policy ID is required for the listener.
400	SecurityPolicyIdIllegal.Listener	The listener security policy ID %s is illegal.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.
403	Forbbiden.SubUser	You are not authorized to operate on the specified resource because your account was created by another user.
403	Forbidden	The user is not authorized to operate on the specified resource.

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

變更歷史

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