调用CreateListener接口为全球加速实例创建监听。

使用说明

监听负责检查连接请求,然后根据调度算法定义的转发策略将请求流量分发至终端节点。本接口用于为标准型全球加速实例创建监听。

在调用本接口时,请注意以下事项:

  • CreateListener接口属于异步接口,即系统会先返回一个监听ID,但监听并未创建完成,系统后台的创建任务仍在进行。您可以调用DescribeListener查询监听的状态:
    • 当监听处于init状态时,表示监听正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。
    • 当监听处于active状态时,表示监听创建完成。
  • CreateListener接口不支持在同一个全球加速实例内并发创建监听。

调试

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

请求参数

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

系统规定参数。取值:CreateListener

RegionId String cn-hangzhou

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

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

客户端Token,用于保证请求的幂等性。

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

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
AcceleratorId String ga-bp1odcab8tmno0hdq****

全球加速实例ID。

Name String Listener

监听的名称。

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

Description String Listener

监听的描述信息。

描述长度最大为200个字符。

ClientAffinity String SOURCE_IP

客户端亲和性。

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

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

  • tcp:TCP协议。
  • udp:UDP协议。
  • http:HTTP协议。
  • https:HTTPS协议。
ProxyProtocol Boolean false

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

  • true:开启保持客户端源IP功能。开启后,支持后端服务查看客户端的原始IP地址。
  • false(默认值):不开启保持客户端源IP功能。
说明 该参数后续将不在监听API中配置,建议在终端节点组的相关API中进行配置。关于ProxyProtocol,请参见CreateEndpointGroupUpdateEndpointGroup
PortRanges.N.FromPort Integer 20

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

可配置的监听端口范围为1~65499,且需满足FromPortToPort

最多可配置端口数量与监听路由类型和监听协议类型相关,更多信息,请参见监听端口

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

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

可配置的监听端口范围为1~65499,且需满足FromPortToPort

最多可配置端口数量与监听路由类型和监听协议类型相关,更多信息,请参见监听端口

说明 对于HTTP或HTTPS协议的监听,只支持配置一个监听端口,即起始监听端口和结束监听端口需相同。
Certificates.N.Id String 449****-cn-hangzhou

SSL证书ID。

说明 仅HTTPS协议的监听需要配置该参数。
XForwardedForConfig Object

XForward字段配置信息。

XForwardedForGaIdEnabled Boolean false

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

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

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

  • 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监听支持此参数。
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监听支持此参数。
Type String Standard

监听的路由类型。取值:

  • Standard(默认值):智能路由类型。
  • CustomRouting:自定义路由类型。
说明
  • 监听支持自定义路由类型的功能邀测中,如需使用,请提交工单申请。
  • 同一个标准型全球加速实例,不支持同时配置两种路由类型的监听,且路由类型配置完成后不支持变更。更多信息,请参见监听概述
EndpointGroupConfigurations.N.EndpointGroupName String test

智能路由类型监听的终端节点组名称。

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

您最多可以输入10个终端节点组名称。

说明 仅当Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
EndpointGroupConfigurations.N.EndpointGroupDescription String test

智能路由类型监听的终端节点组描述信息。

描述长度最大256字符,不能包含http://https://字符。

您最多可以输入10个终端节点组描述信息。

说明 仅当Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
EndpointGroupConfigurations.N.EndpointGroupRegion String cn-hangzhou

智能路由类型监听的终端节点组所属地域ID。

您最多可以输入10个终端节点组的地域ID。

说明 仅当Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
EndpointGroupConfigurations.N.TrafficPercentage Long 100

流量调配值,即智能路由类型监听有多个终端节点组时,配置到不同终端节点组的流量比例。

取值范围:1~100。默认值:100

您最多可以输入10个终端节点组的流量调配值。

说明 仅当Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
EndpointGroupConfigurations.N.HealthCheckEnabled Boolean false

是否为智能路由类型监听的终端节点组开启健康检查。取值:

  • true:开启健康检查。
  • false(默认值):关闭健康检查。

您最多可以开启10个终端节点组的健康检查。

说明 仅当Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
EndpointGroupConfigurations.N.HealthCheckIntervalSeconds Long 3

健康检查的时间间隔,单位:秒。

您最多可以输入10个健康检查的时间间隔。

说明 仅当Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
EndpointGroupConfigurations.N.HealthCheckPath String /healthcheck

健康检查路径。

您最多可以输入10个健康检查路径。

说明 仅当Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
EndpointGroupConfigurations.N.HealthCheckPort Long 20

健康检查的端口。取值范围:1~65535

您最多可以输入10个健康检查的端口。

说明 仅当Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
EndpointGroupConfigurations.N.HealthCheckProtocol String tcp

健康检查的协议。取值:

  • tcp:TCP协议。
  • http:HTTP协议。
  • https:HTTPS协议。

您最多可以输入10个健康检查的协议。

说明 仅当Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
EndpointGroupConfigurations.N.ThresholdCount Long 3

针对健康检查状态变化所需要的连续健康检查次数,即从成功到失败的连续健康检查失败次数或从失败到成功的连续健康检查成功次数。

取值范围:2~10。默认值:3

您最多可以输入10个健康检查状态变化所需要的连续健康检查次数值。

说明 仅当Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
EndpointGroupConfigurations.N.EndpointConfigurations.N.Type String Ip

智能路由类型监听的终端节点类型。取值:

  • Domain:自定义域名。
  • Ip:自定义IP。
  • PublicIp:阿里云公网IP。
  • ECS:阿里云ECS实例。
  • SLB:阿里云SLB实例。
  • ALB:阿里云ALB实例。
  • OSS:阿里云OSS实例。

在智能路由类型监听的某个终端节点组中,您最多可以输入100个终端节点类型。

说明
  • Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息,且该参数必填。
  • 终端节点类型取值为ECSSLB时,如果服务关联角色不存在,系统会自动创建一个名称为AliyunServiceRoleForGaVpcEndpoint的服务关联角色。
  • 终端节点类型取值为ALB时,如果服务关联角色不存在,系统会自动创建一个名称为AliyunServiceRoleForGaAlb的服务关联角色。
  • 终端节点类型取值为OSS时,如果服务关联角色不存在,系统会自动创建一个名称为AliyunServiceRoleForGaOss的服务关联角色。

更多信息,请参见服务关联角色

EndpointGroupConfigurations.N.EndpointConfigurations.N.Weight Long 20

智能路由类型监听的终端节点权重。

取值范围:0~255

在智能路由类型监听的某个终端节点组中,您最多可以输入100个终端节点的权重。

说明
  • Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息,且该参数必填。
  • 如果某个终端节点的权重设置为0,全球加速将终止向该终端节点分发流量,请您谨慎操作。
EndpointGroupConfigurations.N.EndpointConfigurations.N.Endpoint String 47.0.XX.XX

智能路由类型监听的终端节点的IP或域名。

在智能路由类型监听的某个终端节点组中,您最多可以输入100个终端节点的IP或域名。

说明Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息,且该参数必填。
EndpointGroupConfigurations.N.EndpointRequestProtocol String HTTP

智能路由类型监听的终端节点后端服务协议。取值:

  • HTTP(默认值):HTTP协议。
  • HTTPS:HTTPS协议。

您最多可以输入10个后端服务协议。

说明
  • 仅当Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
  • 仅为HTTP或HTTPS协议的智能路由类型监听创建终端节点组时才支持配置该项。
  • 对于HTTP协议的监听,后端服务协议支持且仅支持HTTP
EndpointGroupConfigurations.N.EndpointGroupType String default

智能路由类型监听的终端节点组类型。取值:

  • default(默认值):默认终端节点组。
  • virtual:虚拟终端节点组。

您最多可以输入10个终端节点组类型。

说明
  • 仅当Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
  • 仅HTTP或HTTPS协议的智能路由类型监听才支持创建虚拟终端节点组。
EndpointGroupConfigurations.N.PortOverrides.N.ListenerPort Long 443

配置端口映射时的监听端口。

您最多可以输入5个端口映射中的监听端口。

说明
  • 仅当Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
  • 仅为HTTP或HTTPS协议的智能路由类型监听创建终端节点组时才支持创建端口映射关系。
  • 端口映射中的监听端口必须与当前监听的监听端口一致。
EndpointGroupConfigurations.N.PortOverrides.N.EndpointPort Long 80

配置端口映射时的终端节点端口。

您最多可以输入5个端口映射中的终端节点端口。

说明
  • 仅当Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
  • 仅为HTTP或HTTPS协议的智能路由类型监听创建终端节点组时才支持创建端口映射关系。
EndpointGroupConfigurations.N.EnableClientIPPreservationToa Boolean false

是否使用TOA方式开启保持客户端源IP功能,取值:

  • true:开启保持客户端源IP功能。
  • false(默认值):不开启保持客户端源IP功能。

您最多可以配置10个该功能项。

说明 仅当Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
EndpointGroupConfigurations.N.EnableClientIPPreservationProxyProtocol Boolean false

是否使用ProxyProtocol方式保留客户端源IP。取值:

  • true:使用ProxyProtocol方式保留客户端源IP。
  • false(默认值):不使用ProxyProtocol方式保留客户端源IP。

您最多可以配置10个该功能项。

说明 仅当Type(监听路由类型)值为Standard(智能路由类型)时,支持配置智能路由类型监听的终端节点组和终端节点信息。
CustomRoutingEndpointGroupConfigurations.N.EndpointGroupRegion String cn-hangzhou

自定义路由类型监听的终端节点组所属地域ID。

您最多可以输入5个终端节点组地域ID。

说明 仅当Type(监听路由类型)值为CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
CustomRoutingEndpointGroupConfigurations.N.Name String test

自定义路由类型监听的终端节点组名称。

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

最多可以输入5个终端节点组名称。

说明 仅当Type(监听路由类型)值为CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
CustomRoutingEndpointGroupConfigurations.N.Description String test

自定义路由类型监听的终端节点组的描述信息。

描述长度最大256字符,不能包含http://https://字符。

最多可以输入5个终端节点组的描述信息。

说明 仅当Type(监听路由类型)值为CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
CustomRoutingEndpointGroupConfigurations.N.DestinationConfigurations.N.Protocols.N String tcp

自定义路由类型监听的终端节点组后端服务协议类型。取值:

  • tcp:TCP协议。
  • udp:UDP协议。
  • tcp,udp:TCP和UDP协议。

自定义路由类型监听的每个终端节点组映射端口范围和协议类型信息中,最多可以输入4个后端服务协议类型。

说明 仅当Type(监听路由类型)值为CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
CustomRoutingEndpointGroupConfigurations.N.DestinationConfigurations.N.FromPort Integer 80

自定义路由类型监听的终端节点组后端服务起始端口。

取值范围:1~65499,且需满足FromPortToPort,即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。

自定义路由类型监听的每个终端节点组下,最多可输入20条后端服务起始端口信息。

说明 仅当Type(监听路由类型)值为CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
CustomRoutingEndpointGroupConfigurations.N.DestinationConfigurations.N.ToPort Integer 80

自定义路由类型监听的终端节点组后端服务结束端口。

取值范围:1~65499,且需满足FromPortToPort,即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。

自定义路由类型监听的每个终端节点组下,最多可输入20条后端服务结束端口信息。

说明 仅当Type(监听路由类型)值为CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
CustomRoutingEndpointGroupConfigurations.N.EndpointConfigurations.N.Type String PrivateSubNet

自定义路由类型监听的终端节点后端服务类型。取值:

PrivateSubNet(默认值):私网CIDR。

说明 仅当Type(监听路由类型)值为CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
CustomRoutingEndpointGroupConfigurations.N.EndpointConfigurations.N.Endpoint String vsw-test01

自定义路由类型监听的终端节点交换机(vSwitch)实例名称。

说明 仅当Type(监听路由类型)值为CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
CustomRoutingEndpointGroupConfigurations.N.EndpointConfigurations.N.TrafficToEndpointPolicy String DenyAll

自定义路由类型监听的终端节点后端服务流量通行策略,取值:

  • DenyAll(默认值):拒绝所有访问流量访问指定后端服务。
  • AllowAll:允许所有访问流量访问指定后端服务。
  • AllowCustom:指定可以接收访问流量的通行目标。

    您需要指定该通信目标的IP地址和端口范围,端口范围输入为空时,表示支持该通行目标的所有端口。

说明 仅当Type(监听路由类型)值为CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
CustomRoutingEndpointGroupConfigurations.N.EndpointConfigurations.N.PolicyConfigurations.N.Address String 10.0.XX.XX

指定可以接受访问流量的通行目标IP地址。

仅当TrafficToEndpointPolicy取值为AllowCustom时,该项生效。

自定义路由类型监听的每个终端节点下,最多可输入20个通行目标IP地址。

说明 仅当Type(监听路由类型)值为CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
CustomRoutingEndpointGroupConfigurations.N.EndpointConfigurations.N.PolicyConfigurations.N.PortRanges.N.FromPort Integer 80

指定可以接受访问流量的通行目标的起始端口。该端口取值必须属于终端节点组后端服务端口范围。

仅当TrafficToEndpointPolicy(流量通行策略)取值为AllowCustom(指定可接受访问流量的通行目标)时,该项生效。

自定义路由类型监听的每个终端节点下,最多可输入20个通行目标的端口范围,每个通行目标最多可输入5个起始端口。

说明 仅当Type(监听路由类型)值为CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。
CustomRoutingEndpointGroupConfigurations.N.EndpointConfigurations.N.PolicyConfigurations.N.PortRanges.N.ToPort Integer 80

指定可以接受访问流量的通行目标的结束端口。该端口取值必须属于终端节点组后端服务端口范围。

仅当TrafficToEndpointPolicy(流量通行策略)取值为AllowCustom(指定可接受访问流量的通行目标)时,该项生效。

自定义路由类型监听的每个终端节点下,最多可输入20个通行目标的端口范围,每个通行目标最多可输入5个结束端口。

说明 仅当Type(监听路由类型)值为CustomRouting(自定义路由类型)时,支持配置自定义路由类型监听的终端节点组和终端节点信息。

返回数据

名称 类型 示例值 描述
RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

请求ID。

ListenerId String lsr-bp1bpn0kn908w4nbw****

监听ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateListener
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000	
&AcceleratorId=ga-bp1odcab8tmno0hdq****
&Name=Listener
&Description=Listener
&ClientAffinity=SOURCE_IP
&Protocol=tcp
&ProxyProtocol=false
&PortRanges=[{"FromPort":20,"ToPort":20}]
&Certificates=[{"Id":"449****-cn-hangzhou"}]
&XForwardedForConfig={"XForwardedForGaIdEnabled":false,"XForwardedForGaApEnabled":false,"XForwardedForProtoEnabled":false,"XForwardedForPortEnabled":false,"XRealIpEnabled":false}
&SecurityPolicyId=tls_cipher_policy_1_0
&Type=Standard
&EndpointGroupConfigurations=[{"EndpointGroupName":"test","EndpointGroupDescription":"test","EndpointGroupRegion":"cn-hangzhou","TrafficPercentage":100,"HealthCheckEnabled":false,"HealthCheckIntervalSeconds":3,"HealthCheckPath":"/healthcheck","HealthCheckPort":20,"HealthCheckProtocol":"tcp","ThresholdCount":3,"EndpointConfigurations":[{"Type":"Ip","Weight":20,"Endpoint":"47.0.XX.XX"}],"EndpointRequestProtocol":"HTTP","EndpointGroupType":"default","PortOverrides":[{"ListenerPort":443,"EndpointPort":80}],"EnableClientIPPreservationToa":false,"EnableClientIPPreservationProxyProtocol":false}]
&CustomRoutingEndpointGroupConfigurations=[{"EndpointGroupRegion":"cn-hangzhou","Name":"test","Description":"test","DestinationConfigurations":[{"Protocols":["tcp"],"FromPort":80,"ToPort":80}],"EndpointConfigurations":[{"Type":"PrivateSubNet","Endpoint":"vsw-test01","TrafficToEndpointPolicy":"DenyAll","PolicyConfigurations":[{"Address":"10.0.XX.XX","PortRanges":[{"FromPort":80,"ToPort":80}]}]}]}]
&公共请求参数

正常返回示例

XML格式

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

<CreateListenerResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>
</CreateListenerResponse>

JSON格式

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

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

错误码

HttpCode 错误码 错误信息 描述
400 ProtocalIllegal.Listener The specified listener protocol is invalid. 监听协议配置非法
400 NotExist.Accelerator The accelerated instance does not exist. 加速实例不存在。
400 QuotaExceeded.Listener The maximum number of listeners is exceeded. 监听器达到Quota限制
400 QuotaExceeded.ListenerPort The maximum number of listener ports is exceeded. 监听端口达到Quota限制
400 PortRangeIllegal.Listener The specified listener port range is invalid. 监听端口范围配置非法
400 PortRangeIllegal.Count The hugePort listener only supports one port range. 海量端口监听(端口数>300)仅支持配置一个端口范围
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). 监听端口范围非法,每个全球加速实例只支持创建每种协议(TCP/UDP)各一个端口范围超过300的监听
400 PortRangeIllegal.UDP UDP ports 250, 4789, and 4790 are system reserved ports. UDP监听的250、4789和4790端口为系统保留端口,暂不对外开放
400 SystemPort.Listener Ports 65500-65535 are system reserved ports. 端口65500-65535为系统保留端口
400 PortRanges.MustOne The portRanges must be one for HTTPS and HTTP type listener. HTTPS/HTTP类型监听只支持一个端口
400 SecurityPolicyId.NotNeed No security policy ID is required for the listener. 当前监听不需要配置安全策略ID。
400 SecurityPolicyIdIllegal.Listener The listener security policy ID %s is illegal. 监听安全策略ID不合法。

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