CreateListener
监听负责检查连接请求,然后根据调度算法定义的转发策略将请求流量分发至终端节点。您可以调用CreateListener接口为全球加速实例创建监听
服务地址:
华东1(杭州)
输入参数
只看必填
RegionId全球加速实例所在的地域ID
AcceleratorId全球加速实例ID
Name监听的名称
Description监听的描述信息
ClientAffinity客户端亲和性
Protocol监听的网络传输协议类型
PortRanges监听端口信息
0监听端口信息
FromPort用来接收请求并向终端节点进行转发的起始...
ToPort用来接收请求并向终端节点进行转发的结束...
CertificatesSSL证书列表
0SSL证书列表
IdSSL证书ID
XForwardedForConfigXForward字段配置信息
XForwardedForGaIdEnabled是否通过GA-ID头字段获取全球加速实例ID
请选择布尔值
XForwardedForGaApEnabled是否通过GA-AP字段获取加速地域信息
请选择布尔值
XForwardedForProtoEnabled是否通过GA-X-Forward-Pr...
请选择布尔值
XForwardedForPortEnabled是否通过GA-X-Forward-Po...
请选择布尔值
XRealIpEnabled是否通过X-Real-IP字段获取真实...
请选择布尔值
SecurityPolicyId安全策略实例ID
Type监听的路由类型
EndpointGroupConfigurations智能路由类型监听的终端节点组的配置信息
0智能路由类型监听的终端节点组配置
EndpointGroupName智能路由类型监听的终端节点组名称
EndpointGroupDescription智能路由类型监听的终端节点组描述信息
EndpointGroupRegion智能路由类型监听的终端节点组所属地域ID
TrafficPercentage流量调配值
HealthCheckEnabled是否为智能路由类型监听的终端节点组开启...
请选择布尔值
HealthCheckIntervalSeconds健康检查的时间间隔
HealthCheckPath健康检查路径
HealthCheckPort健康检查的端口
HealthCheckProtocol健康检查的协议
ThresholdCount针对健康检查状态变化所需要的连续健康检查次数
EndpointConfigurations智能路由类型监听的终端节点配置信息
0智能路由类型监听的终端节点配置信息
Type智能路由类型监听的终端节点类型
Weight智能路由类型监听的终端节点权重
Endpoint智能路由类型监听的终端节点的IP或域名
SubAddress弹性网卡的私网IP地址
EnableClientIPPreservation是否使用自动获取方式开启保持客户端源 ...
请选择布尔值
EnableProxyProtocol是否使用ProxyProtocol方式...
请选择布尔值
VpcId专有网络ID
VSwitchIdsVPC下的交换机列表
0虚拟交换机ID
EndpointRequestProtocol智能路由类型监听的终端节点后端服务协议
EndpointProtocolVersion智能路由类型监听的终端节点后端服务协议版本
EndpointGroupType智能路由类型监听的终端节点组类型
PortOverrides端口映射关系
0端口映射关系
ListenerPort配置端口映射时的监听端口
EndpointPort配置端口映射时的终端节点端口
CustomRoutingEndpointGroupConfigurations自定义路由类型监听的终端节点组配置信息
0自定义路由类型监听的终端节点组配置信息
EndpointGroupRegion自定义路由类型监听的终端节点组所属地域ID
Name自定义路由类型监听的终端节点组名称
Description自定义路由类型监听的终端节点组的描述信息
DestinationConfigurations自定义路由类型监听的终端节点组的映射信息配置
0自定义路由类型监听的终端节点组的映射信息配置
Protocols自定义路由类型监听的终端节点组后端服务...
0自定义路由类型监听的终端节点组后端服务...
FromPort自定义路由类型监听的终端节点组后端服务...
ToPort自定义路由类型监听的终端节点组后端服务...
EndpointConfigurations自定义路由类型监听的终端节点信息
0自定义路由类型监听的终端节点信息
Type自定义路由类型监听的终端节点后端服务类型
Endpoint自定义路由类型监听的终端节点交换机(v...
TrafficToEndpointPolicy自定义路由类型监听的终端节点后端服务流...
PolicyConfigurations自定义路由类型监听的终端节点流量通行目标配置
0自定义路由类型监听的终端节点流量通行目标配置
Address指定可以接受访问流量的通行目标IP地址
PortRanges指定可以接受访问流量的通行目标端口范围
0指定可以接受访问流量的通行目标端口范围
FromPort指定可以接受访问流量的通行目标的起始端口
ToPort指定可以接受访问流量的通行目标的结束端口
IdleTimeout连接空闲超时时间
RequestTimeoutHTTP/HTTPS的连接请求超时时间
HttpVersionHTTP协议的最大版本
幂等性参数
ClientToken客户端Token
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

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

请求参数

字段名称字段详情
RegionIdstring

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

示例值:cn-hangzhou
ClientTokenstring

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

示例值:123e4567-e89b-12d3-a456-426655440000
AcceleratorIdstring

全球加速实例 ID。

示例值:ga-bp1odcab8tmno0hdq****
Namestring

监听的名称。展开详情

示例值:Listener
Descriptionstring

监听的描述信息。展开详情

示例值:Listener
ClientAffinitystring

客户端亲和性。展开详情

示例值:SOURCE_IP
Protocolstring

监听的网络传输协议类型,取值:展开详情

示例值:tcp
PortRangesarray<object>

监听端口信息。展开详情

子级条数 <= 100
Certificatesarray<object>

SSL 证书列表。

子级条数 <= 10
XForwardedForConfigobject

XForward字段配置信息。

SecurityPolicyIdstring

安全策略实例 ID。取值:展开详情

示例值:tls_cipher_policy_1_0
Typestring

监听的路由类型。取值:展开详情

示例值:Standard
EndpointGroupConfigurationsarray<object>

智能路由类型监听的终端节点组的配置信息。展开详情

CustomRoutingEndpointGroupConfigurationsarray<object>

自定义路由类型监听的终端节点组配置信息。展开详情

IdleTimeoutinteger<int32>

连接空闲超时时间。单位:秒。展开详情

示例值:900
RequestTimeoutinteger<int32>

HTTP/HTTPS 的连接请求超时时间。单位:秒。展开详情

示例值:15
HttpVersionstring

HTTP 协议的最大版本,取值:展开详情

示例值:http2

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:04F0F334-1335-436C-A1D7-6C044FE73368
ListenerIdstring

监听 ID。

示例值:lsr-bp1bpn0kn908w4nbw****
变更历史
暂无变更历史