1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getClbListenerRules
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloud.getClbListenerRules

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

    Use this data source to query detailed information of CLB listener rule

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as tencentcloud from "@pulumi/tencentcloud";
    
    const foo = tencentcloud.getClbListenerRules({
        clbId: "lb-k2zjp9lv",
        domain: "abc.com",
        listenerId: "lbl-mwr6vbtv",
        ruleId: "loc-inem40hz",
        scheduler: "WRR",
        url: "/",
    });
    
    import pulumi
    import pulumi_tencentcloud as tencentcloud
    
    foo = tencentcloud.get_clb_listener_rules(clb_id="lb-k2zjp9lv",
        domain="abc.com",
        listener_id="lbl-mwr6vbtv",
        rule_id="loc-inem40hz",
        scheduler="WRR",
        url="/")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := tencentcloud.GetClbListenerRules(ctx, &tencentcloud.GetClbListenerRulesArgs{
    			ClbId:      "lb-k2zjp9lv",
    			Domain:     pulumi.StringRef("abc.com"),
    			ListenerId: "lbl-mwr6vbtv",
    			RuleId:     pulumi.StringRef("loc-inem40hz"),
    			Scheduler:  pulumi.StringRef("WRR"),
    			Url:        pulumi.StringRef("/"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Tencentcloud = Pulumi.Tencentcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = Tencentcloud.GetClbListenerRules.Invoke(new()
        {
            ClbId = "lb-k2zjp9lv",
            Domain = "abc.com",
            ListenerId = "lbl-mwr6vbtv",
            RuleId = "loc-inem40hz",
            Scheduler = "WRR",
            Url = "/",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.tencentcloud.TencentcloudFunctions;
    import com.pulumi.tencentcloud.inputs.GetClbListenerRulesArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var foo = TencentcloudFunctions.getClbListenerRules(GetClbListenerRulesArgs.builder()
                .clbId("lb-k2zjp9lv")
                .domain("abc.com")
                .listenerId("lbl-mwr6vbtv")
                .ruleId("loc-inem40hz")
                .scheduler("WRR")
                .url("/")
                .build());
    
        }
    }
    
    variables:
      foo:
        fn::invoke:
          function: tencentcloud:getClbListenerRules
          arguments:
            clbId: lb-k2zjp9lv
            domain: abc.com
            listenerId: lbl-mwr6vbtv
            ruleId: loc-inem40hz
            scheduler: WRR
            url: /
    

    Using getClbListenerRules

    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 getClbListenerRules(args: GetClbListenerRulesArgs, opts?: InvokeOptions): Promise<GetClbListenerRulesResult>
    function getClbListenerRulesOutput(args: GetClbListenerRulesOutputArgs, opts?: InvokeOptions): Output<GetClbListenerRulesResult>
    def get_clb_listener_rules(clb_id: Optional[str] = None,
                               domain: Optional[str] = None,
                               id: Optional[str] = None,
                               listener_id: Optional[str] = None,
                               result_output_file: Optional[str] = None,
                               rule_id: Optional[str] = None,
                               scheduler: Optional[str] = None,
                               url: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetClbListenerRulesResult
    def get_clb_listener_rules_output(clb_id: Optional[pulumi.Input[str]] = None,
                               domain: Optional[pulumi.Input[str]] = None,
                               id: Optional[pulumi.Input[str]] = None,
                               listener_id: Optional[pulumi.Input[str]] = None,
                               result_output_file: Optional[pulumi.Input[str]] = None,
                               rule_id: Optional[pulumi.Input[str]] = None,
                               scheduler: Optional[pulumi.Input[str]] = None,
                               url: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetClbListenerRulesResult]
    func GetClbListenerRules(ctx *Context, args *GetClbListenerRulesArgs, opts ...InvokeOption) (*GetClbListenerRulesResult, error)
    func GetClbListenerRulesOutput(ctx *Context, args *GetClbListenerRulesOutputArgs, opts ...InvokeOption) GetClbListenerRulesResultOutput

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

    public static class GetClbListenerRules 
    {
        public static Task<GetClbListenerRulesResult> InvokeAsync(GetClbListenerRulesArgs args, InvokeOptions? opts = null)
        public static Output<GetClbListenerRulesResult> Invoke(GetClbListenerRulesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClbListenerRulesResult> getClbListenerRules(GetClbListenerRulesArgs args, InvokeOptions options)
    public static Output<GetClbListenerRulesResult> getClbListenerRules(GetClbListenerRulesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: tencentcloud:index/getClbListenerRules:getClbListenerRules
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClbId string
    ID of the CLB to be queried.
    ListenerId string
    ID of the CLB listener to be queried.
    Domain string
    Domain name of the forwarding rule to be queried.
    Id string
    ResultOutputFile string
    Used to save results.
    RuleId string
    ID of the forwarding rule to be queried.
    Scheduler string
    Scheduling method of the forwarding rule of thr CLB listener, and available values include WRR, IP HASH and LEAST_CONN. The default is WRR.
    Url string
    Url of the forwarding rule to be queried.
    ClbId string
    ID of the CLB to be queried.
    ListenerId string
    ID of the CLB listener to be queried.
    Domain string
    Domain name of the forwarding rule to be queried.
    Id string
    ResultOutputFile string
    Used to save results.
    RuleId string
    ID of the forwarding rule to be queried.
    Scheduler string
    Scheduling method of the forwarding rule of thr CLB listener, and available values include WRR, IP HASH and LEAST_CONN. The default is WRR.
    Url string
    Url of the forwarding rule to be queried.
    clbId String
    ID of the CLB to be queried.
    listenerId String
    ID of the CLB listener to be queried.
    domain String
    Domain name of the forwarding rule to be queried.
    id String
    resultOutputFile String
    Used to save results.
    ruleId String
    ID of the forwarding rule to be queried.
    scheduler String
    Scheduling method of the forwarding rule of thr CLB listener, and available values include WRR, IP HASH and LEAST_CONN. The default is WRR.
    url String
    Url of the forwarding rule to be queried.
    clbId string
    ID of the CLB to be queried.
    listenerId string
    ID of the CLB listener to be queried.
    domain string
    Domain name of the forwarding rule to be queried.
    id string
    resultOutputFile string
    Used to save results.
    ruleId string
    ID of the forwarding rule to be queried.
    scheduler string
    Scheduling method of the forwarding rule of thr CLB listener, and available values include WRR, IP HASH and LEAST_CONN. The default is WRR.
    url string
    Url of the forwarding rule to be queried.
    clb_id str
    ID of the CLB to be queried.
    listener_id str
    ID of the CLB listener to be queried.
    domain str
    Domain name of the forwarding rule to be queried.
    id str
    result_output_file str
    Used to save results.
    rule_id str
    ID of the forwarding rule to be queried.
    scheduler str
    Scheduling method of the forwarding rule of thr CLB listener, and available values include WRR, IP HASH and LEAST_CONN. The default is WRR.
    url str
    Url of the forwarding rule to be queried.
    clbId String
    ID of the CLB to be queried.
    listenerId String
    ID of the CLB listener to be queried.
    domain String
    Domain name of the forwarding rule to be queried.
    id String
    resultOutputFile String
    Used to save results.
    ruleId String
    ID of the forwarding rule to be queried.
    scheduler String
    Scheduling method of the forwarding rule of thr CLB listener, and available values include WRR, IP HASH and LEAST_CONN. The default is WRR.
    url String
    Url of the forwarding rule to be queried.

    getClbListenerRules Result

    The following output properties are available:

    ClbId string
    ID of the CLB.
    Id string
    ListenerId string
    ID of the listener.
    RuleLists List<GetClbListenerRulesRuleList>
    A list of forward rules of listeners. Each element contains the following attributes:
    Domain string
    ResultOutputFile string
    RuleId string
    ID of the rule.
    Scheduler string
    Scheduling method of the CLB listener, and available values include 'WRR', 'IP_HASH' and 'LEAST_CONN'. The default is 'WRR'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    Url string
    ClbId string
    ID of the CLB.
    Id string
    ListenerId string
    ID of the listener.
    RuleLists []GetClbListenerRulesRuleList
    A list of forward rules of listeners. Each element contains the following attributes:
    Domain string
    ResultOutputFile string
    RuleId string
    ID of the rule.
    Scheduler string
    Scheduling method of the CLB listener, and available values include 'WRR', 'IP_HASH' and 'LEAST_CONN'. The default is 'WRR'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    Url string
    clbId String
    ID of the CLB.
    id String
    listenerId String
    ID of the listener.
    ruleLists List<GetClbListenerRulesRuleList>
    A list of forward rules of listeners. Each element contains the following attributes:
    domain String
    resultOutputFile String
    ruleId String
    ID of the rule.
    scheduler String
    Scheduling method of the CLB listener, and available values include 'WRR', 'IP_HASH' and 'LEAST_CONN'. The default is 'WRR'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    url String
    clbId string
    ID of the CLB.
    id string
    listenerId string
    ID of the listener.
    ruleLists GetClbListenerRulesRuleList[]
    A list of forward rules of listeners. Each element contains the following attributes:
    domain string
    resultOutputFile string
    ruleId string
    ID of the rule.
    scheduler string
    Scheduling method of the CLB listener, and available values include 'WRR', 'IP_HASH' and 'LEAST_CONN'. The default is 'WRR'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    url string
    clb_id str
    ID of the CLB.
    id str
    listener_id str
    ID of the listener.
    rule_lists Sequence[GetClbListenerRulesRuleList]
    A list of forward rules of listeners. Each element contains the following attributes:
    domain str
    result_output_file str
    rule_id str
    ID of the rule.
    scheduler str
    Scheduling method of the CLB listener, and available values include 'WRR', 'IP_HASH' and 'LEAST_CONN'. The default is 'WRR'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    url str
    clbId String
    ID of the CLB.
    id String
    listenerId String
    ID of the listener.
    ruleLists List<Property Map>
    A list of forward rules of listeners. Each element contains the following attributes:
    domain String
    resultOutputFile String
    ruleId String
    ID of the rule.
    scheduler String
    Scheduling method of the CLB listener, and available values include 'WRR', 'IP_HASH' and 'LEAST_CONN'. The default is 'WRR'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    url String

    Supporting Types

    GetClbListenerRulesRuleList

    CertificateCaId string
    ID of the client certificate. NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    CertificateId string
    ID of the server certificate. NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    CertificateSslMode string
    Type of SSL Mode, and available values inclue 'UNIDIRECTIONAL', 'MUTUAL'.NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    ClbId string
    ID of the CLB to be queried.
    Domain string
    Domain name of the forwarding rule to be queried.
    HealthCheckHealthNum double
    Health threshold of health check, and the default is 3. If a success result is returned for the health check three consecutive times, the CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    HealthCheckHttpCode double
    HTTP Status Code. The default is 31 and value range is 1-31. 1 means the return value '1xx' is health. 2 means the return value '2xx' is health. 4 means the return value '3xx' is health. 8 means the return value 4xx is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    HealthCheckHttpDomain string
    Domain name of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol.
    HealthCheckHttpMethod string
    Methods of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol. The default is 'HEAD', the available value include 'HEAD' and 'GET'.
    HealthCheckHttpPath string
    Path of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol.
    HealthCheckIntervalTime double
    Interval time of health check. The value range is 2-300 sec, and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    HealthCheckSwitch bool
    Indicates whether health check is enabled.
    HealthCheckUnhealthNum double
    Unhealth threshold of health check, and the default is 3. If a success result is returned for the health check three consecutive times, the CVM is identified as unhealthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    Http2Switch bool
    Indicate to set HTTP2 protocol or not.
    ListenerId string
    ID of the CLB listener to be queried.
    RuleId string
    ID of the forwarding rule to be queried.
    Scheduler string
    Scheduling method of the forwarding rule of thr CLB listener, and available values include WRR, IP HASH and LEAST_CONN. The default is WRR.
    SessionExpireTime double
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as 'WRR'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    Url string
    Url of the forwarding rule to be queried.
    CertificateCaId string
    ID of the client certificate. NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    CertificateId string
    ID of the server certificate. NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    CertificateSslMode string
    Type of SSL Mode, and available values inclue 'UNIDIRECTIONAL', 'MUTUAL'.NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    ClbId string
    ID of the CLB to be queried.
    Domain string
    Domain name of the forwarding rule to be queried.
    HealthCheckHealthNum float64
    Health threshold of health check, and the default is 3. If a success result is returned for the health check three consecutive times, the CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    HealthCheckHttpCode float64
    HTTP Status Code. The default is 31 and value range is 1-31. 1 means the return value '1xx' is health. 2 means the return value '2xx' is health. 4 means the return value '3xx' is health. 8 means the return value 4xx is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    HealthCheckHttpDomain string
    Domain name of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol.
    HealthCheckHttpMethod string
    Methods of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol. The default is 'HEAD', the available value include 'HEAD' and 'GET'.
    HealthCheckHttpPath string
    Path of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol.
    HealthCheckIntervalTime float64
    Interval time of health check. The value range is 2-300 sec, and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    HealthCheckSwitch bool
    Indicates whether health check is enabled.
    HealthCheckUnhealthNum float64
    Unhealth threshold of health check, and the default is 3. If a success result is returned for the health check three consecutive times, the CVM is identified as unhealthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    Http2Switch bool
    Indicate to set HTTP2 protocol or not.
    ListenerId string
    ID of the CLB listener to be queried.
    RuleId string
    ID of the forwarding rule to be queried.
    Scheduler string
    Scheduling method of the forwarding rule of thr CLB listener, and available values include WRR, IP HASH and LEAST_CONN. The default is WRR.
    SessionExpireTime float64
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as 'WRR'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    Url string
    Url of the forwarding rule to be queried.
    certificateCaId String
    ID of the client certificate. NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    certificateId String
    ID of the server certificate. NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    certificateSslMode String
    Type of SSL Mode, and available values inclue 'UNIDIRECTIONAL', 'MUTUAL'.NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    clbId String
    ID of the CLB to be queried.
    domain String
    Domain name of the forwarding rule to be queried.
    healthCheckHealthNum Double
    Health threshold of health check, and the default is 3. If a success result is returned for the health check three consecutive times, the CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    healthCheckHttpCode Double
    HTTP Status Code. The default is 31 and value range is 1-31. 1 means the return value '1xx' is health. 2 means the return value '2xx' is health. 4 means the return value '3xx' is health. 8 means the return value 4xx is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    healthCheckHttpDomain String
    Domain name of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol.
    healthCheckHttpMethod String
    Methods of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol. The default is 'HEAD', the available value include 'HEAD' and 'GET'.
    healthCheckHttpPath String
    Path of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol.
    healthCheckIntervalTime Double
    Interval time of health check. The value range is 2-300 sec, and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    healthCheckSwitch Boolean
    Indicates whether health check is enabled.
    healthCheckUnhealthNum Double
    Unhealth threshold of health check, and the default is 3. If a success result is returned for the health check three consecutive times, the CVM is identified as unhealthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    http2Switch Boolean
    Indicate to set HTTP2 protocol or not.
    listenerId String
    ID of the CLB listener to be queried.
    ruleId String
    ID of the forwarding rule to be queried.
    scheduler String
    Scheduling method of the forwarding rule of thr CLB listener, and available values include WRR, IP HASH and LEAST_CONN. The default is WRR.
    sessionExpireTime Double
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as 'WRR'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    url String
    Url of the forwarding rule to be queried.
    certificateCaId string
    ID of the client certificate. NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    certificateId string
    ID of the server certificate. NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    certificateSslMode string
    Type of SSL Mode, and available values inclue 'UNIDIRECTIONAL', 'MUTUAL'.NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    clbId string
    ID of the CLB to be queried.
    domain string
    Domain name of the forwarding rule to be queried.
    healthCheckHealthNum number
    Health threshold of health check, and the default is 3. If a success result is returned for the health check three consecutive times, the CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    healthCheckHttpCode number
    HTTP Status Code. The default is 31 and value range is 1-31. 1 means the return value '1xx' is health. 2 means the return value '2xx' is health. 4 means the return value '3xx' is health. 8 means the return value 4xx is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    healthCheckHttpDomain string
    Domain name of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol.
    healthCheckHttpMethod string
    Methods of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol. The default is 'HEAD', the available value include 'HEAD' and 'GET'.
    healthCheckHttpPath string
    Path of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol.
    healthCheckIntervalTime number
    Interval time of health check. The value range is 2-300 sec, and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    healthCheckSwitch boolean
    Indicates whether health check is enabled.
    healthCheckUnhealthNum number
    Unhealth threshold of health check, and the default is 3. If a success result is returned for the health check three consecutive times, the CVM is identified as unhealthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    http2Switch boolean
    Indicate to set HTTP2 protocol or not.
    listenerId string
    ID of the CLB listener to be queried.
    ruleId string
    ID of the forwarding rule to be queried.
    scheduler string
    Scheduling method of the forwarding rule of thr CLB listener, and available values include WRR, IP HASH and LEAST_CONN. The default is WRR.
    sessionExpireTime number
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as 'WRR'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    url string
    Url of the forwarding rule to be queried.
    certificate_ca_id str
    ID of the client certificate. NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    certificate_id str
    ID of the server certificate. NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    certificate_ssl_mode str
    Type of SSL Mode, and available values inclue 'UNIDIRECTIONAL', 'MUTUAL'.NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    clb_id str
    ID of the CLB to be queried.
    domain str
    Domain name of the forwarding rule to be queried.
    health_check_health_num float
    Health threshold of health check, and the default is 3. If a success result is returned for the health check three consecutive times, the CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    health_check_http_code float
    HTTP Status Code. The default is 31 and value range is 1-31. 1 means the return value '1xx' is health. 2 means the return value '2xx' is health. 4 means the return value '3xx' is health. 8 means the return value 4xx is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    health_check_http_domain str
    Domain name of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol.
    health_check_http_method str
    Methods of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol. The default is 'HEAD', the available value include 'HEAD' and 'GET'.
    health_check_http_path str
    Path of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol.
    health_check_interval_time float
    Interval time of health check. The value range is 2-300 sec, and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    health_check_switch bool
    Indicates whether health check is enabled.
    health_check_unhealth_num float
    Unhealth threshold of health check, and the default is 3. If a success result is returned for the health check three consecutive times, the CVM is identified as unhealthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    http2_switch bool
    Indicate to set HTTP2 protocol or not.
    listener_id str
    ID of the CLB listener to be queried.
    rule_id str
    ID of the forwarding rule to be queried.
    scheduler str
    Scheduling method of the forwarding rule of thr CLB listener, and available values include WRR, IP HASH and LEAST_CONN. The default is WRR.
    session_expire_time float
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as 'WRR'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    url str
    Url of the forwarding rule to be queried.
    certificateCaId String
    ID of the client certificate. NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    certificateId String
    ID of the server certificate. NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    certificateSslMode String
    Type of SSL Mode, and available values inclue 'UNIDIRECTIONAL', 'MUTUAL'.NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol.
    clbId String
    ID of the CLB to be queried.
    domain String
    Domain name of the forwarding rule to be queried.
    healthCheckHealthNum Number
    Health threshold of health check, and the default is 3. If a success result is returned for the health check three consecutive times, the CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    healthCheckHttpCode Number
    HTTP Status Code. The default is 31 and value range is 1-31. 1 means the return value '1xx' is health. 2 means the return value '2xx' is health. 4 means the return value '3xx' is health. 8 means the return value 4xx is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol.
    healthCheckHttpDomain String
    Domain name of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol.
    healthCheckHttpMethod String
    Methods of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol. The default is 'HEAD', the available value include 'HEAD' and 'GET'.
    healthCheckHttpPath String
    Path of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol.
    healthCheckIntervalTime Number
    Interval time of health check. The value range is 2-300 sec, and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    healthCheckSwitch Boolean
    Indicates whether health check is enabled.
    healthCheckUnhealthNum Number
    Unhealth threshold of health check, and the default is 3. If a success result is returned for the health check three consecutive times, the CVM is identified as unhealthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    http2Switch Boolean
    Indicate to set HTTP2 protocol or not.
    listenerId String
    ID of the CLB listener to be queried.
    ruleId String
    ID of the forwarding rule to be queried.
    scheduler String
    Scheduling method of the forwarding rule of thr CLB listener, and available values include WRR, IP HASH and LEAST_CONN. The default is WRR.
    sessionExpireTime Number
    Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as 'WRR'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule.
    url String
    Url of the forwarding rule to be queried.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack