调用UpdateListener接口修改全球加速实例下指定监听的配置。

使用说明

本接口用于修改指定监听的协议、端口以及终端节点组等信息,使监听配置满足您的业务需求。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateListener

系统规定参数。取值:UpdateListener

RegionId String cn-hangzhou

全球加速实例所在的地域ID,仅取值cn-hangzhou

ClientToken String 123e4567-e89b-12d3-a456-426655440000

保证请求幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。

Name String Listener

监听的名称。

名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、下划线(_)和短划线(-)。

Description String Listener

监听实例的描述。

ClientAffinity String SOURCE_IP

客户端亲和性。

  • 不传入值时,不保持客户端亲和性,即不能确保来自同一客户端的连接请求始终定向到同一终端节点。
  • 取值为SOURCE_IP时,保持客户端亲和性。即客户端访问有状态的应用程序时,可以将来自同一客户端的所有请求都定向到同一终端节点,而不考虑源端口和协议。
Protocol String tcp

监听的网络传输协议类型,取值:

  • tcp:TCP协议。
  • udp:UDP协议。
  • http:HTTP协议。
  • https:HTTPS协议。
ListenerId String lsr-bp1bpn0kn908w4nbw****

监听实例ID。

ProxyProtocol String false

是否开启保持客户端源IP功能。

  • true:开启保持客户端源IP功能。开启后,支持后端服务查看客户端的原始IP地址。
  • false(默认值):不开启保持客户端源IP功能。
XForwardedForConfig Object

XForward字段配置信息。

XForwardedForGaIdEnabled Boolean false

是否通过GA-ID头字段获取全球加速实例ID。取值:

  • true:是。
  • false(默认值):否。
说明 仅HTTP和HTTPS监听支持此参数。
XForwardedForProtoEnabled Boolean false

是否通过GA-X-Forward-Proto字段获取全球加速实例的监听协议。取值:

  • true:是。
  • false(默认值):否。
说明 仅HTTP和HTTPS监听支持此参数。
XForwardedForPortEnabled Boolean false

是否通过GA-X-Forward-Port字段获取全球加速实例的监听端口。取值:

  • true:是。
  • false(默认值):否。
说明 仅HTTP和HTTPS监听支持此参数。
XRealIpEnabled Boolean false

是否通过X-Real-IP字段获取真实的客户端IP。取值:

  • true:是。
  • false(默认值):否。
说明 仅HTTP和HTTPS监听支持此参数。
XForwardedForGaApEnabled Boolean false

是否通过GA-AP字段获取加速地域信息。取值:

  • true:是。
  • false(默认值):否。
说明 仅HTTP和HTTPS监听支持此参数。
SecurityPolicyId String tls_cipher_policy_1_0

安全策略实例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监听支持此参数。
PortRanges.N.FromPort Integer 20

用来接收请求并向终端节点进行转发的起始监听端口。

说明 对于HTTP或HTTPS协议的监听,只支持配置一个监听端口,即起始监听端口和结束监听端口需相同。
PortRanges.N.ToPort Integer 21

用来接收请求并向终端节点进行转发的结束监听端口。

Certificates.N.Id String 449****-cn-hangzhou

SSL证书ID。

说明 仅HTTPS协议的监听需要配置该项。
BackendPorts.N.FromPort Integer 80

后端服务器接收请求的起始端口。

说明 当您的监听协议为HTTPS,且监听的端口和后端服务器提供服务的端口一致时才需填写该项。其中,后端服务器接收请求的起始端口和结束端口需相同。
BackendPorts.N.ToPort Integer 80

后端服务器接收请求的结束端口。

返回数据

名称 类型 示例值 描述
RequestId String 6FEA0CF3-D3B9-43E5-A304-D217037876A8

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateListener
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000	
&Name=Listener
&Description=Listener
&ClientAffinity=SOURCE_IP
&Protocol=tcp
&ListenerId=lsr-bp1bpn0kn908w4nbw****
&ProxyProtocol=false
&PortRanges=[{"FromPort":20,"ToPort":21}]
&Certificates=[{"Id":"449****-cn-hangzhou"}]
&BackendPorts=[{"FromPort":80,"ToPort":80}]
&XForwardedForConfig={"XForwardedForGaIdEnabled":false,"XForwardedForProtoEnabled":false,"XForwardedForPortEnabled":false,"XRealIpEnabled":false,"XForwardedForGaApEnabled":false}
&SecurityPolicyId=tls_cipher_policy_1_0
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateListenerResponse>
    <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8	</RequestId>
</UpdateListenerResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t"
}

错误码

HttpCode 错误码 错误信息 描述
400 NotActive.Listener The state of the listener is not active. 监听器状态非稳态
400 PortRangeIllegal.Listener The specified listener port range is invalid. 监听端口范围配置非法
400 PortConflict.Listener The listener port configuration is in conflict. 监听端口配置冲突
400 QuotaExceeded.ListenerPort The maximum number of listener ports is exceeded. 监听端口达到Quota限制
400 NotExist.Accelerator The accelerated instance does not exist. 加速实例不存在
400 StateError.Accelerator The state of the accelerated instance is invalid. 加速实例状态非法
400 PortRanges.MustOne The portRanges must be one for HTTPS and HTTP type listener. HTTPS/HTTP类型监听只支持一个端口
400 SecurityPolicyIdIllegal.Listener The listener security policy ID %s is illegal. 监听安全策略id不合法。
400 SecurityPolicyId.NotNeed No security policy ID is required for the listener. 当前监听不需要配置安全策略ID。

访问错误中心查看更多错误码。