1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. clb
  5. getListener
volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine

volcenginecc.clb.getListener

Get Started
volcenginecc logo
volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine

    Data Source schema for Volcengine::CLB::Listener

    Using getListener

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getListener(args: GetListenerArgs, opts?: InvokeOptions): Promise<GetListenerResult>
    function getListenerOutput(args: GetListenerOutputArgs, opts?: InvokeOptions): Output<GetListenerResult>
    def get_listener(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetListenerResult
    def get_listener_output(id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetListenerResult]
    func LookupListener(ctx *Context, args *LookupListenerArgs, opts ...InvokeOption) (*LookupListenerResult, error)
    func LookupListenerOutput(ctx *Context, args *LookupListenerOutputArgs, opts ...InvokeOption) LookupListenerResultOutput

    > Note: This function is named LookupListener in the Go SDK.

    public static class GetListener 
    {
        public static Task<GetListenerResult> InvokeAsync(GetListenerArgs args, InvokeOptions? opts = null)
        public static Output<GetListenerResult> Invoke(GetListenerInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetListenerResult> getListener(GetListenerArgs args, InvokeOptions options)
    public static Output<GetListenerResult> getListener(GetListenerArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcenginecc:clb/getListener:getListener
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getListener Result

    The following output properties are available:

    AclIds List<string>
    监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
    AclStatus string
    是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
    AclType string
    访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
    Bandwidth int
    监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
    CaCertificateId string
    双向认证的CA证书。
    CaEnabled string
    是否开启双向认证。on:开启。off(默认值):不开启。
    CertCenterCertificateId string
    证书中心的证书的ID。
    CertificateId string
    CLB侧证书管理模块的证书的ID。
    CertificateSource string
    证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
    ClientBodyTimeout int
    读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
    ClientHeaderTimeout int
    读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    ConnectionDrainEnabled string
    监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
    ConnectionDrainTimeout int
    连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
    Cookie string
    后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
    Cps int
    每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
    CreatedTime string
    监听器的创建时间。
    Description string
    监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
    Enabled string
    是否启用监听器。on(默认值):开启。off:不开启。
    EndPort int
    全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
    EstablishedTimeout int
    监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
    HealthCheck Volcengine.GetListenerHealthCheck
    健康检查相关信息。
    Http2Enabled string
    监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
    Id string
    Uniquely identifies the resource.
    KeepaliveTimeout int
    客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    ListenerId string
    监听器的ID。
    ListenerName string
    监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
    LoadBalancerId string
    CLB实例的ID。
    MaxConnections int
    最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
    PersistenceTimeout int
    会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
    PersistenceType 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
    监听器的协议。
    ProxyConnectTimeout int
    CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    ProxyProtocolType string
    是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
    ProxyReadTimeout int
    CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    ProxySendTimeout int
    CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    Scheduler string
    监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
    SecurityPolicyId string
    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。
    SendTimeout int
    CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    ServerGroupId string
    监听器关联的后端服务器组 ID。
    StartPort int
    全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
    Status string
    监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
    Tags List<Volcengine.GetListenerTag>
    监听器所属标签。
    UpdatedTime string
    监听器最近一次的操作时间。
    WafProtectionEnabled string
    是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。
    AclIds []string
    监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
    AclStatus string
    是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
    AclType string
    访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
    Bandwidth int
    监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
    CaCertificateId string
    双向认证的CA证书。
    CaEnabled string
    是否开启双向认证。on:开启。off(默认值):不开启。
    CertCenterCertificateId string
    证书中心的证书的ID。
    CertificateId string
    CLB侧证书管理模块的证书的ID。
    CertificateSource string
    证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
    ClientBodyTimeout int
    读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
    ClientHeaderTimeout int
    读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    ConnectionDrainEnabled string
    监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
    ConnectionDrainTimeout int
    连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
    Cookie string
    后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
    Cps int
    每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
    CreatedTime string
    监听器的创建时间。
    Description string
    监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
    Enabled string
    是否启用监听器。on(默认值):开启。off:不开启。
    EndPort int
    全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
    EstablishedTimeout int
    监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
    HealthCheck GetListenerHealthCheck
    健康检查相关信息。
    Http2Enabled string
    监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
    Id string
    Uniquely identifies the resource.
    KeepaliveTimeout int
    客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    ListenerId string
    监听器的ID。
    ListenerName string
    监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
    LoadBalancerId string
    CLB实例的ID。
    MaxConnections int
    最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
    PersistenceTimeout int
    会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
    PersistenceType 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
    监听器的协议。
    ProxyConnectTimeout int
    CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    ProxyProtocolType string
    是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
    ProxyReadTimeout int
    CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    ProxySendTimeout int
    CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    Scheduler string
    监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
    SecurityPolicyId string
    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。
    SendTimeout int
    CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    ServerGroupId string
    监听器关联的后端服务器组 ID。
    StartPort int
    全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
    Status string
    监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
    Tags []GetListenerTag
    监听器所属标签。
    UpdatedTime string
    监听器最近一次的操作时间。
    WafProtectionEnabled string
    是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。
    aclIds List<String>
    监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
    aclStatus String
    是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
    aclType String
    访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
    bandwidth Integer
    监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
    caCertificateId String
    双向认证的CA证书。
    caEnabled String
    是否开启双向认证。on:开启。off(默认值):不开启。
    certCenterCertificateId String
    证书中心的证书的ID。
    certificateId String
    CLB侧证书管理模块的证书的ID。
    certificateSource String
    证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
    clientBodyTimeout Integer
    读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
    clientHeaderTimeout Integer
    读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    connectionDrainEnabled String
    监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
    connectionDrainTimeout Integer
    连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
    cookie String
    后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
    cps Integer
    每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
    createdTime String
    监听器的创建时间。
    description String
    监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
    enabled String
    是否启用监听器。on(默认值):开启。off:不开启。
    endPort Integer
    全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
    establishedTimeout Integer
    监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
    healthCheck GetListenerHealthCheck
    健康检查相关信息。
    http2Enabled String
    监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
    id String
    Uniquely identifies the resource.
    keepaliveTimeout Integer
    客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    listenerId String
    监听器的ID。
    listenerName String
    监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
    loadBalancerId String
    CLB实例的ID。
    maxConnections Integer
    最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
    persistenceTimeout Integer
    会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
    persistenceType 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
    监听器的协议。
    proxyConnectTimeout Integer
    CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    proxyProtocolType String
    是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
    proxyReadTimeout Integer
    CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    proxySendTimeout Integer
    CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    scheduler String
    监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
    securityPolicyId String
    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。
    sendTimeout Integer
    CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    serverGroupId String
    监听器关联的后端服务器组 ID。
    startPort Integer
    全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
    status String
    监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
    tags List<GetListenerTag>
    监听器所属标签。
    updatedTime String
    监听器最近一次的操作时间。
    wafProtectionEnabled String
    是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。
    aclIds string[]
    监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
    aclStatus string
    是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
    aclType string
    访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
    bandwidth number
    监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
    caCertificateId string
    双向认证的CA证书。
    caEnabled string
    是否开启双向认证。on:开启。off(默认值):不开启。
    certCenterCertificateId string
    证书中心的证书的ID。
    certificateId string
    CLB侧证书管理模块的证书的ID。
    certificateSource string
    证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
    clientBodyTimeout number
    读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
    clientHeaderTimeout number
    读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    connectionDrainEnabled string
    监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
    connectionDrainTimeout number
    连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
    cookie string
    后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
    cps number
    每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
    createdTime string
    监听器的创建时间。
    description string
    监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
    enabled string
    是否启用监听器。on(默认值):开启。off:不开启。
    endPort number
    全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
    establishedTimeout number
    监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
    healthCheck GetListenerHealthCheck
    健康检查相关信息。
    http2Enabled string
    监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
    id string
    Uniquely identifies the resource.
    keepaliveTimeout number
    客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    listenerId string
    监听器的ID。
    listenerName string
    监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
    loadBalancerId string
    CLB实例的ID。
    maxConnections number
    最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
    persistenceTimeout number
    会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
    persistenceType 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
    监听器的协议。
    proxyConnectTimeout number
    CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    proxyProtocolType string
    是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
    proxyReadTimeout number
    CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    proxySendTimeout number
    CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    scheduler string
    监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
    securityPolicyId string
    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。
    sendTimeout number
    CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    serverGroupId string
    监听器关联的后端服务器组 ID。
    startPort number
    全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
    status string
    监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
    tags GetListenerTag[]
    监听器所属标签。
    updatedTime string
    监听器最近一次的操作时间。
    wafProtectionEnabled string
    是否将经过七层监听器的流量送至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_id str
    双向认证的CA证书。
    ca_enabled str
    是否开启双向认证。on:开启。off(默认值):不开启。
    cert_center_certificate_id str
    证书中心的证书的ID。
    certificate_id str
    CLB侧证书管理模块的证书的ID。
    certificate_source str
    证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
    client_body_timeout int
    读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
    client_header_timeout int
    读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    connection_drain_enabled str
    监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
    connection_drain_timeout int
    连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
    cookie 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 GetListenerHealthCheck
    健康检查相关信息。
    http2_enabled str
    监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
    id str
    Uniquely identifies the resource.
    keepalive_timeout int
    客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    listener_id str
    监听器的ID。
    listener_name str
    监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
    load_balancer_id str
    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_timeout int
    CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    proxy_protocol_type str
    是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
    proxy_read_timeout int
    CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    proxy_send_timeout int
    CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    scheduler str
    监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
    security_policy_id str
    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_id str
    监听器关联的后端服务器组 ID。
    start_port int
    全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
    status str
    监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
    tags Sequence[GetListenerTag]
    监听器所属标签。
    updated_time str
    监听器最近一次的操作时间。
    waf_protection_enabled str
    是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。
    aclIds List<String>
    监听器绑定的访问控制策略组ID。仅AclStatus参数为on时返回。
    aclStatus String
    是否开启访问控制功能。取值如下:on:开启。off(默认值):不开启。
    aclType String
    访问控制的方式。white:白名单。black:黑名单。仅AclStatus参数为on时,本参数有效。
    bandwidth Number
    监听器的带宽上限,即此监听器独占CLB实例的带宽,单位为Mbps。-1(默认值):此监听器不独占CLB的带,与其他监听器共享CLB实例未被独占的带宽。取值范围:1~CLB实例未被独占的带宽。
    caCertificateId String
    双向认证的CA证书。
    caEnabled String
    是否开启双向认证。on:开启。off(默认值):不开启。
    certCenterCertificateId String
    证书中心的证书的ID。
    certificateId String
    CLB侧证书管理模块的证书的ID。
    certificateSource String
    证书的来源。clb (默认):CLB上传的证书。cert_center:证书中心上传的证书。user:用户上传的证书。
    clientBodyTimeout Number
    读取客户端请求正文的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个请求的传输过程。取值范围为 30-120秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效
    clientHeaderTimeout Number
    读取客户端请求头的超时时间。取值范围为30-120秒。默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    connectionDrainEnabled String
    监听器是否开启连接优雅中断功能。on:开启。off:不开启。参数Protocol返回为HTTP或HTTPS时,该参数固定返回off。
    connectionDrainTimeout Number
    连接优雅中断的超时时间,单位为秒。参数ConnectionDrainEnabled返回为off时,该参数返回0。
    cookie String
    后端服务器配置的会话保持的Cookie名称。仅参数PersistenceType取server时,本参数有效且必填。只能包含字母、数字、下划线(_)和中划线(-)。长度限制在1~200字符之间。
    cps Number
    每秒新建连接数的上限。-1(默认值):不限制,即CLB实例的新建连接数上限。取值范围:1~CLB实例的新连接数上限。
    createdTime String
    监听器的创建时间。
    description String
    监听器的描述。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:英文逗号(,)、点(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。长度限制为0 ~ 255个字符。不填则默认值为空字符串。
    enabled String
    是否启用监听器。on(默认值):开启。off:不开启。
    endPort Number
    全端口监听的结束端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入,且该参数取值应大于tartPort。
    establishedTimeout Number
    监听器的连接超时时间。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:TCP协议:10-900秒,默认为900秒。UDP协议:1-300秒,默认为90秒。
    healthCheck Property Map
    健康检查相关信息。
    http2Enabled String
    监听器是否开启前端HTTP 2.0协议。仅参数`Protocol取HTTPS时,本参数有效。取值如下:|on:开启。off(默认值):不开启。
    id String
    Uniquely identifies the resource.
    keepaliveTimeout Number
    客户端与CLB之间的长连接超时时间。取值范围为 0-900秒,默认为75秒。0表示禁用长连接。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    listenerId String
    监听器的ID。
    listenerName String
    监听器的名称。必须以字母、数字或中文开头,可包含字母、数字、中文及以下特殊字符:点号(.)、下划线_)和中划线(-)。长度限制在1~128字符之间。不填则默认将“协议-端口”作为监听器名称。
    loadBalancerId String
    CLB实例的ID。
    maxConnections Number
    最大并发连接数的上限。-1(默认值):不限制,CLB实例的最大并发连接数上限。取值范围:1~CLB实例的最大并发连接数上限。
    persistenceTimeout Number
    会话保持的超时时间,单位为秒。取值范围根据参数PersistenceType取值有所不同。PersistenceType置为source_ip时,取值范围为1~3600。PersistenceType配置为insert时,取值范围为1~86400。
    persistenceType 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
    监听器的协议。
    proxyConnectTimeout Number
    CLB与后端服务器之间的连接建立超时时间。建议大于健康检查超时时间。取值范围为 4-120秒,默认为4。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    proxyProtocolType String
    是否启用Proxy-Protocol协议。仅参数Protocol取TCP或UDP时,本参数有效。取值如下:off(默认值):关闭。standard:开启。
    proxyReadTimeout Number
    CLB从后端服务器读取响应的超时时间。此超时时间仅针对两个连续的读操作之间设置,而非整个响应的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    proxySendTimeout Number
    CLB将请求传输到后端服务器的超时时间。此超时仅针对两个连续的写操作之间设置,而非整个请求的传输过程。取值范围为30-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    scheduler String
    监听器使用的调度算法。wrr(默认值):加权轮询。wlc:加权最小连接数。sh:源地址哈希。
    securityPolicyId String
    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。
    sendTimeout Number
    CLB向客户端发送响应的超时时间。此超时仅针对两个连续的写操作之间设置,而非整响应的传输过程。取值范围为 1-3600秒,默认为60秒。仅参数Protocol取HTTP或HTTPS时,本参数有效。
    serverGroupId String
    监听器关联的后端服务器组 ID。
    startPort Number
    全端口监听的起始端口,取值范围为1-65535。参数Port为“0”时,该参数必须传入。
    status String
    监听器的状态。Creating:创建中。Active:运行中。Deleting: 删除中。Disabled: 已停用。
    tags List<Property Map>
    监听器所属标签。
    updatedTime String
    监听器最近一次的操作时间。
    wafProtectionEnabled String
    是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。on:是。off:否。

    Supporting Types

    GetListenerHealthCheck

    Domain string
    健康检查的域名,需配置为后端服务器上真实对外提供服务的地址。当参数Protocol取HTTP或HTTPS,HealthCheck.Enabled取on时,本参数生效。需至少包含一个点号(.),且不允许以点号(.)开头或结尾。单个字符串由母、数字、中划线(-)、点号(.)字符组成,中划线(-)不得出现在字符串的头部或尾部。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为空,表示CLB使用各后端服务器的私网IP地址进行健康检查。
    Enabled string
    监听器是否开启健康检查功能。on(默认值):开启。off:不开启。
    HealthyThreshold int
    健康阈值,即连续健康检查成功的次数。取值范围为2 ~ 10,默认值为3,单位为次。
    HttpCode 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,单位为秒。
    UdpExpect string
    健康检查的预期响应字符串。只允许包含字母和数字,最大长度限制为64个字符。当参数Protocol配置UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
    UdpRequest string
    执行健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字。当参数Protocol配置为UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
    UnhealthyThreshold 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:不开启。
    HealthyThreshold int
    健康阈值,即连续健康检查成功的次数。取值范围为2 ~ 10,默认值为3,单位为次。
    HttpCode 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,单位为秒。
    UdpExpect string
    健康检查的预期响应字符串。只允许包含字母和数字,最大长度限制为64个字符。当参数Protocol配置UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
    UdpRequest string
    执行健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字。当参数Protocol配置为UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
    UnhealthyThreshold 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:不开启。
    healthyThreshold Integer
    健康阈值,即连续健康检查成功的次数。取值范围为2 ~ 10,默认值为3,单位为次。
    httpCode 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,单位为秒。
    udpExpect String
    健康检查的预期响应字符串。只允许包含字母和数字,最大长度限制为64个字符。当参数Protocol配置UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
    udpRequest String
    执行健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字。当参数Protocol配置为UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
    unhealthyThreshold 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:不开启。
    healthyThreshold number
    健康阈值,即连续健康检查成功的次数。取值范围为2 ~ 10,默认值为3,单位为次。
    httpCode 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,单位为秒。
    udpExpect string
    健康检查的预期响应字符串。只允许包含字母和数字,最大长度限制为64个字符。当参数Protocol配置UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
    udpRequest string
    执行健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字。当参数Protocol配置为UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
    unhealthyThreshold 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:不开启。
    healthyThreshold Number
    健康阈值,即连续健康检查成功的次数。取值范围为2 ~ 10,默认值为3,单位为次。
    httpCode 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,单位为秒。
    udpExpect String
    健康检查的预期响应字符串。只允许包含字母和数字,最大长度限制为64个字符。当参数Protocol配置UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
    udpRequest String
    执行健康检查的请求字符串。只允许包含字母和数字,最大长度限制为64个字。当参数Protocol配置为UDP,且参数HealthCheck.Enabled配置为on时,该参数生效。参数HealthCheck.UdpRequest和HealthCheck.UdpExpect的取值只能同时为空或同时不为空。
    unhealthyThreshold Number
    不健康阈值,即连续健康检查失败的次数。取值范围为2 ~ 10,默认值为3,单位为次。
    uri String
    健康检查的路径,需配置为后端服务器上真实对外提供服务的地址。当参数Protocol取HTTP或HTTPS,HealthCheck.Enabled取on时,本参数生效。必须以字符‘/’开头。仅包含字母、数字、中划线(-)、下划线(_)、斜线/)、点号(.)、百分号(%)、英文问号(?)、#、&、等号(=)字符。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时,默认为“/”。

    GetListenerTag

    Key string
    用户标签的标签键。长度取值范围为1~128字符,允许输入各国语言文字、数字、空格( )、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、中划线(-)和@(@)。若标签键开头或结尾存在空格,系统会自动为其去除。
    Value string
    用户标签的标签值。允许输入各国语言文字、数字、空格( )、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、中划线(-)和@(@)。大小写敏感。若标签值开头或结尾存在空格,系统会自动为其去除。
    Key string
    用户标签的标签键。长度取值范围为1~128字符,允许输入各国语言文字、数字、空格( )、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、中划线(-)和@(@)。若标签键开头或结尾存在空格,系统会自动为其去除。
    Value string
    用户标签的标签值。允许输入各国语言文字、数字、空格( )、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、中划线(-)和@(@)。大小写敏感。若标签值开头或结尾存在空格,系统会自动为其去除。
    key String
    用户标签的标签键。长度取值范围为1~128字符,允许输入各国语言文字、数字、空格( )、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、中划线(-)和@(@)。若标签键开头或结尾存在空格,系统会自动为其去除。
    value String
    用户标签的标签值。允许输入各国语言文字、数字、空格( )、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、中划线(-)和@(@)。大小写敏感。若标签值开头或结尾存在空格,系统会自动为其去除。
    key string
    用户标签的标签键。长度取值范围为1~128字符,允许输入各国语言文字、数字、空格( )、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、中划线(-)和@(@)。若标签键开头或结尾存在空格,系统会自动为其去除。
    value string
    用户标签的标签值。允许输入各国语言文字、数字、空格( )、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、中划线(-)和@(@)。大小写敏感。若标签值开头或结尾存在空格,系统会自动为其去除。
    key str
    用户标签的标签键。长度取值范围为1~128字符,允许输入各国语言文字、数字、空格( )、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、中划线(-)和@(@)。若标签键开头或结尾存在空格,系统会自动为其去除。
    value str
    用户标签的标签值。允许输入各国语言文字、数字、空格( )、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、中划线(-)和@(@)。大小写敏感。若标签值开头或结尾存在空格,系统会自动为其去除。
    key String
    用户标签的标签键。长度取值范围为1~128字符,允许输入各国语言文字、数字、空格( )、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、中划线(-)和@(@)。若标签键开头或结尾存在空格,系统会自动为其去除。
    value String
    用户标签的标签值。允许输入各国语言文字、数字、空格( )、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、中划线(-)和@(@)。大小写敏感。若标签值开头或结尾存在空格,系统会自动为其去除。

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine
      Meet Neo: Your AI Platform Teammate