volcenginecc.clb.Listener
监听器负责根据指定的协议和端口,监听CLB实例接收到的用户访问请求。CLB将按照该监听器配置的调度算法,将访问请求转发至该后端服务器组内健康的后端服务器。
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
clbListenerDemo:
type: volcenginecc:clb:Listener
name: ClbListenerDemo
properties:
aclIds:
- acl-mjd01crvppts5smt1bsxxxxx
aclStatus: on
aclType: black
connectionDrainEnabled: on
connectionDrainTimeout: 900
description: ClbListenerDemo description
enabled: on
establishedTimeout: 300
serverGroupId: rsp-rs11ie8u6neov0x58bxxxxx
healthCheck:
enabled: on
healthy_threshold: 3
interval: 5
timeout: 2
unhealthy_threshold: 3
port: 0
udp_request: test
udp_expect: test
listenerName: ClbListenerDemo
loadBalancerId: clb-rs1187938g00v0x58nxxxxx
persistenceTimeout: 1000
persistenceType: source_ip
protocol: UDP
port: 5001
scheduler: wrr
bandwidth: 1
proxyProtocolType: standard
tags:
- key: env
value: test
Create Listener Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Listener(name: string, args: ListenerArgs, opts?: CustomResourceOptions);@overload
def Listener(resource_name: str,
args: ListenerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Listener(resource_name: str,
opts: Optional[ResourceOptions] = None,
load_balancer_id: Optional[str] = None,
server_group_id: Optional[str] = None,
protocol: Optional[str] = None,
port: Optional[int] = None,
client_body_timeout: Optional[int] = None,
keepalive_timeout: Optional[int] = None,
cert_center_certificate_id: Optional[str] = None,
certificate_id: Optional[str] = None,
certificate_source: Optional[str] = None,
acl_ids: Optional[Sequence[str]] = None,
client_header_timeout: Optional[int] = None,
connection_drain_enabled: Optional[str] = None,
connection_drain_timeout: Optional[int] = None,
cookie: Optional[str] = None,
cps: Optional[int] = None,
description: Optional[str] = None,
enabled: Optional[str] = None,
end_port: Optional[int] = None,
established_timeout: Optional[int] = None,
health_check: Optional[ListenerHealthCheckArgs] = None,
http2_enabled: Optional[str] = None,
ca_enabled: Optional[str] = None,
listener_name: Optional[str] = None,
ca_certificate_id: Optional[str] = None,
max_connections: Optional[int] = None,
persistence_timeout: Optional[int] = None,
persistence_type: Optional[str] = None,
bandwidth: Optional[int] = None,
acl_type: Optional[str] = None,
proxy_connect_timeout: Optional[int] = None,
proxy_protocol_type: Optional[str] = None,
proxy_read_timeout: Optional[int] = None,
proxy_send_timeout: Optional[int] = None,
scheduler: Optional[str] = None,
security_policy_id: Optional[str] = None,
send_timeout: Optional[int] = None,
acl_status: Optional[str] = None,
start_port: Optional[int] = None,
tags: Optional[Sequence[ListenerTagArgs]] = None)func NewListener(ctx *Context, name string, args ListenerArgs, opts ...ResourceOption) (*Listener, error)public Listener(string name, ListenerArgs args, CustomResourceOptions? opts = null)
public Listener(String name, ListenerArgs args)
public Listener(String name, ListenerArgs args, CustomResourceOptions options)
type: volcenginecc:clb:Listener
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ListenerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ListenerArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ListenerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ListenerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ListenerArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var volcengineccListenerResource = new Volcenginecc.Clb.Listener("volcengineccListenerResource", new()
{
LoadBalancerId = "string",
ServerGroupId = "string",
Protocol = "string",
Port = 0,
ClientBodyTimeout = 0,
KeepaliveTimeout = 0,
CertCenterCertificateId = "string",
CertificateId = "string",
CertificateSource = "string",
AclIds = new[]
{
"string",
},
ClientHeaderTimeout = 0,
ConnectionDrainEnabled = "string",
ConnectionDrainTimeout = 0,
Cookie = "string",
Cps = 0,
Description = "string",
Enabled = "string",
EndPort = 0,
EstablishedTimeout = 0,
HealthCheck = new Volcenginecc.Clb.Inputs.ListenerHealthCheckArgs
{
Domain = "string",
Enabled = "string",
HealthyThreshold = 0,
HttpCode = "string",
Interval = 0,
Method = "string",
Port = 0,
Timeout = 0,
UdpExpect = "string",
UdpRequest = "string",
UnhealthyThreshold = 0,
Uri = "string",
},
Http2Enabled = "string",
CaEnabled = "string",
ListenerName = "string",
CaCertificateId = "string",
MaxConnections = 0,
PersistenceTimeout = 0,
PersistenceType = "string",
Bandwidth = 0,
AclType = "string",
ProxyConnectTimeout = 0,
ProxyProtocolType = "string",
ProxyReadTimeout = 0,
ProxySendTimeout = 0,
Scheduler = "string",
SecurityPolicyId = "string",
SendTimeout = 0,
AclStatus = "string",
StartPort = 0,
Tags = new[]
{
new Volcenginecc.Clb.Inputs.ListenerTagArgs
{
Key = "string",
Value = "string",
},
},
});
example, err := clb.NewListener(ctx, "volcengineccListenerResource", &clb.ListenerArgs{
LoadBalancerId: pulumi.String("string"),
ServerGroupId: pulumi.String("string"),
Protocol: pulumi.String("string"),
Port: pulumi.Int(0),
ClientBodyTimeout: pulumi.Int(0),
KeepaliveTimeout: pulumi.Int(0),
CertCenterCertificateId: pulumi.String("string"),
CertificateId: pulumi.String("string"),
CertificateSource: pulumi.String("string"),
AclIds: pulumi.StringArray{
pulumi.String("string"),
},
ClientHeaderTimeout: pulumi.Int(0),
ConnectionDrainEnabled: pulumi.String("string"),
ConnectionDrainTimeout: pulumi.Int(0),
Cookie: pulumi.String("string"),
Cps: pulumi.Int(0),
Description: pulumi.String("string"),
Enabled: pulumi.String("string"),
EndPort: pulumi.Int(0),
EstablishedTimeout: pulumi.Int(0),
HealthCheck: &clb.ListenerHealthCheckArgs{
Domain: pulumi.String("string"),
Enabled: pulumi.String("string"),
HealthyThreshold: pulumi.Int(0),
HttpCode: pulumi.String("string"),
Interval: pulumi.Int(0),
Method: pulumi.String("string"),
Port: pulumi.Int(0),
Timeout: pulumi.Int(0),
UdpExpect: pulumi.String("string"),
UdpRequest: pulumi.String("string"),
UnhealthyThreshold: pulumi.Int(0),
Uri: pulumi.String("string"),
},
Http2Enabled: pulumi.String("string"),
CaEnabled: pulumi.String("string"),
ListenerName: pulumi.String("string"),
CaCertificateId: pulumi.String("string"),
MaxConnections: pulumi.Int(0),
PersistenceTimeout: pulumi.Int(0),
PersistenceType: pulumi.String("string"),
Bandwidth: pulumi.Int(0),
AclType: pulumi.String("string"),
ProxyConnectTimeout: pulumi.Int(0),
ProxyProtocolType: pulumi.String("string"),
ProxyReadTimeout: pulumi.Int(0),
ProxySendTimeout: pulumi.Int(0),
Scheduler: pulumi.String("string"),
SecurityPolicyId: pulumi.String("string"),
SendTimeout: pulumi.Int(0),
AclStatus: pulumi.String("string"),
StartPort: pulumi.Int(0),
Tags: clb.ListenerTagArray{
&clb.ListenerTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
})
var volcengineccListenerResource = new com.volcengine.volcenginecc.clb.Listener("volcengineccListenerResource", com.volcengine.volcenginecc.clb.ListenerArgs.builder()
.loadBalancerId("string")
.serverGroupId("string")
.protocol("string")
.port(0)
.clientBodyTimeout(0)
.keepaliveTimeout(0)
.certCenterCertificateId("string")
.certificateId("string")
.certificateSource("string")
.aclIds("string")
.clientHeaderTimeout(0)
.connectionDrainEnabled("string")
.connectionDrainTimeout(0)
.cookie("string")
.cps(0)
.description("string")
.enabled("string")
.endPort(0)
.establishedTimeout(0)
.healthCheck(ListenerHealthCheckArgs.builder()
.domain("string")
.enabled("string")
.healthyThreshold(0)
.httpCode("string")
.interval(0)
.method("string")
.port(0)
.timeout(0)
.udpExpect("string")
.udpRequest("string")
.unhealthyThreshold(0)
.uri("string")
.build())
.http2Enabled("string")
.caEnabled("string")
.listenerName("string")
.caCertificateId("string")
.maxConnections(0)
.persistenceTimeout(0)
.persistenceType("string")
.bandwidth(0)
.aclType("string")
.proxyConnectTimeout(0)
.proxyProtocolType("string")
.proxyReadTimeout(0)
.proxySendTimeout(0)
.scheduler("string")
.securityPolicyId("string")
.sendTimeout(0)
.aclStatus("string")
.startPort(0)
.tags(ListenerTagArgs.builder()
.key("string")
.value("string")
.build())
.build());
volcenginecc_listener_resource = volcenginecc.clb.Listener("volcengineccListenerResource",
load_balancer_id="string",
server_group_id="string",
protocol="string",
port=0,
client_body_timeout=0,
keepalive_timeout=0,
cert_center_certificate_id="string",
certificate_id="string",
certificate_source="string",
acl_ids=["string"],
client_header_timeout=0,
connection_drain_enabled="string",
connection_drain_timeout=0,
cookie="string",
cps=0,
description="string",
enabled="string",
end_port=0,
established_timeout=0,
health_check={
"domain": "string",
"enabled": "string",
"healthy_threshold": 0,
"http_code": "string",
"interval": 0,
"method": "string",
"port": 0,
"timeout": 0,
"udp_expect": "string",
"udp_request": "string",
"unhealthy_threshold": 0,
"uri": "string",
},
http2_enabled="string",
ca_enabled="string",
listener_name="string",
ca_certificate_id="string",
max_connections=0,
persistence_timeout=0,
persistence_type="string",
bandwidth=0,
acl_type="string",
proxy_connect_timeout=0,
proxy_protocol_type="string",
proxy_read_timeout=0,
proxy_send_timeout=0,
scheduler="string",
security_policy_id="string",
send_timeout=0,
acl_status="string",
start_port=0,
tags=[{
"key": "string",
"value": "string",
}])
const volcengineccListenerResource = new volcenginecc.clb.Listener("volcengineccListenerResource", {
loadBalancerId: "string",
serverGroupId: "string",
protocol: "string",
port: 0,
clientBodyTimeout: 0,
keepaliveTimeout: 0,
certCenterCertificateId: "string",
certificateId: "string",
certificateSource: "string",
aclIds: ["string"],
clientHeaderTimeout: 0,
connectionDrainEnabled: "string",
connectionDrainTimeout: 0,
cookie: "string",
cps: 0,
description: "string",
enabled: "string",
endPort: 0,
establishedTimeout: 0,
healthCheck: {
domain: "string",
enabled: "string",
healthyThreshold: 0,
httpCode: "string",
interval: 0,
method: "string",
port: 0,
timeout: 0,
udpExpect: "string",
udpRequest: "string",
unhealthyThreshold: 0,
uri: "string",
},
http2Enabled: "string",
caEnabled: "string",
listenerName: "string",
caCertificateId: "string",
maxConnections: 0,
persistenceTimeout: 0,
persistenceType: "string",
bandwidth: 0,
aclType: "string",
proxyConnectTimeout: 0,
proxyProtocolType: "string",
proxyReadTimeout: 0,
proxySendTimeout: 0,
scheduler: "string",
securityPolicyId: "string",
sendTimeout: 0,
aclStatus: "string",
startPort: 0,
tags: [{
key: "string",
value: "string",
}],
});
type: volcenginecc:clb:Listener
properties:
aclIds:
- string
aclStatus: string
aclType: string
bandwidth: 0
caCertificateId: string
caEnabled: string
certCenterCertificateId: string
certificateId: string
certificateSource: string
clientBodyTimeout: 0
clientHeaderTimeout: 0
connectionDrainEnabled: string
connectionDrainTimeout: 0
cookie: string
cps: 0
description: string
enabled: string
endPort: 0
establishedTimeout: 0
healthCheck:
domain: string
enabled: string
healthyThreshold: 0
httpCode: string
interval: 0
method: string
port: 0
timeout: 0
udpExpect: string
udpRequest: string
unhealthyThreshold: 0
uri: string
http2Enabled: string
keepaliveTimeout: 0
listenerName: string
loadBalancerId: string
maxConnections: 0
persistenceTimeout: 0
persistenceType: string
port: 0
protocol: string
proxyConnectTimeout: 0
proxyProtocolType: string
proxyReadTimeout: 0
proxySendTimeout: 0
scheduler: string
securityPolicyId: string
sendTimeout: 0
serverGroupId: string
startPort: 0
tags:
- key: string
value: string
Listener Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Listener resource accepts the following input properties:
- Load
Balancer stringId - CLB实例的ID。
- Port int
- 监听器接收请求使用的端口。取值范围为 0~65535。参数Protocol为“TCP”或“UDP”时,支持传入0,表示用全端口监听。
- Protocol string
- 监听器的协议。
- Server
Group stringId - 监听器关联的后端服务器组 ID。
- Acl
Ids List<string> - 监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
- Acl
Status string - 是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
- Acl
Type string - 访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
- Bandwidth int
- 监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
- Ca
Certificate stringId - 双向认证的CA证书。
- Ca
Enabled string - 是否开启双向认证。on:开启。off(默认值):不开启。
- Cert
Center stringCertificate Id - 证书中心的证书的ID。
- Certificate
Id string - CLB侧证书管理模块的证书的ID。
- Certificate
Source string - 证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
- Client
Body intTimeout - 读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
- Client
Header intTimeout - 读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Connection
Drain stringEnabled - 监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
- Connection
Drain intTimeout - 连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
- string
- 后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
- Cps int
- 每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
- Description string
- 监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
- Enabled string
- 是否启用监听器。on(默认值):开启。off:不开启。
- End
Port int - 全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
- Established
Timeout int - 监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
- Health
Check Volcengine.Listener Health Check - 健康检查相关信息。
- Http2Enabled string
- 监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
- Keepalive
Timeout int - 客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Listener
Name string - 监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
- Max
Connections int - 最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
- Persistence
Timeout int - 会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
- Persistence
Type string - 会话保持的类型。取值如下:off(默认值):不启用会话保持。source_ip:源地址IP,仅参数ProtocolTCP或UDP时,本取值有效。insert:植入Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。server:重写Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。。
- Proxy
Connect intTimeout - CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Proxy
Protocol stringType - 是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
- Proxy
Read intTimeout - CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Proxy
Send intTimeout - CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Scheduler string
- 监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
- Security
Policy stringId - HTTPS监听器的TLS安全策略。仅参数Protocol取HTTPS时,本参数有效。 取值如下:defaultpolicy(默认值):支持SSL v3、TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy10:支持TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy11:支持TLS v1.1、TLS v1.2。tlscipherpolicy12:支持TLS v1.2。tlscipherpolicy12strict:支持TLS v1.2。
- Send
Timeout int - CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Start
Port int - 全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
-
List<Volcengine.
Listener Tag>
- Load
Balancer stringId - CLB实例的ID。
- Port int
- 监听器接收请求使用的端口。取值范围为 0~65535。参数Protocol为“TCP”或“UDP”时,支持传入0,表示用全端口监听。
- Protocol string
- 监听器的协议。
- Server
Group stringId - 监听器关联的后端服务器组 ID。
- Acl
Ids []string - 监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
- Acl
Status string - 是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
- Acl
Type string - 访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
- Bandwidth int
- 监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
- Ca
Certificate stringId - 双向认证的CA证书。
- Ca
Enabled string - 是否开启双向认证。on:开启。off(默认值):不开启。
- Cert
Center stringCertificate Id - 证书中心的证书的ID。
- Certificate
Id string - CLB侧证书管理模块的证书的ID。
- Certificate
Source string - 证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
- Client
Body intTimeout - 读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
- Client
Header intTimeout - 读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Connection
Drain stringEnabled - 监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
- Connection
Drain intTimeout - 连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
- string
- 后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
- Cps int
- 每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
- Description string
- 监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
- Enabled string
- 是否启用监听器。on(默认值):开启。off:不开启。
- End
Port int - 全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
- Established
Timeout int - 监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
- Health
Check ListenerHealth Check Args - 健康检查相关信息。
- Http2Enabled string
- 监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
- Keepalive
Timeout int - 客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Listener
Name string - 监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
- Max
Connections int - 最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
- Persistence
Timeout int - 会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
- Persistence
Type string - 会话保持的类型。取值如下:off(默认值):不启用会话保持。source_ip:源地址IP,仅参数ProtocolTCP或UDP时,本取值有效。insert:植入Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。server:重写Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。。
- Proxy
Connect intTimeout - CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Proxy
Protocol stringType - 是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
- Proxy
Read intTimeout - CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Proxy
Send intTimeout - CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Scheduler string
- 监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
- Security
Policy stringId - HTTPS监听器的TLS安全策略。仅参数Protocol取HTTPS时,本参数有效。 取值如下:defaultpolicy(默认值):支持SSL v3、TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy10:支持TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy11:支持TLS v1.1、TLS v1.2。tlscipherpolicy12:支持TLS v1.2。tlscipherpolicy12strict:支持TLS v1.2。
- Send
Timeout int - CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Start
Port int - 全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
-
[]Listener
Tag Args
- load
Balancer StringId - CLB实例的ID。
- port Integer
- 监听器接收请求使用的端口。取值范围为 0~65535。参数Protocol为“TCP”或“UDP”时,支持传入0,表示用全端口监听。
- protocol String
- 监听器的协议。
- server
Group StringId - 监听器关联的后端服务器组 ID。
- acl
Ids List<String> - 监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
- acl
Status String - 是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
- acl
Type String - 访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
- bandwidth Integer
- 监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
- ca
Certificate StringId - 双向认证的CA证书。
- ca
Enabled String - 是否开启双向认证。on:开启。off(默认值):不开启。
- cert
Center StringCertificate Id - 证书中心的证书的ID。
- certificate
Id String - CLB侧证书管理模块的证书的ID。
- certificate
Source String - 证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
- client
Body IntegerTimeout - 读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
- client
Header IntegerTimeout - 读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- connection
Drain StringEnabled - 监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
- connection
Drain IntegerTimeout - 连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
- String
- 后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
- cps Integer
- 每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
- description String
- 监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
- enabled String
- 是否启用监听器。on(默认值):开启。off:不开启。
- end
Port Integer - 全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
- established
Timeout Integer - 监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
- health
Check ListenerHealth Check - 健康检查相关信息。
- http2Enabled String
- 监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
- keepalive
Timeout Integer - 客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- listener
Name String - 监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
- max
Connections Integer - 最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
- persistence
Timeout Integer - 会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
- persistence
Type String - 会话保持的类型。取值如下:off(默认值):不启用会话保持。source_ip:源地址IP,仅参数ProtocolTCP或UDP时,本取值有效。insert:植入Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。server:重写Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。。
- proxy
Connect IntegerTimeout - CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- proxy
Protocol StringType - 是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
- proxy
Read IntegerTimeout - CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- proxy
Send IntegerTimeout - CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- scheduler String
- 监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
- security
Policy StringId - HTTPS监听器的TLS安全策略。仅参数Protocol取HTTPS时,本参数有效。 取值如下:defaultpolicy(默认值):支持SSL v3、TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy10:支持TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy11:支持TLS v1.1、TLS v1.2。tlscipherpolicy12:支持TLS v1.2。tlscipherpolicy12strict:支持TLS v1.2。
- send
Timeout Integer - CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- start
Port Integer - 全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
-
List<Listener
Tag>
- load
Balancer stringId - CLB实例的ID。
- port number
- 监听器接收请求使用的端口。取值范围为 0~65535。参数Protocol为“TCP”或“UDP”时,支持传入0,表示用全端口监听。
- protocol string
- 监听器的协议。
- server
Group stringId - 监听器关联的后端服务器组 ID。
- acl
Ids string[] - 监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
- acl
Status string - 是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
- acl
Type string - 访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
- bandwidth number
- 监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
- ca
Certificate stringId - 双向认证的CA证书。
- ca
Enabled string - 是否开启双向认证。on:开启。off(默认值):不开启。
- cert
Center stringCertificate Id - 证书中心的证书的ID。
- certificate
Id string - CLB侧证书管理模块的证书的ID。
- certificate
Source string - 证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
- client
Body numberTimeout - 读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
- client
Header numberTimeout - 读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- connection
Drain stringEnabled - 监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
- connection
Drain numberTimeout - 连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
- string
- 后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
- cps number
- 每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
- description string
- 监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
- enabled string
- 是否启用监听器。on(默认值):开启。off:不开启。
- end
Port number - 全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
- established
Timeout number - 监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
- health
Check ListenerHealth Check - 健康检查相关信息。
- http2Enabled string
- 监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
- keepalive
Timeout number - 客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- listener
Name string - 监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
- max
Connections number - 最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
- persistence
Timeout number - 会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
- persistence
Type string - 会话保持的类型。取值如下:off(默认值):不启用会话保持。source_ip:源地址IP,仅参数ProtocolTCP或UDP时,本取值有效。insert:植入Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。server:重写Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。。
- proxy
Connect numberTimeout - CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- proxy
Protocol stringType - 是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
- proxy
Read numberTimeout - CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- proxy
Send numberTimeout - CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- scheduler string
- 监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
- security
Policy stringId - HTTPS监听器的TLS安全策略。仅参数Protocol取HTTPS时,本参数有效。 取值如下:defaultpolicy(默认值):支持SSL v3、TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy10:支持TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy11:支持TLS v1.1、TLS v1.2。tlscipherpolicy12:支持TLS v1.2。tlscipherpolicy12strict:支持TLS v1.2。
- send
Timeout number - CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- start
Port number - 全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
-
Listener
Tag[]
- load_
balancer_ strid - CLB实例的ID。
- port int
- 监听器接收请求使用的端口。取值范围为 0~65535。参数Protocol为“TCP”或“UDP”时,支持传入0,表示用全端口监听。
- protocol str
- 监听器的协议。
- server_
group_ strid - 监听器关联的后端服务器组 ID。
- acl_
ids Sequence[str] - 监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
- acl_
status str - 是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
- acl_
type str - 访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
- bandwidth int
- 监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
- ca_
certificate_ strid - 双向认证的CA证书。
- ca_
enabled str - 是否开启双向认证。on:开启。off(默认值):不开启。
- cert_
center_ strcertificate_ id - 证书中心的证书的ID。
- certificate_
id str - CLB侧证书管理模块的证书的ID。
- certificate_
source str - 证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
- client_
body_ inttimeout - 读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
- client_
header_ inttimeout - 读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- connection_
drain_ strenabled - 监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
- connection_
drain_ inttimeout - 连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
- str
- 后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
- cps int
- 每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
- description str
- 监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
- enabled str
- 是否启用监听器。on(默认值):开启。off:不开启。
- end_
port int - 全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
- established_
timeout int - 监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
- health_
check ListenerHealth Check Args - 健康检查相关信息。
- http2_
enabled str - 监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
- keepalive_
timeout int - 客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- listener_
name str - 监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
- max_
connections int - 最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
- persistence_
timeout int - 会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
- persistence_
type str - 会话保持的类型。取值如下:off(默认值):不启用会话保持。source_ip:源地址IP,仅参数ProtocolTCP或UDP时,本取值有效。insert:植入Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。server:重写Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。。
- proxy_
connect_ inttimeout - CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- proxy_
protocol_ strtype - 是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
- proxy_
read_ inttimeout - CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- proxy_
send_ inttimeout - CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- scheduler str
- 监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
- security_
policy_ strid - HTTPS监听器的TLS安全策略。仅参数Protocol取HTTPS时,本参数有效。 取值如下:defaultpolicy(默认值):支持SSL v3、TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy10:支持TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy11:支持TLS v1.1、TLS v1.2。tlscipherpolicy12:支持TLS v1.2。tlscipherpolicy12strict:支持TLS v1.2。
- send_
timeout int - CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- start_
port int - 全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
-
Sequence[Listener
Tag Args]
- load
Balancer StringId - CLB实例的ID。
- port Number
- 监听器接收请求使用的端口。取值范围为 0~65535。参数Protocol为“TCP”或“UDP”时,支持传入0,表示用全端口监听。
- protocol String
- 监听器的协议。
- server
Group StringId - 监听器关联的后端服务器组 ID。
- acl
Ids List<String> - 监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
- acl
Status String - 是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
- acl
Type String - 访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
- bandwidth Number
- 监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
- ca
Certificate StringId - 双向认证的CA证书。
- ca
Enabled String - 是否开启双向认证。on:开启。off(默认值):不开启。
- cert
Center StringCertificate Id - 证书中心的证书的ID。
- certificate
Id String - CLB侧证书管理模块的证书的ID。
- certificate
Source String - 证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
- client
Body NumberTimeout - 读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
- client
Header NumberTimeout - 读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- connection
Drain StringEnabled - 监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
- connection
Drain NumberTimeout - 连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
- String
- 后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
- cps Number
- 每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
- description String
- 监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
- enabled String
- 是否启用监听器。on(默认值):开启。off:不开启。
- end
Port Number - 全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
- established
Timeout Number - 监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
- health
Check Property Map - 健康检查相关信息。
- http2Enabled String
- 监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
- keepalive
Timeout Number - 客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- listener
Name String - 监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
- max
Connections Number - 最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
- persistence
Timeout Number - 会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
- persistence
Type String - 会话保持的类型。取值如下:off(默认值):不启用会话保持。source_ip:源地址IP,仅参数ProtocolTCP或UDP时,本取值有效。insert:植入Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。server:重写Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。。
- proxy
Connect NumberTimeout - CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- proxy
Protocol StringType - 是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
- proxy
Read NumberTimeout - CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- proxy
Send NumberTimeout - CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- scheduler String
- 监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
- security
Policy StringId - HTTPS监听器的TLS安全策略。仅参数Protocol取HTTPS时,本参数有效。 取值如下:defaultpolicy(默认值):支持SSL v3、TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy10:支持TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy11:支持TLS v1.1、TLS v1.2。tlscipherpolicy12:支持TLS v1.2。tlscipherpolicy12strict:支持TLS v1.2。
- send
Timeout Number - CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- start
Port Number - 全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
- List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the Listener resource produces the following output properties:
- Created
Time string - 监听器的创建时间。
- Id string
- The provider-assigned unique ID for this managed resource.
- Listener
Id string - 监听器的ID。
- Status string
- 监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
- Updated
Time string - 监听器最近一次的操作时间。
- Waf
Protection stringEnabled - 是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。
- Created
Time string - 监听器的创建时间。
- Id string
- The provider-assigned unique ID for this managed resource.
- Listener
Id string - 监听器的ID。
- Status string
- 监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
- Updated
Time string - 监听器最近一次的操作时间。
- Waf
Protection stringEnabled - 是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。
- created
Time String - 监听器的创建时间。
- id String
- The provider-assigned unique ID for this managed resource.
- listener
Id String - 监听器的ID。
- status String
- 监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
- updated
Time String - 监听器最近一次的操作时间。
- waf
Protection StringEnabled - 是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。
- created
Time string - 监听器的创建时间。
- id string
- The provider-assigned unique ID for this managed resource.
- listener
Id string - 监听器的ID。
- status string
- 监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
- updated
Time string - 监听器最近一次的操作时间。
- waf
Protection stringEnabled - 是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。
- created_
time str - 监听器的创建时间。
- id str
- The provider-assigned unique ID for this managed resource.
- listener_
id str - 监听器的ID。
- status str
- 监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
- updated_
time str - 监听器最近一次的操作时间。
- waf_
protection_ strenabled - 是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。
- created
Time String - 监听器的创建时间。
- id String
- The provider-assigned unique ID for this managed resource.
- listener
Id String - 监听器的ID。
- status String
- 监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
- updated
Time String - 监听器最近一次的操作时间。
- waf
Protection StringEnabled - 是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。
Look up Existing Listener Resource
Get an existing Listener resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ListenerState, opts?: CustomResourceOptions): Listener@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
acl_ids: Optional[Sequence[str]] = None,
acl_status: Optional[str] = None,
acl_type: Optional[str] = None,
bandwidth: Optional[int] = None,
ca_certificate_id: Optional[str] = None,
ca_enabled: Optional[str] = None,
cert_center_certificate_id: Optional[str] = None,
certificate_id: Optional[str] = None,
certificate_source: Optional[str] = None,
client_body_timeout: Optional[int] = None,
client_header_timeout: Optional[int] = None,
connection_drain_enabled: Optional[str] = None,
connection_drain_timeout: Optional[int] = None,
cookie: Optional[str] = None,
cps: Optional[int] = None,
created_time: Optional[str] = None,
description: Optional[str] = None,
enabled: Optional[str] = None,
end_port: Optional[int] = None,
established_timeout: Optional[int] = None,
health_check: Optional[ListenerHealthCheckArgs] = None,
http2_enabled: Optional[str] = None,
keepalive_timeout: Optional[int] = None,
listener_id: Optional[str] = None,
listener_name: Optional[str] = None,
load_balancer_id: Optional[str] = None,
max_connections: Optional[int] = None,
persistence_timeout: Optional[int] = None,
persistence_type: Optional[str] = None,
port: Optional[int] = None,
protocol: Optional[str] = None,
proxy_connect_timeout: Optional[int] = None,
proxy_protocol_type: Optional[str] = None,
proxy_read_timeout: Optional[int] = None,
proxy_send_timeout: Optional[int] = None,
scheduler: Optional[str] = None,
security_policy_id: Optional[str] = None,
send_timeout: Optional[int] = None,
server_group_id: Optional[str] = None,
start_port: Optional[int] = None,
status: Optional[str] = None,
tags: Optional[Sequence[ListenerTagArgs]] = None,
updated_time: Optional[str] = None,
waf_protection_enabled: Optional[str] = None) -> Listenerfunc GetListener(ctx *Context, name string, id IDInput, state *ListenerState, opts ...ResourceOption) (*Listener, error)public static Listener Get(string name, Input<string> id, ListenerState? state, CustomResourceOptions? opts = null)public static Listener get(String name, Output<String> id, ListenerState state, CustomResourceOptions options)resources: _: type: volcenginecc:clb:Listener get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Acl
Ids List<string> - 监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
- Acl
Status string - 是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
- Acl
Type string - 访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
- Bandwidth int
- 监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
- Ca
Certificate stringId - 双向认证的CA证书。
- Ca
Enabled string - 是否开启双向认证。on:开启。off(默认值):不开启。
- Cert
Center stringCertificate Id - 证书中心的证书的ID。
- Certificate
Id string - CLB侧证书管理模块的证书的ID。
- Certificate
Source string - 证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
- Client
Body intTimeout - 读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
- Client
Header intTimeout - 读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Connection
Drain stringEnabled - 监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
- Connection
Drain intTimeout - 连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
- string
- 后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
- Cps int
- 每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
- Created
Time string - 监听器的创建时间。
- Description string
- 监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
- Enabled string
- 是否启用监听器。on(默认值):开启。off:不开启。
- End
Port int - 全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
- Established
Timeout int - 监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
- Health
Check Volcengine.Listener Health Check - 健康检查相关信息。
- Http2Enabled string
- 监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
- Keepalive
Timeout int - 客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Listener
Id string - 监听器的ID。
- Listener
Name string - 监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
- Load
Balancer stringId - CLB实例的ID。
- Max
Connections int - 最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
- Persistence
Timeout int - 会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
- Persistence
Type string - 会话保持的类型。取值如下:off(默认值):不启用会话保持。source_ip:源地址IP,仅参数ProtocolTCP或UDP时,本取值有效。insert:植入Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。server:重写Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。。
- Port int
- 监听器接收请求使用的端口。取值范围为 0~65535。参数Protocol为“TCP”或“UDP”时,支持传入0,表示用全端口监听。
- Protocol string
- 监听器的协议。
- Proxy
Connect intTimeout - CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Proxy
Protocol stringType - 是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
- Proxy
Read intTimeout - CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Proxy
Send intTimeout - CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Scheduler string
- 监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
- Security
Policy stringId - HTTPS监听器的TLS安全策略。仅参数Protocol取HTTPS时,本参数有效。 取值如下:defaultpolicy(默认值):支持SSL v3、TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy10:支持TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy11:支持TLS v1.1、TLS v1.2。tlscipherpolicy12:支持TLS v1.2。tlscipherpolicy12strict:支持TLS v1.2。
- Send
Timeout int - CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Server
Group stringId - 监听器关联的后端服务器组 ID。
- Start
Port int - 全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
- Status string
- 监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
-
List<Volcengine.
Listener Tag> - Updated
Time string - 监听器最近一次的操作时间。
- Waf
Protection stringEnabled - 是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。
- Acl
Ids []string - 监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
- Acl
Status string - 是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
- Acl
Type string - 访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
- Bandwidth int
- 监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
- Ca
Certificate stringId - 双向认证的CA证书。
- Ca
Enabled string - 是否开启双向认证。on:开启。off(默认值):不开启。
- Cert
Center stringCertificate Id - 证书中心的证书的ID。
- Certificate
Id string - CLB侧证书管理模块的证书的ID。
- Certificate
Source string - 证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
- Client
Body intTimeout - 读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
- Client
Header intTimeout - 读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Connection
Drain stringEnabled - 监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
- Connection
Drain intTimeout - 连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
- string
- 后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
- Cps int
- 每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
- Created
Time string - 监听器的创建时间。
- Description string
- 监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
- Enabled string
- 是否启用监听器。on(默认值):开启。off:不开启。
- End
Port int - 全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
- Established
Timeout int - 监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
- Health
Check ListenerHealth Check Args - 健康检查相关信息。
- Http2Enabled string
- 监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
- Keepalive
Timeout int - 客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Listener
Id string - 监听器的ID。
- Listener
Name string - 监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
- Load
Balancer stringId - CLB实例的ID。
- Max
Connections int - 最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
- Persistence
Timeout int - 会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
- Persistence
Type string - 会话保持的类型。取值如下:off(默认值):不启用会话保持。source_ip:源地址IP,仅参数ProtocolTCP或UDP时,本取值有效。insert:植入Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。server:重写Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。。
- Port int
- 监听器接收请求使用的端口。取值范围为 0~65535。参数Protocol为“TCP”或“UDP”时,支持传入0,表示用全端口监听。
- Protocol string
- 监听器的协议。
- Proxy
Connect intTimeout - CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Proxy
Protocol stringType - 是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
- Proxy
Read intTimeout - CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Proxy
Send intTimeout - CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Scheduler string
- 监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
- Security
Policy stringId - HTTPS监听器的TLS安全策略。仅参数Protocol取HTTPS时,本参数有效。 取值如下:defaultpolicy(默认值):支持SSL v3、TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy10:支持TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy11:支持TLS v1.1、TLS v1.2。tlscipherpolicy12:支持TLS v1.2。tlscipherpolicy12strict:支持TLS v1.2。
- Send
Timeout int - CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- Server
Group stringId - 监听器关联的后端服务器组 ID。
- Start
Port int - 全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
- Status string
- 监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
-
[]Listener
Tag Args - Updated
Time string - 监听器最近一次的操作时间。
- Waf
Protection stringEnabled - 是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。
- acl
Ids List<String> - 监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
- acl
Status String - 是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
- acl
Type String - 访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
- bandwidth Integer
- 监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
- ca
Certificate StringId - 双向认证的CA证书。
- ca
Enabled String - 是否开启双向认证。on:开启。off(默认值):不开启。
- cert
Center StringCertificate Id - 证书中心的证书的ID。
- certificate
Id String - CLB侧证书管理模块的证书的ID。
- certificate
Source String - 证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
- client
Body IntegerTimeout - 读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
- client
Header IntegerTimeout - 读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- connection
Drain StringEnabled - 监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
- connection
Drain IntegerTimeout - 连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
- String
- 后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
- cps Integer
- 每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
- created
Time String - 监听器的创建时间。
- description String
- 监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
- enabled String
- 是否启用监听器。on(默认值):开启。off:不开启。
- end
Port Integer - 全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
- established
Timeout Integer - 监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
- health
Check ListenerHealth Check - 健康检查相关信息。
- http2Enabled String
- 监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
- keepalive
Timeout Integer - 客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- listener
Id String - 监听器的ID。
- listener
Name String - 监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
- load
Balancer StringId - CLB实例的ID。
- max
Connections Integer - 最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
- persistence
Timeout Integer - 会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
- persistence
Type String - 会话保持的类型。取值如下:off(默认值):不启用会话保持。source_ip:源地址IP,仅参数ProtocolTCP或UDP时,本取值有效。insert:植入Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。server:重写Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。。
- port Integer
- 监听器接收请求使用的端口。取值范围为 0~65535。参数Protocol为“TCP”或“UDP”时,支持传入0,表示用全端口监听。
- protocol String
- 监听器的协议。
- proxy
Connect IntegerTimeout - CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- proxy
Protocol StringType - 是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
- proxy
Read IntegerTimeout - CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- proxy
Send IntegerTimeout - CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- scheduler String
- 监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
- security
Policy StringId - HTTPS监听器的TLS安全策略。仅参数Protocol取HTTPS时,本参数有效。 取值如下:defaultpolicy(默认值):支持SSL v3、TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy10:支持TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy11:支持TLS v1.1、TLS v1.2。tlscipherpolicy12:支持TLS v1.2。tlscipherpolicy12strict:支持TLS v1.2。
- send
Timeout Integer - CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- server
Group StringId - 监听器关联的后端服务器组 ID。
- start
Port Integer - 全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
- status String
- 监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
-
List<Listener
Tag> - updated
Time String - 监听器最近一次的操作时间。
- waf
Protection StringEnabled - 是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。
- acl
Ids string[] - 监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
- acl
Status string - 是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
- acl
Type string - 访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
- bandwidth number
- 监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
- ca
Certificate stringId - 双向认证的CA证书。
- ca
Enabled string - 是否开启双向认证。on:开启。off(默认值):不开启。
- cert
Center stringCertificate Id - 证书中心的证书的ID。
- certificate
Id string - CLB侧证书管理模块的证书的ID。
- certificate
Source string - 证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
- client
Body numberTimeout - 读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
- client
Header numberTimeout - 读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- connection
Drain stringEnabled - 监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
- connection
Drain numberTimeout - 连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
- string
- 后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
- cps number
- 每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
- created
Time string - 监听器的创建时间。
- description string
- 监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
- enabled string
- 是否启用监听器。on(默认值):开启。off:不开启。
- end
Port number - 全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
- established
Timeout number - 监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
- health
Check ListenerHealth Check - 健康检查相关信息。
- http2Enabled string
- 监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
- keepalive
Timeout number - 客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- listener
Id string - 监听器的ID。
- listener
Name string - 监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
- load
Balancer stringId - CLB实例的ID。
- max
Connections number - 最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
- persistence
Timeout number - 会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
- persistence
Type string - 会话保持的类型。取值如下:off(默认值):不启用会话保持。source_ip:源地址IP,仅参数ProtocolTCP或UDP时,本取值有效。insert:植入Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。server:重写Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。。
- port number
- 监听器接收请求使用的端口。取值范围为 0~65535。参数Protocol为“TCP”或“UDP”时,支持传入0,表示用全端口监听。
- protocol string
- 监听器的协议。
- proxy
Connect numberTimeout - CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- proxy
Protocol stringType - 是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
- proxy
Read numberTimeout - CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- proxy
Send numberTimeout - CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- scheduler string
- 监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
- security
Policy stringId - HTTPS监听器的TLS安全策略。仅参数Protocol取HTTPS时,本参数有效。 取值如下:defaultpolicy(默认值):支持SSL v3、TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy10:支持TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy11:支持TLS v1.1、TLS v1.2。tlscipherpolicy12:支持TLS v1.2。tlscipherpolicy12strict:支持TLS v1.2。
- send
Timeout number - CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- server
Group stringId - 监听器关联的后端服务器组 ID。
- start
Port number - 全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
- status string
- 监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
-
Listener
Tag[] - updated
Time string - 监听器最近一次的操作时间。
- waf
Protection stringEnabled - 是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。
- acl_
ids Sequence[str] - 监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
- acl_
status str - 是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
- acl_
type str - 访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
- bandwidth int
- 监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
- ca_
certificate_ strid - 双向认证的CA证书。
- ca_
enabled str - 是否开启双向认证。on:开启。off(默认值):不开启。
- cert_
center_ strcertificate_ id - 证书中心的证书的ID。
- certificate_
id str - CLB侧证书管理模块的证书的ID。
- certificate_
source str - 证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
- client_
body_ inttimeout - 读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
- client_
header_ inttimeout - 读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- connection_
drain_ strenabled - 监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
- connection_
drain_ inttimeout - 连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
- str
- 后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
- cps int
- 每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
- created_
time str - 监听器的创建时间。
- description str
- 监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
- enabled str
- 是否启用监听器。on(默认值):开启。off:不开启。
- end_
port int - 全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
- established_
timeout int - 监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
- health_
check ListenerHealth Check Args - 健康检查相关信息。
- http2_
enabled str - 监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
- keepalive_
timeout int - 客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- listener_
id str - 监听器的ID。
- listener_
name str - 监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
- load_
balancer_ strid - CLB实例的ID。
- max_
connections int - 最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
- persistence_
timeout int - 会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
- persistence_
type str - 会话保持的类型。取值如下:off(默认值):不启用会话保持。source_ip:源地址IP,仅参数ProtocolTCP或UDP时,本取值有效。insert:植入Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。server:重写Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。。
- port int
- 监听器接收请求使用的端口。取值范围为 0~65535。参数Protocol为“TCP”或“UDP”时,支持传入0,表示用全端口监听。
- protocol str
- 监听器的协议。
- proxy_
connect_ inttimeout - CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- proxy_
protocol_ strtype - 是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
- proxy_
read_ inttimeout - CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- proxy_
send_ inttimeout - CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- scheduler str
- 监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
- security_
policy_ strid - HTTPS监听器的TLS安全策略。仅参数Protocol取HTTPS时,本参数有效。 取值如下:defaultpolicy(默认值):支持SSL v3、TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy10:支持TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy11:支持TLS v1.1、TLS v1.2。tlscipherpolicy12:支持TLS v1.2。tlscipherpolicy12strict:支持TLS v1.2。
- send_
timeout int - CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- server_
group_ strid - 监听器关联的后端服务器组 ID。
- start_
port int - 全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
- status str
- 监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
-
Sequence[Listener
Tag Args] - updated_
time str - 监听器最近一次的操作时间。
- waf_
protection_ strenabled - 是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。
- acl
Ids List<String> - 监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
- acl
Status String - 是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
- acl
Type String - 访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
- bandwidth Number
- 监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
- ca
Certificate StringId - 双向认证的CA证书。
- ca
Enabled String - 是否开启双向认证。on:开启。off(默认值):不开启。
- cert
Center StringCertificate Id - 证书中心的证书的ID。
- certificate
Id String - CLB侧证书管理模块的证书的ID。
- certificate
Source String - 证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
- client
Body NumberTimeout - 读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
- client
Header NumberTimeout - 读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- connection
Drain StringEnabled - 监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
- connection
Drain NumberTimeout - 连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
- String
- 后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
- cps Number
- 每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
- created
Time String - 监听器的创建时间。
- description String
- 监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
- enabled String
- 是否启用监听器。on(默认值):开启。off:不开启。
- end
Port Number - 全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
- established
Timeout Number - 监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
- health
Check Property Map - 健康检查相关信息。
- http2Enabled String
- 监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
- keepalive
Timeout Number - 客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- listener
Id String - 监听器的ID。
- listener
Name String - 监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
- load
Balancer StringId - CLB实例的ID。
- max
Connections Number - 最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
- persistence
Timeout Number - 会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
- persistence
Type String - 会话保持的类型。取值如下:off(默认值):不启用会话保持。source_ip:源地址IP,仅参数ProtocolTCP或UDP时,本取值有效。insert:植入Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。server:重写Cookie,仅参数Protocol取HTTP或HTTPS且Scheduler取wrr时,本取值生效。。
- port Number
- 监听器接收请求使用的端口。取值范围为 0~65535。参数Protocol为“TCP”或“UDP”时,支持传入0,表示用全端口监听。
- protocol String
- 监听器的协议。
- proxy
Connect NumberTimeout - CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- proxy
Protocol StringType - 是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
- proxy
Read NumberTimeout - CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- proxy
Send NumberTimeout - CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- scheduler String
- 监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
- security
Policy StringId - HTTPS监听器的TLS安全策略。仅参数Protocol取HTTPS时,本参数有效。 取值如下:defaultpolicy(默认值):支持SSL v3、TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy10:支持TLS v1.0、TLS v1.1、TLS v1.2。tlscipherpolicy11:支持TLS v1.1、TLS v1.2。tlscipherpolicy12:支持TLS v1.2。tlscipherpolicy12strict:支持TLS v1.2。
- send
Timeout Number - CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
- server
Group StringId - 监听器关联的后端服务器组 ID。
- start
Port Number - 全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
- status String
- 监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
- List<Property Map>
- updated
Time String - 监听器最近一次的操作时间。
- waf
Protection StringEnabled - 是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。
Supporting Types
ListenerHealthCheck, ListenerHealthCheckArgs
- Domain string
- 健康检查的域名,需配置为后端服务器上真实对外提供服务的地址。当参数Protocol取HTTP或HTTPS,HealthCheck.Enabled取on时,本参数生效。需至少包含一个点号(.),且不允许以点号(.)开头或结尾。单个字符串由母、数字、中划线(-)、点号(.)字符组成,中划线(-)不得出现在字符串的头部或尾部。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为空,表示CLB使用各后端服务器的私网IP地址进行健康检查。
- Enabled string
- 监听器是否开启健康检查功能。on(默认值):开启。off:不开启。
- Healthy
Threshold int - 健康阈值,即连续健康检查成功的次数。取值范围为2 ~ 10,默认值为3,单位为次。
- Http
Code string - 健康检查正常的HTTP状态码。当参数Protocol取HTTP或HTTPS,且HealthCheck.Enabled取on时,参数生效。取值如下:http2xx (默认值)、http3xx、http4xx、http5xx。多个状态码间用半角逗号“,”分隔。
- Interval int
- 执行健康检查的时间间隔,取值范围为1 ~ 300 ,默认值为2,单位为秒。
- Method string
- 监听器健康检查的方法。GET:服务器需支持GET方法。HEAD:服务器仅返回HEAD头部信息,可以降低后端开销,但要求服务器支持HEAD方法。
- Port int
- 健康检查的端口,取值范围为1-65535。
- Timeout int
- 健康检查的响应超时时间,表示如果后端服务器在指定的时间内没有正确响应,则判定为健康检查“异常”。取值范围为1 ~ 60,默认值为2,单位为秒。
- Udp
Expect string - 健康检查的预期响应字符串。只允许包含字母和数字,最大长度限制为64个字符。当参数Protocol配置UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
- Udp
Request string - 执行健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字。当参数Protocol配置为UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
- Unhealthy
Threshold int - 不健康阈值,即连续健康检查失败的次数。取值范围为2 ~ 10,默认值为3,单位为次。
- Uri string
- 健康检查的路径,需配置为后端服务器上真实对外提供服务的地址。当参数Protocol取HTTP或HTTPS,HealthCheck.Enabled取on时,本参数生效。必须以字符‘/’开头。仅包含字母、数字、中划线(-)、下划线(_)、斜线/)、点号(.)、百分号(%)、英文问号(?)、#、&、等号(=)字符。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为“/”。
- Domain string
- 健康检查的域名,需配置为后端服务器上真实对外提供服务的地址。当参数Protocol取HTTP或HTTPS,HealthCheck.Enabled取on时,本参数生效。需至少包含一个点号(.),且不允许以点号(.)开头或结尾。单个字符串由母、数字、中划线(-)、点号(.)字符组成,中划线(-)不得出现在字符串的头部或尾部。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为空,表示CLB使用各后端服务器的私网IP地址进行健康检查。
- Enabled string
- 监听器是否开启健康检查功能。on(默认值):开启。off:不开启。
- Healthy
Threshold int - 健康阈值,即连续健康检查成功的次数。取值范围为2 ~ 10,默认值为3,单位为次。
- Http
Code string - 健康检查正常的HTTP状态码。当参数Protocol取HTTP或HTTPS,且HealthCheck.Enabled取on时,参数生效。取值如下:http2xx (默认值)、http3xx、http4xx、http5xx。多个状态码间用半角逗号“,”分隔。
- Interval int
- 执行健康检查的时间间隔,取值范围为1 ~ 300 ,默认值为2,单位为秒。
- Method string
- 监听器健康检查的方法。GET:服务器需支持GET方法。HEAD:服务器仅返回HEAD头部信息,可以降低后端开销,但要求服务器支持HEAD方法。
- Port int
- 健康检查的端口,取值范围为1-65535。
- Timeout int
- 健康检查的响应超时时间,表示如果后端服务器在指定的时间内没有正确响应,则判定为健康检查“异常”。取值范围为1 ~ 60,默认值为2,单位为秒。
- Udp
Expect string - 健康检查的预期响应字符串。只允许包含字母和数字,最大长度限制为64个字符。当参数Protocol配置UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
- Udp
Request string - 执行健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字。当参数Protocol配置为UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
- Unhealthy
Threshold int - 不健康阈值,即连续健康检查失败的次数。取值范围为2 ~ 10,默认值为3,单位为次。
- Uri string
- 健康检查的路径,需配置为后端服务器上真实对外提供服务的地址。当参数Protocol取HTTP或HTTPS,HealthCheck.Enabled取on时,本参数生效。必须以字符‘/’开头。仅包含字母、数字、中划线(-)、下划线(_)、斜线/)、点号(.)、百分号(%)、英文问号(?)、#、&、等号(=)字符。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为“/”。
- domain String
- 健康检查的域名,需配置为后端服务器上真实对外提供服务的地址。当参数Protocol取HTTP或HTTPS,HealthCheck.Enabled取on时,本参数生效。需至少包含一个点号(.),且不允许以点号(.)开头或结尾。单个字符串由母、数字、中划线(-)、点号(.)字符组成,中划线(-)不得出现在字符串的头部或尾部。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为空,表示CLB使用各后端服务器的私网IP地址进行健康检查。
- enabled String
- 监听器是否开启健康检查功能。on(默认值):开启。off:不开启。
- healthy
Threshold Integer - 健康阈值,即连续健康检查成功的次数。取值范围为2 ~ 10,默认值为3,单位为次。
- http
Code String - 健康检查正常的HTTP状态码。当参数Protocol取HTTP或HTTPS,且HealthCheck.Enabled取on时,参数生效。取值如下:http2xx (默认值)、http3xx、http4xx、http5xx。多个状态码间用半角逗号“,”分隔。
- interval Integer
- 执行健康检查的时间间隔,取值范围为1 ~ 300 ,默认值为2,单位为秒。
- method String
- 监听器健康检查的方法。GET:服务器需支持GET方法。HEAD:服务器仅返回HEAD头部信息,可以降低后端开销,但要求服务器支持HEAD方法。
- port Integer
- 健康检查的端口,取值范围为1-65535。
- timeout Integer
- 健康检查的响应超时时间,表示如果后端服务器在指定的时间内没有正确响应,则判定为健康检查“异常”。取值范围为1 ~ 60,默认值为2,单位为秒。
- udp
Expect String - 健康检查的预期响应字符串。只允许包含字母和数字,最大长度限制为64个字符。当参数Protocol配置UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
- udp
Request String - 执行健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字。当参数Protocol配置为UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
- unhealthy
Threshold Integer - 不健康阈值,即连续健康检查失败的次数。取值范围为2 ~ 10,默认值为3,单位为次。
- uri String
- 健康检查的路径,需配置为后端服务器上真实对外提供服务的地址。当参数Protocol取HTTP或HTTPS,HealthCheck.Enabled取on时,本参数生效。必须以字符‘/’开头。仅包含字母、数字、中划线(-)、下划线(_)、斜线/)、点号(.)、百分号(%)、英文问号(?)、#、&、等号(=)字符。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为“/”。
- domain string
- 健康检查的域名,需配置为后端服务器上真实对外提供服务的地址。当参数Protocol取HTTP或HTTPS,HealthCheck.Enabled取on时,本参数生效。需至少包含一个点号(.),且不允许以点号(.)开头或结尾。单个字符串由母、数字、中划线(-)、点号(.)字符组成,中划线(-)不得出现在字符串的头部或尾部。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为空,表示CLB使用各后端服务器的私网IP地址进行健康检查。
- enabled string
- 监听器是否开启健康检查功能。on(默认值):开启。off:不开启。
- healthy
Threshold number - 健康阈值,即连续健康检查成功的次数。取值范围为2 ~ 10,默认值为3,单位为次。
- http
Code string - 健康检查正常的HTTP状态码。当参数Protocol取HTTP或HTTPS,且HealthCheck.Enabled取on时,参数生效。取值如下:http2xx (默认值)、http3xx、http4xx、http5xx。多个状态码间用半角逗号“,”分隔。
- interval number
- 执行健康检查的时间间隔,取值范围为1 ~ 300 ,默认值为2,单位为秒。
- method string
- 监听器健康检查的方法。GET:服务器需支持GET方法。HEAD:服务器仅返回HEAD头部信息,可以降低后端开销,但要求服务器支持HEAD方法。
- port number
- 健康检查的端口,取值范围为1-65535。
- timeout number
- 健康检查的响应超时时间,表示如果后端服务器在指定的时间内没有正确响应,则判定为健康检查“异常”。取值范围为1 ~ 60,默认值为2,单位为秒。
- udp
Expect string - 健康检查的预期响应字符串。只允许包含字母和数字,最大长度限制为64个字符。当参数Protocol配置UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
- udp
Request string - 执行健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字。当参数Protocol配置为UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
- unhealthy
Threshold number - 不健康阈值,即连续健康检查失败的次数。取值范围为2 ~ 10,默认值为3,单位为次。
- uri string
- 健康检查的路径,需配置为后端服务器上真实对外提供服务的地址。当参数Protocol取HTTP或HTTPS,HealthCheck.Enabled取on时,本参数生效。必须以字符‘/’开头。仅包含字母、数字、中划线(-)、下划线(_)、斜线/)、点号(.)、百分号(%)、英文问号(?)、#、&、等号(=)字符。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为“/”。
- domain str
- 健康检查的域名,需配置为后端服务器上真实对外提供服务的地址。当参数Protocol取HTTP或HTTPS,HealthCheck.Enabled取on时,本参数生效。需至少包含一个点号(.),且不允许以点号(.)开头或结尾。单个字符串由母、数字、中划线(-)、点号(.)字符组成,中划线(-)不得出现在字符串的头部或尾部。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为空,表示CLB使用各后端服务器的私网IP地址进行健康检查。
- enabled str
- 监听器是否开启健康检查功能。on(默认值):开启。off:不开启。
- healthy_
threshold int - 健康阈值,即连续健康检查成功的次数。取值范围为2 ~ 10,默认值为3,单位为次。
- http_
code str - 健康检查正常的HTTP状态码。当参数Protocol取HTTP或HTTPS,且HealthCheck.Enabled取on时,参数生效。取值如下:http2xx (默认值)、http3xx、http4xx、http5xx。多个状态码间用半角逗号“,”分隔。
- interval int
- 执行健康检查的时间间隔,取值范围为1 ~ 300 ,默认值为2,单位为秒。
- method str
- 监听器健康检查的方法。GET:服务器需支持GET方法。HEAD:服务器仅返回HEAD头部信息,可以降低后端开销,但要求服务器支持HEAD方法。
- port int
- 健康检查的端口,取值范围为1-65535。
- timeout int
- 健康检查的响应超时时间,表示如果后端服务器在指定的时间内没有正确响应,则判定为健康检查“异常”。取值范围为1 ~ 60,默认值为2,单位为秒。
- udp_
expect str - 健康检查的预期响应字符串。只允许包含字母和数字,最大长度限制为64个字符。当参数Protocol配置UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
- udp_
request str - 执行健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字。当参数Protocol配置为UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
- unhealthy_
threshold int - 不健康阈值,即连续健康检查失败的次数。取值范围为2 ~ 10,默认值为3,单位为次。
- uri str
- 健康检查的路径,需配置为后端服务器上真实对外提供服务的地址。当参数Protocol取HTTP或HTTPS,HealthCheck.Enabled取on时,本参数生效。必须以字符‘/’开头。仅包含字母、数字、中划线(-)、下划线(_)、斜线/)、点号(.)、百分号(%)、英文问号(?)、#、&、等号(=)字符。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为“/”。
- domain String
- 健康检查的域名,需配置为后端服务器上真实对外提供服务的地址。当参数Protocol取HTTP或HTTPS,HealthCheck.Enabled取on时,本参数生效。需至少包含一个点号(.),且不允许以点号(.)开头或结尾。单个字符串由母、数字、中划线(-)、点号(.)字符组成,中划线(-)不得出现在字符串的头部或尾部。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为空,表示CLB使用各后端服务器的私网IP地址进行健康检查。
- enabled String
- 监听器是否开启健康检查功能。on(默认值):开启。off:不开启。
- healthy
Threshold Number - 健康阈值,即连续健康检查成功的次数。取值范围为2 ~ 10,默认值为3,单位为次。
- http
Code String - 健康检查正常的HTTP状态码。当参数Protocol取HTTP或HTTPS,且HealthCheck.Enabled取on时,参数生效。取值如下:http2xx (默认值)、http3xx、http4xx、http5xx。多个状态码间用半角逗号“,”分隔。
- interval Number
- 执行健康检查的时间间隔,取值范围为1 ~ 300 ,默认值为2,单位为秒。
- method String
- 监听器健康检查的方法。GET:服务器需支持GET方法。HEAD:服务器仅返回HEAD头部信息,可以降低后端开销,但要求服务器支持HEAD方法。
- port Number
- 健康检查的端口,取值范围为1-65535。
- timeout Number
- 健康检查的响应超时时间,表示如果后端服务器在指定的时间内没有正确响应,则判定为健康检查“异常”。取值范围为1 ~ 60,默认值为2,单位为秒。
- udp
Expect String - 健康检查的预期响应字符串。只允许包含字母和数字,最大长度限制为64个字符。当参数Protocol配置UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
- udp
Request String - 执行健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字。当参数Protocol配置为UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
- unhealthy
Threshold Number - 不健康阈值,即连续健康检查失败的次数。取值范围为2 ~ 10,默认值为3,单位为次。
- uri String
- 健康检查的路径,需配置为后端服务器上真实对外提供服务的地址。当参数Protocol取HTTP或HTTPS,HealthCheck.Enabled取on时,本参数生效。必须以字符‘/’开头。仅包含字母、数字、中划线(-)、下划线(_)、斜线/)、点号(.)、百分号(%)、英文问号(?)、#、&、等号(=)字符。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为“/”。
ListenerTag, ListenerTagArgs
Import
$ pulumi import volcenginecc:clb/listener:Listener example "listener_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
