published on Friday, Oct 23, 2026 by tencentcloudstack
published on Friday, Oct 23, 2026 by tencentcloudstack
Provides a resource to create a CLB listener.
Example Usage
HTTP Listener
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const example = new tencentcloud.ClbListener("example", {
clbId: "lb-qck8thny",
listenerName: "tf-example",
port: 80,
protocol: "HTTP",
});
import pulumi
import pulumi_tencentcloud as tencentcloud
example = tencentcloud.ClbListener("example",
clb_id="lb-qck8thny",
listener_name="tf-example",
port=80,
protocol="HTTP")
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.NewClbListener(ctx, "example", &tencentcloud.ClbListenerArgs{
ClbId: pulumi.String("lb-qck8thny"),
ListenerName: pulumi.String("tf-example"),
Port: pulumi.Float64(80),
Protocol: pulumi.String("HTTP"),
})
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 example = new Tencentcloud.ClbListener("example", new()
{
ClbId = "lb-qck8thny",
ListenerName = "tf-example",
Port = 80,
Protocol = "HTTP",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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) {
var example = new ClbListener("example", ClbListenerArgs.builder()
.clbId("lb-qck8thny")
.listenerName("tf-example")
.port(80.0)
.protocol("HTTP")
.build());
}
}
resources:
example:
type: tencentcloud:ClbListener
properties:
clbId: lb-qck8thny
listenerName: tf-example
port: 80
protocol: HTTP
Example coming soon!
HTTP Listener with specific data compress mode
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const example = new tencentcloud.ClbListener("example", {
clbId: "lb-qck8thny",
listenerName: "tf-example",
port: 80,
protocol: "HTTP",
dataCompressMode: "transparent",
});
import pulumi
import pulumi_tencentcloud as tencentcloud
example = tencentcloud.ClbListener("example",
clb_id="lb-qck8thny",
listener_name="tf-example",
port=80,
protocol="HTTP",
data_compress_mode="transparent")
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.NewClbListener(ctx, "example", &tencentcloud.ClbListenerArgs{
ClbId: pulumi.String("lb-qck8thny"),
ListenerName: pulumi.String("tf-example"),
Port: pulumi.Float64(80),
Protocol: pulumi.String("HTTP"),
DataCompressMode: pulumi.String("transparent"),
})
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 example = new Tencentcloud.ClbListener("example", new()
{
ClbId = "lb-qck8thny",
ListenerName = "tf-example",
Port = 80,
Protocol = "HTTP",
DataCompressMode = "transparent",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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) {
var example = new ClbListener("example", ClbListenerArgs.builder()
.clbId("lb-qck8thny")
.listenerName("tf-example")
.port(80.0)
.protocol("HTTP")
.dataCompressMode("transparent")
.build());
}
}
resources:
example:
type: tencentcloud:ClbListener
properties:
clbId: lb-qck8thny
listenerName: tf-example
port: 80
protocol: HTTP
dataCompressMode: transparent
Example coming soon!
TCP/UDP Listener
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const example = new tencentcloud.ClbListener("example", {
clbId: "lb-qck8thny",
listenerName: "tf-example",
port: 80,
protocol: "TCP",
healthCheckSwitch: true,
healthCheckTimeOut: 2,
healthCheckIntervalTime: 5,
healthCheckHealthNum: 3,
healthCheckUnhealthNum: 3,
sessionExpireTime: 30,
scheduler: "WRR",
healthCheckPort: 200,
healthCheckType: "HTTP",
healthCheckHttpPath: "/",
healthCheckHttpCode: 2,
healthCheckHttpVersion: "HTTP/1.0",
healthCheckHttpMethod: "GET",
deregisterTargetRst: false,
idleConnectTimeout: 900,
});
import pulumi
import pulumi_tencentcloud as tencentcloud
example = tencentcloud.ClbListener("example",
clb_id="lb-qck8thny",
listener_name="tf-example",
port=80,
protocol="TCP",
health_check_switch=True,
health_check_time_out=2,
health_check_interval_time=5,
health_check_health_num=3,
health_check_unhealth_num=3,
session_expire_time=30,
scheduler="WRR",
health_check_port=200,
health_check_type="HTTP",
health_check_http_path="/",
health_check_http_code=2,
health_check_http_version="HTTP/1.0",
health_check_http_method="GET",
deregister_target_rst=False,
idle_connect_timeout=900)
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.NewClbListener(ctx, "example", &tencentcloud.ClbListenerArgs{
ClbId: pulumi.String("lb-qck8thny"),
ListenerName: pulumi.String("tf-example"),
Port: pulumi.Float64(80),
Protocol: pulumi.String("TCP"),
HealthCheckSwitch: pulumi.Bool(true),
HealthCheckTimeOut: pulumi.Float64(2),
HealthCheckIntervalTime: pulumi.Float64(5),
HealthCheckHealthNum: pulumi.Float64(3),
HealthCheckUnhealthNum: pulumi.Float64(3),
SessionExpireTime: pulumi.Float64(30),
Scheduler: pulumi.String("WRR"),
HealthCheckPort: pulumi.Float64(200),
HealthCheckType: pulumi.String("HTTP"),
HealthCheckHttpPath: pulumi.String("/"),
HealthCheckHttpCode: pulumi.Float64(2),
HealthCheckHttpVersion: pulumi.String("HTTP/1.0"),
HealthCheckHttpMethod: pulumi.String("GET"),
DeregisterTargetRst: pulumi.Bool(false),
IdleConnectTimeout: pulumi.Float64(900),
})
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 example = new Tencentcloud.ClbListener("example", new()
{
ClbId = "lb-qck8thny",
ListenerName = "tf-example",
Port = 80,
Protocol = "TCP",
HealthCheckSwitch = true,
HealthCheckTimeOut = 2,
HealthCheckIntervalTime = 5,
HealthCheckHealthNum = 3,
HealthCheckUnhealthNum = 3,
SessionExpireTime = 30,
Scheduler = "WRR",
HealthCheckPort = 200,
HealthCheckType = "HTTP",
HealthCheckHttpPath = "/",
HealthCheckHttpCode = 2,
HealthCheckHttpVersion = "HTTP/1.0",
HealthCheckHttpMethod = "GET",
DeregisterTargetRst = false,
IdleConnectTimeout = 900,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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) {
var example = new ClbListener("example", ClbListenerArgs.builder()
.clbId("lb-qck8thny")
.listenerName("tf-example")
.port(80.0)
.protocol("TCP")
.healthCheckSwitch(true)
.healthCheckTimeOut(2.0)
.healthCheckIntervalTime(5.0)
.healthCheckHealthNum(3.0)
.healthCheckUnhealthNum(3.0)
.sessionExpireTime(30.0)
.scheduler("WRR")
.healthCheckPort(200.0)
.healthCheckType("HTTP")
.healthCheckHttpPath("/")
.healthCheckHttpCode(2.0)
.healthCheckHttpVersion("HTTP/1.0")
.healthCheckHttpMethod("GET")
.deregisterTargetRst(false)
.idleConnectTimeout(900.0)
.build());
}
}
resources:
example:
type: tencentcloud:ClbListener
properties:
clbId: lb-qck8thny
listenerName: tf-example
port: 80
protocol: TCP
healthCheckSwitch: true
healthCheckTimeOut: 2
healthCheckIntervalTime: 5
healthCheckHealthNum: 3
healthCheckUnhealthNum: 3
sessionExpireTime: 30
scheduler: WRR
healthCheckPort: 200
healthCheckType: HTTP
healthCheckHttpPath: /
healthCheckHttpCode: 2
healthCheckHttpVersion: HTTP/1.0
healthCheckHttpMethod: GET
deregisterTargetRst: false
idleConnectTimeout: 900
Example coming soon!
TCP/UDP Listener with tcp health check
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const example = new tencentcloud.ClbListener("example", {
clbId: "lb-qck8thny",
listenerName: "tf-example",
port: 44,
protocol: "TCP",
healthCheckSwitch: true,
healthCheckTimeOut: 30,
healthCheckIntervalTime: 100,
healthCheckHealthNum: 2,
healthCheckUnhealthNum: 2,
sessionExpireTime: 30,
scheduler: "WRR",
healthCheckType: "TCP",
healthCheckPort: 200,
deregisterTargetRst: false,
idleConnectTimeout: 900,
});
import pulumi
import pulumi_tencentcloud as tencentcloud
example = tencentcloud.ClbListener("example",
clb_id="lb-qck8thny",
listener_name="tf-example",
port=44,
protocol="TCP",
health_check_switch=True,
health_check_time_out=30,
health_check_interval_time=100,
health_check_health_num=2,
health_check_unhealth_num=2,
session_expire_time=30,
scheduler="WRR",
health_check_type="TCP",
health_check_port=200,
deregister_target_rst=False,
idle_connect_timeout=900)
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.NewClbListener(ctx, "example", &tencentcloud.ClbListenerArgs{
ClbId: pulumi.String("lb-qck8thny"),
ListenerName: pulumi.String("tf-example"),
Port: pulumi.Float64(44),
Protocol: pulumi.String("TCP"),
HealthCheckSwitch: pulumi.Bool(true),
HealthCheckTimeOut: pulumi.Float64(30),
HealthCheckIntervalTime: pulumi.Float64(100),
HealthCheckHealthNum: pulumi.Float64(2),
HealthCheckUnhealthNum: pulumi.Float64(2),
SessionExpireTime: pulumi.Float64(30),
Scheduler: pulumi.String("WRR"),
HealthCheckType: pulumi.String("TCP"),
HealthCheckPort: pulumi.Float64(200),
DeregisterTargetRst: pulumi.Bool(false),
IdleConnectTimeout: pulumi.Float64(900),
})
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 example = new Tencentcloud.ClbListener("example", new()
{
ClbId = "lb-qck8thny",
ListenerName = "tf-example",
Port = 44,
Protocol = "TCP",
HealthCheckSwitch = true,
HealthCheckTimeOut = 30,
HealthCheckIntervalTime = 100,
HealthCheckHealthNum = 2,
HealthCheckUnhealthNum = 2,
SessionExpireTime = 30,
Scheduler = "WRR",
HealthCheckType = "TCP",
HealthCheckPort = 200,
DeregisterTargetRst = false,
IdleConnectTimeout = 900,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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) {
var example = new ClbListener("example", ClbListenerArgs.builder()
.clbId("lb-qck8thny")
.listenerName("tf-example")
.port(44.0)
.protocol("TCP")
.healthCheckSwitch(true)
.healthCheckTimeOut(30.0)
.healthCheckIntervalTime(100.0)
.healthCheckHealthNum(2.0)
.healthCheckUnhealthNum(2.0)
.sessionExpireTime(30.0)
.scheduler("WRR")
.healthCheckType("TCP")
.healthCheckPort(200.0)
.deregisterTargetRst(false)
.idleConnectTimeout(900.0)
.build());
}
}
resources:
example:
type: tencentcloud:ClbListener
properties:
clbId: lb-qck8thny
listenerName: tf-example
port: 44
protocol: TCP
healthCheckSwitch: true
healthCheckTimeOut: 30
healthCheckIntervalTime: 100
healthCheckHealthNum: 2
healthCheckUnhealthNum: 2
sessionExpireTime: 30
scheduler: WRR
healthCheckType: TCP
healthCheckPort: 200
deregisterTargetRst: false
idleConnectTimeout: 900
Example coming soon!
TCP/UDP Listener with http health check
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const example = new tencentcloud.ClbListener("example", {
clbId: "lb-qck8thny",
listenerName: "tf-example",
port: 44,
protocol: "TCP",
healthCheckSwitch: true,
healthCheckTimeOut: 30,
healthCheckIntervalTime: 100,
healthCheckHealthNum: 2,
healthCheckUnhealthNum: 2,
sessionExpireTime: 30,
scheduler: "WRR",
healthCheckType: "HTTP",
healthCheckHttpDomain: "www.tencent.com",
healthCheckHttpCode: 16,
healthCheckHttpVersion: "HTTP/1.1",
healthCheckHttpMethod: "HEAD",
healthCheckHttpPath: "/",
deregisterTargetRst: false,
idleConnectTimeout: 900,
});
import pulumi
import pulumi_tencentcloud as tencentcloud
example = tencentcloud.ClbListener("example",
clb_id="lb-qck8thny",
listener_name="tf-example",
port=44,
protocol="TCP",
health_check_switch=True,
health_check_time_out=30,
health_check_interval_time=100,
health_check_health_num=2,
health_check_unhealth_num=2,
session_expire_time=30,
scheduler="WRR",
health_check_type="HTTP",
health_check_http_domain="www.tencent.com",
health_check_http_code=16,
health_check_http_version="HTTP/1.1",
health_check_http_method="HEAD",
health_check_http_path="/",
deregister_target_rst=False,
idle_connect_timeout=900)
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.NewClbListener(ctx, "example", &tencentcloud.ClbListenerArgs{
ClbId: pulumi.String("lb-qck8thny"),
ListenerName: pulumi.String("tf-example"),
Port: pulumi.Float64(44),
Protocol: pulumi.String("TCP"),
HealthCheckSwitch: pulumi.Bool(true),
HealthCheckTimeOut: pulumi.Float64(30),
HealthCheckIntervalTime: pulumi.Float64(100),
HealthCheckHealthNum: pulumi.Float64(2),
HealthCheckUnhealthNum: pulumi.Float64(2),
SessionExpireTime: pulumi.Float64(30),
Scheduler: pulumi.String("WRR"),
HealthCheckType: pulumi.String("HTTP"),
HealthCheckHttpDomain: pulumi.String("www.tencent.com"),
HealthCheckHttpCode: pulumi.Float64(16),
HealthCheckHttpVersion: pulumi.String("HTTP/1.1"),
HealthCheckHttpMethod: pulumi.String("HEAD"),
HealthCheckHttpPath: pulumi.String("/"),
DeregisterTargetRst: pulumi.Bool(false),
IdleConnectTimeout: pulumi.Float64(900),
})
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 example = new Tencentcloud.ClbListener("example", new()
{
ClbId = "lb-qck8thny",
ListenerName = "tf-example",
Port = 44,
Protocol = "TCP",
HealthCheckSwitch = true,
HealthCheckTimeOut = 30,
HealthCheckIntervalTime = 100,
HealthCheckHealthNum = 2,
HealthCheckUnhealthNum = 2,
SessionExpireTime = 30,
Scheduler = "WRR",
HealthCheckType = "HTTP",
HealthCheckHttpDomain = "www.tencent.com",
HealthCheckHttpCode = 16,
HealthCheckHttpVersion = "HTTP/1.1",
HealthCheckHttpMethod = "HEAD",
HealthCheckHttpPath = "/",
DeregisterTargetRst = false,
IdleConnectTimeout = 900,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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) {
var example = new ClbListener("example", ClbListenerArgs.builder()
.clbId("lb-qck8thny")
.listenerName("tf-example")
.port(44.0)
.protocol("TCP")
.healthCheckSwitch(true)
.healthCheckTimeOut(30.0)
.healthCheckIntervalTime(100.0)
.healthCheckHealthNum(2.0)
.healthCheckUnhealthNum(2.0)
.sessionExpireTime(30.0)
.scheduler("WRR")
.healthCheckType("HTTP")
.healthCheckHttpDomain("www.tencent.com")
.healthCheckHttpCode(16.0)
.healthCheckHttpVersion("HTTP/1.1")
.healthCheckHttpMethod("HEAD")
.healthCheckHttpPath("/")
.deregisterTargetRst(false)
.idleConnectTimeout(900.0)
.build());
}
}
resources:
example:
type: tencentcloud:ClbListener
properties:
clbId: lb-qck8thny
listenerName: tf-example
port: 44
protocol: TCP
healthCheckSwitch: true
healthCheckTimeOut: 30
healthCheckIntervalTime: 100
healthCheckHealthNum: 2
healthCheckUnhealthNum: 2
sessionExpireTime: 30
scheduler: WRR
healthCheckType: HTTP
healthCheckHttpDomain: www.tencent.com
healthCheckHttpCode: 16
healthCheckHttpVersion: HTTP/1.1
healthCheckHttpMethod: HEAD
healthCheckHttpPath: /
deregisterTargetRst: false
idleConnectTimeout: 900
Example coming soon!
TCP/UDP Listener with customer health check
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const example = new tencentcloud.ClbListener("example", {
clbId: "lb-qck8thny",
listenerName: "tf-example",
port: 44,
protocol: "TCP",
healthCheckSwitch: true,
healthCheckTimeOut: 30,
healthCheckIntervalTime: 100,
healthCheckHealthNum: 2,
healthCheckUnhealthNum: 2,
sessionExpireTime: 30,
scheduler: "WRR",
healthCheckType: "CUSTOM",
healthCheckContextType: "HEX",
healthCheckSendContext: "0123456789ABCDEF",
healthCheckRecvContext: "ABCD",
targetType: "TARGETGROUP",
});
import pulumi
import pulumi_tencentcloud as tencentcloud
example = tencentcloud.ClbListener("example",
clb_id="lb-qck8thny",
listener_name="tf-example",
port=44,
protocol="TCP",
health_check_switch=True,
health_check_time_out=30,
health_check_interval_time=100,
health_check_health_num=2,
health_check_unhealth_num=2,
session_expire_time=30,
scheduler="WRR",
health_check_type="CUSTOM",
health_check_context_type="HEX",
health_check_send_context="0123456789ABCDEF",
health_check_recv_context="ABCD",
target_type="TARGETGROUP")
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.NewClbListener(ctx, "example", &tencentcloud.ClbListenerArgs{
ClbId: pulumi.String("lb-qck8thny"),
ListenerName: pulumi.String("tf-example"),
Port: pulumi.Float64(44),
Protocol: pulumi.String("TCP"),
HealthCheckSwitch: pulumi.Bool(true),
HealthCheckTimeOut: pulumi.Float64(30),
HealthCheckIntervalTime: pulumi.Float64(100),
HealthCheckHealthNum: pulumi.Float64(2),
HealthCheckUnhealthNum: pulumi.Float64(2),
SessionExpireTime: pulumi.Float64(30),
Scheduler: pulumi.String("WRR"),
HealthCheckType: pulumi.String("CUSTOM"),
HealthCheckContextType: pulumi.String("HEX"),
HealthCheckSendContext: pulumi.String("0123456789ABCDEF"),
HealthCheckRecvContext: pulumi.String("ABCD"),
TargetType: pulumi.String("TARGETGROUP"),
})
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 example = new Tencentcloud.ClbListener("example", new()
{
ClbId = "lb-qck8thny",
ListenerName = "tf-example",
Port = 44,
Protocol = "TCP",
HealthCheckSwitch = true,
HealthCheckTimeOut = 30,
HealthCheckIntervalTime = 100,
HealthCheckHealthNum = 2,
HealthCheckUnhealthNum = 2,
SessionExpireTime = 30,
Scheduler = "WRR",
HealthCheckType = "CUSTOM",
HealthCheckContextType = "HEX",
HealthCheckSendContext = "0123456789ABCDEF",
HealthCheckRecvContext = "ABCD",
TargetType = "TARGETGROUP",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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) {
var example = new ClbListener("example", ClbListenerArgs.builder()
.clbId("lb-qck8thny")
.listenerName("tf-example")
.port(44.0)
.protocol("TCP")
.healthCheckSwitch(true)
.healthCheckTimeOut(30.0)
.healthCheckIntervalTime(100.0)
.healthCheckHealthNum(2.0)
.healthCheckUnhealthNum(2.0)
.sessionExpireTime(30.0)
.scheduler("WRR")
.healthCheckType("CUSTOM")
.healthCheckContextType("HEX")
.healthCheckSendContext("0123456789ABCDEF")
.healthCheckRecvContext("ABCD")
.targetType("TARGETGROUP")
.build());
}
}
resources:
example:
type: tencentcloud:ClbListener
properties:
clbId: lb-qck8thny
listenerName: tf-example
port: 44
protocol: TCP
healthCheckSwitch: true
healthCheckTimeOut: 30
healthCheckIntervalTime: 100
healthCheckHealthNum: 2
healthCheckUnhealthNum: 2
sessionExpireTime: 30
scheduler: WRR
healthCheckType: CUSTOM
healthCheckContextType: HEX
healthCheckSendContext: 0123456789ABCDEF
healthCheckRecvContext: ABCD
targetType: TARGETGROUP
Example coming soon!
HTTPS Listener with sigle certificate
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const example = new tencentcloud.ClbListener("example", {
clbId: "lb-0lh5au7v",
listenerName: "tf-example",
port: 80,
protocol: "HTTPS",
certificateSslMode: "MUTUAL",
certificateId: "VjANRdz8",
certificateCaId: "VfqO4zkB",
sniSwitch: true,
});
import pulumi
import pulumi_tencentcloud as tencentcloud
example = tencentcloud.ClbListener("example",
clb_id="lb-0lh5au7v",
listener_name="tf-example",
port=80,
protocol="HTTPS",
certificate_ssl_mode="MUTUAL",
certificate_id="VjANRdz8",
certificate_ca_id="VfqO4zkB",
sni_switch=True)
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.NewClbListener(ctx, "example", &tencentcloud.ClbListenerArgs{
ClbId: pulumi.String("lb-0lh5au7v"),
ListenerName: pulumi.String("tf-example"),
Port: pulumi.Float64(80),
Protocol: pulumi.String("HTTPS"),
CertificateSslMode: pulumi.String("MUTUAL"),
CertificateId: pulumi.String("VjANRdz8"),
CertificateCaId: pulumi.String("VfqO4zkB"),
SniSwitch: pulumi.Bool(true),
})
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 example = new Tencentcloud.ClbListener("example", new()
{
ClbId = "lb-0lh5au7v",
ListenerName = "tf-example",
Port = 80,
Protocol = "HTTPS",
CertificateSslMode = "MUTUAL",
CertificateId = "VjANRdz8",
CertificateCaId = "VfqO4zkB",
SniSwitch = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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) {
var example = new ClbListener("example", ClbListenerArgs.builder()
.clbId("lb-0lh5au7v")
.listenerName("tf-example")
.port(80.0)
.protocol("HTTPS")
.certificateSslMode("MUTUAL")
.certificateId("VjANRdz8")
.certificateCaId("VfqO4zkB")
.sniSwitch(true)
.build());
}
}
resources:
example:
type: tencentcloud:ClbListener
properties:
clbId: lb-0lh5au7v
listenerName: tf-example
port: '80'
protocol: HTTPS
certificateSslMode: MUTUAL
certificateId: VjANRdz8
certificateCaId: VfqO4zkB
sniSwitch: true
Example coming soon!
HTTPS Listener with multi certificates
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const example = new tencentcloud.ClbListener("example", {
clbId: "lb-l6cp6jt4",
listenerName: "tf-example",
port: 80,
protocol: "HTTPS",
sniSwitch: true,
multiCertInfo: {
sslMode: "UNIDIRECTIONAL",
certIdLists: [
"LCYouprI",
"JVO1alRN",
],
},
});
import pulumi
import pulumi_tencentcloud as tencentcloud
example = tencentcloud.ClbListener("example",
clb_id="lb-l6cp6jt4",
listener_name="tf-example",
port=80,
protocol="HTTPS",
sni_switch=True,
multi_cert_info={
"ssl_mode": "UNIDIRECTIONAL",
"cert_id_lists": [
"LCYouprI",
"JVO1alRN",
],
})
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.NewClbListener(ctx, "example", &tencentcloud.ClbListenerArgs{
ClbId: pulumi.String("lb-l6cp6jt4"),
ListenerName: pulumi.String("tf-example"),
Port: pulumi.Float64(80),
Protocol: pulumi.String("HTTPS"),
SniSwitch: pulumi.Bool(true),
MultiCertInfo: &tencentcloud.ClbListenerMultiCertInfoArgs{
SslMode: pulumi.String("UNIDIRECTIONAL"),
CertIdLists: pulumi.StringArray{
pulumi.String("LCYouprI"),
pulumi.String("JVO1alRN"),
},
},
})
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 example = new Tencentcloud.ClbListener("example", new()
{
ClbId = "lb-l6cp6jt4",
ListenerName = "tf-example",
Port = 80,
Protocol = "HTTPS",
SniSwitch = true,
MultiCertInfo = new Tencentcloud.Inputs.ClbListenerMultiCertInfoArgs
{
SslMode = "UNIDIRECTIONAL",
CertIdLists = new[]
{
"LCYouprI",
"JVO1alRN",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
import com.pulumi.tencentcloud.inputs.ClbListenerMultiCertInfoArgs;
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) {
var example = new ClbListener("example", ClbListenerArgs.builder()
.clbId("lb-l6cp6jt4")
.listenerName("tf-example")
.port(80.0)
.protocol("HTTPS")
.sniSwitch(true)
.multiCertInfo(ClbListenerMultiCertInfoArgs.builder()
.sslMode("UNIDIRECTIONAL")
.certIdLists(
"LCYouprI",
"JVO1alRN")
.build())
.build());
}
}
resources:
example:
type: tencentcloud:ClbListener
properties:
clbId: lb-l6cp6jt4
listenerName: tf-example
port: '80'
protocol: HTTPS
sniSwitch: true
multiCertInfo:
sslMode: UNIDIRECTIONAL
certIdLists:
- LCYouprI
- JVO1alRN
Example coming soon!
TCP SSL Listener
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const example = new tencentcloud.ClbListener("example", {
clbId: "lb-0lh5au7v",
listenerName: "tf-example",
port: 80,
protocol: "TCP_SSL",
certificateSslMode: "MUTUAL",
certificateId: "VjANRdz8",
certificateCaId: "VfqO4zkB",
healthCheckSwitch: true,
healthCheckTimeOut: 2,
healthCheckIntervalTime: 5,
healthCheckHealthNum: 3,
healthCheckUnhealthNum: 3,
scheduler: "WRR",
targetType: "TARGETGROUP",
});
import pulumi
import pulumi_tencentcloud as tencentcloud
example = tencentcloud.ClbListener("example",
clb_id="lb-0lh5au7v",
listener_name="tf-example",
port=80,
protocol="TCP_SSL",
certificate_ssl_mode="MUTUAL",
certificate_id="VjANRdz8",
certificate_ca_id="VfqO4zkB",
health_check_switch=True,
health_check_time_out=2,
health_check_interval_time=5,
health_check_health_num=3,
health_check_unhealth_num=3,
scheduler="WRR",
target_type="TARGETGROUP")
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.NewClbListener(ctx, "example", &tencentcloud.ClbListenerArgs{
ClbId: pulumi.String("lb-0lh5au7v"),
ListenerName: pulumi.String("tf-example"),
Port: pulumi.Float64(80),
Protocol: pulumi.String("TCP_SSL"),
CertificateSslMode: pulumi.String("MUTUAL"),
CertificateId: pulumi.String("VjANRdz8"),
CertificateCaId: pulumi.String("VfqO4zkB"),
HealthCheckSwitch: pulumi.Bool(true),
HealthCheckTimeOut: pulumi.Float64(2),
HealthCheckIntervalTime: pulumi.Float64(5),
HealthCheckHealthNum: pulumi.Float64(3),
HealthCheckUnhealthNum: pulumi.Float64(3),
Scheduler: pulumi.String("WRR"),
TargetType: pulumi.String("TARGETGROUP"),
})
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 example = new Tencentcloud.ClbListener("example", new()
{
ClbId = "lb-0lh5au7v",
ListenerName = "tf-example",
Port = 80,
Protocol = "TCP_SSL",
CertificateSslMode = "MUTUAL",
CertificateId = "VjANRdz8",
CertificateCaId = "VfqO4zkB",
HealthCheckSwitch = true,
HealthCheckTimeOut = 2,
HealthCheckIntervalTime = 5,
HealthCheckHealthNum = 3,
HealthCheckUnhealthNum = 3,
Scheduler = "WRR",
TargetType = "TARGETGROUP",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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) {
var example = new ClbListener("example", ClbListenerArgs.builder()
.clbId("lb-0lh5au7v")
.listenerName("tf-example")
.port(80.0)
.protocol("TCP_SSL")
.certificateSslMode("MUTUAL")
.certificateId("VjANRdz8")
.certificateCaId("VfqO4zkB")
.healthCheckSwitch(true)
.healthCheckTimeOut(2.0)
.healthCheckIntervalTime(5.0)
.healthCheckHealthNum(3.0)
.healthCheckUnhealthNum(3.0)
.scheduler("WRR")
.targetType("TARGETGROUP")
.build());
}
}
resources:
example:
type: tencentcloud:ClbListener
properties:
clbId: lb-0lh5au7v
listenerName: tf-example
port: '80'
protocol: TCP_SSL
certificateSslMode: MUTUAL
certificateId: VjANRdz8
certificateCaId: VfqO4zkB
healthCheckSwitch: true
healthCheckTimeOut: 2
healthCheckIntervalTime: 5
healthCheckHealthNum: 3
healthCheckUnhealthNum: 3
scheduler: WRR
targetType: TARGETGROUP
Example coming soon!
TCP_SSL Listener with MaxConn, MaxCps, ProxyProtocol
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const example = new tencentcloud.ClbListener("example", {
clbId: "lb-0lh5au7v",
listenerName: "tf-example",
port: 443,
protocol: "TCP_SSL",
certificateSslMode: "UNIDIRECTIONAL",
certificateId: "VjANRdz8",
scheduler: "WRR",
maxConn: 1000,
maxCps: 100,
proxyProtocol: true,
});
import pulumi
import pulumi_tencentcloud as tencentcloud
example = tencentcloud.ClbListener("example",
clb_id="lb-0lh5au7v",
listener_name="tf-example",
port=443,
protocol="TCP_SSL",
certificate_ssl_mode="UNIDIRECTIONAL",
certificate_id="VjANRdz8",
scheduler="WRR",
max_conn=1000,
max_cps=100,
proxy_protocol=True)
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.NewClbListener(ctx, "example", &tencentcloud.ClbListenerArgs{
ClbId: pulumi.String("lb-0lh5au7v"),
ListenerName: pulumi.String("tf-example"),
Port: pulumi.Float64(443),
Protocol: pulumi.String("TCP_SSL"),
CertificateSslMode: pulumi.String("UNIDIRECTIONAL"),
CertificateId: pulumi.String("VjANRdz8"),
Scheduler: pulumi.String("WRR"),
MaxConn: pulumi.Float64(1000),
MaxCps: pulumi.Float64(100),
ProxyProtocol: pulumi.Bool(true),
})
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 example = new Tencentcloud.ClbListener("example", new()
{
ClbId = "lb-0lh5au7v",
ListenerName = "tf-example",
Port = 443,
Protocol = "TCP_SSL",
CertificateSslMode = "UNIDIRECTIONAL",
CertificateId = "VjANRdz8",
Scheduler = "WRR",
MaxConn = 1000,
MaxCps = 100,
ProxyProtocol = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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) {
var example = new ClbListener("example", ClbListenerArgs.builder()
.clbId("lb-0lh5au7v")
.listenerName("tf-example")
.port(443.0)
.protocol("TCP_SSL")
.certificateSslMode("UNIDIRECTIONAL")
.certificateId("VjANRdz8")
.scheduler("WRR")
.maxConn(1000.0)
.maxCps(100.0)
.proxyProtocol(true)
.build());
}
}
resources:
example:
type: tencentcloud:ClbListener
properties:
clbId: lb-0lh5au7v
listenerName: tf-example
port: '443'
protocol: TCP_SSL
certificateSslMode: UNIDIRECTIONAL
certificateId: VjANRdz8
scheduler: WRR
maxConn: 1000
maxCps: 100
proxyProtocol: true
Example coming soon!
Port Range Listener
import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";
const example = new tencentcloud.ClbInstance("example", {
clbName: "tf-listener-test",
networkType: "OPEN",
});
const exampleClbListener = new tencentcloud.ClbListener("example", {
clbId: example.clbInstanceId,
listenerName: "tf-example",
port: 1,
endPort: 6,
protocol: "TCP",
sessionExpireTime: 30,
scheduler: "WRR",
targetType: "NODE",
});
import pulumi
import pulumi_tencentcloud as tencentcloud
example = tencentcloud.ClbInstance("example",
clb_name="tf-listener-test",
network_type="OPEN")
example_clb_listener = tencentcloud.ClbListener("example",
clb_id=example.clb_instance_id,
listener_name="tf-example",
port=1,
end_port=6,
protocol="TCP",
session_expire_time=30,
scheduler="WRR",
target_type="NODE")
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 {
example, err := tencentcloud.NewClbInstance(ctx, "example", &tencentcloud.ClbInstanceArgs{
ClbName: pulumi.String("tf-listener-test"),
NetworkType: pulumi.String("OPEN"),
})
if err != nil {
return err
}
_, err = tencentcloud.NewClbListener(ctx, "example", &tencentcloud.ClbListenerArgs{
ClbId: example.ClbInstanceId,
ListenerName: pulumi.String("tf-example"),
Port: pulumi.Float64(1),
EndPort: pulumi.Float64(6),
Protocol: pulumi.String("TCP"),
SessionExpireTime: pulumi.Float64(30),
Scheduler: pulumi.String("WRR"),
TargetType: pulumi.String("NODE"),
})
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 example = new Tencentcloud.ClbInstance("example", new()
{
ClbName = "tf-listener-test",
NetworkType = "OPEN",
});
var exampleClbListener = new Tencentcloud.ClbListener("example", new()
{
ClbId = example.ClbInstanceId,
ListenerName = "tf-example",
Port = 1,
EndPort = 6,
Protocol = "TCP",
SessionExpireTime = 30,
Scheduler = "WRR",
TargetType = "NODE",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClbInstance;
import com.pulumi.tencentcloud.ClbInstanceArgs;
import com.pulumi.tencentcloud.ClbListener;
import com.pulumi.tencentcloud.ClbListenerArgs;
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) {
var example = new ClbInstance("example", ClbInstanceArgs.builder()
.clbName("tf-listener-test")
.networkType("OPEN")
.build());
var exampleClbListener = new ClbListener("exampleClbListener", ClbListenerArgs.builder()
.clbId(example.clbInstanceId())
.listenerName("tf-example")
.port(1.0)
.endPort(6.0)
.protocol("TCP")
.sessionExpireTime(30.0)
.scheduler("WRR")
.targetType("NODE")
.build());
}
}
resources:
example:
type: tencentcloud:ClbInstance
properties:
clbName: tf-listener-test
networkType: OPEN
exampleClbListener:
type: tencentcloud:ClbListener
name: example
properties:
clbId: ${example.clbInstanceId}
listenerName: tf-example
port: 1
endPort: 6
protocol: TCP
sessionExpireTime: 30
scheduler: WRR
targetType: NODE
Example coming soon!
API Reference
This resource interacts with the following TencentCloud APIs:
- Create: CreateListener
- Read: DescribeListeners
- Update: ModifyListener
- Delete: DeleteListener
Create ClbListener Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClbListener(name: string, args: ClbListenerArgs, opts?: CustomResourceOptions);@overload
def ClbListener(resource_name: str,
args: ClbListenerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ClbListener(resource_name: str,
opts: Optional[ResourceOptions] = None,
clb_id: Optional[str] = None,
protocol: Optional[str] = None,
listener_name: Optional[str] = None,
health_check_type: Optional[str] = None,
health_source_ip_type: Optional[float] = None,
idle_connect_timeout: Optional[float] = None,
deregister_target_rst: Optional[bool] = None,
end_port: Optional[float] = None,
h2c_switch: Optional[bool] = None,
health_check_context_type: Optional[str] = None,
health_check_health_num: Optional[float] = None,
health_check_http_code: Optional[float] = None,
health_check_http_domain: Optional[str] = None,
health_check_http_method: Optional[str] = None,
health_check_http_path: Optional[str] = None,
health_check_http_version: Optional[str] = None,
health_check_interval_time: Optional[float] = None,
health_check_port: Optional[float] = None,
health_check_recv_context: Optional[str] = None,
health_check_send_context: Optional[str] = None,
health_check_switch: Optional[bool] = None,
health_check_time_out: Optional[float] = None,
certificate_ca_id: Optional[str] = None,
clb_listener_id: Optional[str] = None,
health_check_unhealth_num: Optional[float] = None,
data_compress_mode: Optional[str] = None,
keepalive_enable: Optional[float] = None,
certificate_ssl_mode: Optional[str] = None,
max_conn: Optional[float] = None,
max_cps: Optional[float] = None,
multi_cert_info: Optional[ClbListenerMultiCertInfoArgs] = None,
port: Optional[float] = None,
certificate_id: Optional[str] = None,
proxy_protocol: Optional[bool] = None,
reschedule_expand_target: Optional[bool] = None,
reschedule_interval: Optional[float] = None,
reschedule_start_time: Optional[float] = None,
reschedule_target_zero_weight: Optional[bool] = None,
reschedule_unhealthy: Optional[bool] = None,
scheduler: Optional[str] = None,
session_expire_time: Optional[float] = None,
session_type: Optional[str] = None,
snat_enable: Optional[bool] = None,
sni_switch: Optional[bool] = None,
target_type: Optional[str] = None)func NewClbListener(ctx *Context, name string, args ClbListenerArgs, opts ...ResourceOption) (*ClbListener, error)public ClbListener(string name, ClbListenerArgs args, CustomResourceOptions? opts = null)
public ClbListener(String name, ClbListenerArgs args)
public ClbListener(String name, ClbListenerArgs args, CustomResourceOptions options)
type: tencentcloud:ClbListener
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "tencentcloud_clb_listener" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ClbListenerArgs
- 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 ClbListenerArgs
- 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 ClbListenerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClbListenerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClbListenerArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ClbListener 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 ClbListener resource accepts the following input properties:
- Clb
Id string - ID of the CLB instance.
- Listener
Name string - Name of the CLB listener, 1-80 characters. Supports letters, Chinese and other common international language characters, digits, hyphen '-' and underscore '_' (Unicode supplementary characters such as emoji are not allowed).
- Protocol string
- Type of protocol within the listener. Valid values:
TCP,UDP,HTTP,HTTPS,TCP_SSLandQUIC. - Certificate
Ca stringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when the ssl mode isMUTUAL. - Certificate
Id string - ID of the server certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when it is available. - Certificate
Ssl stringMode - Type of certificate. Valid values:
UNIDIRECTIONAL,MUTUAL. NOTES: Only supports listeners ofHTTPSandTCP_SSLprotocol and must be set when it is available. - Clb
Listener stringId - ID of the resource.
- Data
Compress stringMode - Data compression mode. Valid values:
transparent,compatibility. - Deregister
Target boolRst - Reschedule function: the switch for unbinding backend services. When enabled, rescheduling is triggered when a backend service is unbound. Only supported by
TCP/UDPlisteners. - End
Port double - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Portsparameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - H2c
Switch bool - Whether to enable H2C for intranet
HTTPlisteners.true: enable,false: disable (default). When enabled, the listener only supports creating L7 rules with backend forwarding typeGRPCorGRPCS;GRPCorGRPCSmust be explicitly specified in the forwarding type when creating rules. - Health
Check stringContext Type - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the input format of the health check. Valid values:HEX,TEXT. WhenHEX, the characters ofsend_context/recv_contextcan only be selected from0123456789ABCDEFand the length must be even. Only applicable toTCP/UDPlisteners. - Health
Check doubleHealth Num - Health threshold. Default 3, meaning the backend is considered healthy after 3 consecutive successful probes. Value range: 2-10.
- Health
Check doubleHttp Code - Health check status code (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Value range: 1-31, default 31.
1=1xx healthy,2=2xx,4=3xx,8=4xx,16=5xx. To treat multiple return codes as healthy, add the corresponding values together. - Health
Check stringHttp Domain - Health check domain, carried in the HTTP Host header (only applicable to HTTP/HTTPS listeners and the HTTP health check method of TCP listeners; for TCP listeners using HTTP health check, this field is required).
- Health
Check stringHttp Method - Health check method (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Default
HEAD. Valid values:HEAD,GET. - Health
Check stringHttp Path - Health check path (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners).
- Health
Check stringHttp Version - HTTP version of the backend service. Required when
health_check_typeisHTTP. Valid values:HTTP/1.0,HTTP/1.1. Only applicable toTCPlisteners. - Health
Check doubleInterval Time - Health check probe interval in seconds. Default 5. Value range: 2-300 for IPv4 CLB instances and 5-300 for IPv6 CLB instances. Note: some older IPv4 CLB instances have a range of 5-300.
- Health
Check doublePort - Health check port. Defaults to the backend service port; leave blank unless a specific port is required. Pass
-1to restore the default. Only applicable toTCP/UDPlisteners. - Health
Check stringRecv Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the result returned by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - Health
Check stringSend Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the request content sent by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - Health
Check boolSwitch - Indicates whether health check is enabled.
- Health
Check doubleTime Out - Response timeout of health check in seconds. Value range: 2-60, default 2. The response timeout must be less than the check interval.
- Health
Check stringType - Health check protocol. Valid values:
TCP,HTTP,HTTPS,GRPC,PING,CUSTOM. UDP listeners supportPING/CUSTOM; TCP listeners supportTCP/HTTP/CUSTOM; TCP_SSL/QUIC listeners supportTCP/HTTP; HTTP rules supportHTTP/GRPC; HTTPS rules supportHTTP/HTTPS/GRPC. Defaults:HTTPfor HTTP listeners,TCPfor TCP/TCP_SSL/QUIC listeners,PINGfor UDP listeners; for HTTPS listeners the default matches the backend forwarding protocol. - Health
Check doubleUnhealth Num - Unhealthy threshold. Default 3, meaning the backend is considered unhealthy after 3 consecutive failed probes. Value range: 2-10.
- Health
Source doubleIp Type - Health check source IP type.
0: use the CLB VIP as the source IP,1: use a 100.64 IP range as the source IP. - Idle
Connect doubleTimeout - Idle connection timeout. This parameter is only available for TCP/UDP listeners, in seconds. Default: 900s for TCP listeners, 300s for UDP listeners. Value range: 10-900 for shared and dedicated instances; 10-1980 for LCU-supported CLB instances. To set a value beyond the range, please submit a ticket for application.
- Keepalive
Enable double - Whether to enable persistent connection (long connection). Only applicable to
HTTP/HTTPSlisteners. Valid values:0(disable, default),1(enable). This feature is currently in beta. - Max
Conn double - Listener-level maximum concurrent connections. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- Max
Cps double - Listener-level maximum new connections per second. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- Multi
Cert ClbInfo Listener Multi Cert Info - Certificate information, supporting multiple server certificates with different algorithm types at the same time. Only applicable to
TCP_SSLlisteners andHTTPSlisteners with SNI disabled. When creating aTCP_SSLlistener or anHTTPSlistener with SNI disabled, at least one ofcertificate/multi_cert_infomust be specified, but they cannot be specified at the same time. - Port double
- Port of the CLB listener. Port range: [1 - 65535].
- Proxy
Protocol bool - Enable proxy protocol for TCP_SSL and QUIC listeners. Note: this field is not returned by the DescribeListeners API, so it will not be refreshed in state after creation.
- Reschedule
Expand boolTarget - The rescheduling function, a switch for scaling backend services, triggers rescheduling when backend servers are added or removed. Only supported by TCP/UDP listeners.
- Reschedule
Interval double - Rescheduled trigger duration, ranging from 0 to 3600 seconds. Supported only by TCP/UDP listeners.
- Reschedule
Start doubleTime - Reschedule the trigger start time, with a value ranging from 0 to 3600 seconds. Only supported by TCP/UDP listeners.
- Reschedule
Target boolZero Weight - The rescheduling function, with a weight of 0 as a switch, triggers rescheduling when the weight of the backend server is set to 0. Only supported by TCP/UDP listeners.
- Reschedule
Unhealthy bool - Rescheduling function, health check exception switch. Enabling this switch triggers rescheduling when a backend server fails a health check. Supported only by TCP/UDP listeners.
- Scheduler string
- Scheduling method. Valid values:
WRR(weighted round-robin),LEAST_CONN(least connections). Default isWRR. Only applicable toTCP/UDP/TCP_SSL/QUIClisteners. - Session
Expire doubleTime - Session persistence time in seconds. Value range: 30-3600, default 0 (disabled). Only applicable to
TCP/UDPlisteners. - Session
Type string - Session persistence type.
NORMAL(default): default session persistence type;QUIC_CID: session persistence by QUIC connection ID. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule. IfQUIC_CIDis selected,protocolmust beUDP,schedulermust beWRR, and only IPv4 is supported. - Snat
Enable bool - Whether to enable SNAT (source IP replacement).
true: enable,false: disable (default). Note: when SNAT is enabled, the client source IP is replaced and the pass-through client source IP option is disabled, and vice versa. - Sni
Switch bool - Indicates whether SNI is enabled. Only applicable to
HTTPSlisteners.0: disabled,1: enabled. - Target
Type string - Backend target type. Valid values:
NODE,TARGETGROUP,TARGETGROUP-V2.NODEmeans binding ordinary nodes,TARGETGROUPmeans binding a target group. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule.
- Clb
Id string - ID of the CLB instance.
- Listener
Name string - Name of the CLB listener, 1-80 characters. Supports letters, Chinese and other common international language characters, digits, hyphen '-' and underscore '_' (Unicode supplementary characters such as emoji are not allowed).
- Protocol string
- Type of protocol within the listener. Valid values:
TCP,UDP,HTTP,HTTPS,TCP_SSLandQUIC. - Certificate
Ca stringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when the ssl mode isMUTUAL. - Certificate
Id string - ID of the server certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when it is available. - Certificate
Ssl stringMode - Type of certificate. Valid values:
UNIDIRECTIONAL,MUTUAL. NOTES: Only supports listeners ofHTTPSandTCP_SSLprotocol and must be set when it is available. - Clb
Listener stringId - ID of the resource.
- Data
Compress stringMode - Data compression mode. Valid values:
transparent,compatibility. - Deregister
Target boolRst - Reschedule function: the switch for unbinding backend services. When enabled, rescheduling is triggered when a backend service is unbound. Only supported by
TCP/UDPlisteners. - End
Port float64 - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Portsparameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - H2c
Switch bool - Whether to enable H2C for intranet
HTTPlisteners.true: enable,false: disable (default). When enabled, the listener only supports creating L7 rules with backend forwarding typeGRPCorGRPCS;GRPCorGRPCSmust be explicitly specified in the forwarding type when creating rules. - Health
Check stringContext Type - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the input format of the health check. Valid values:HEX,TEXT. WhenHEX, the characters ofsend_context/recv_contextcan only be selected from0123456789ABCDEFand the length must be even. Only applicable toTCP/UDPlisteners. - Health
Check float64Health Num - Health threshold. Default 3, meaning the backend is considered healthy after 3 consecutive successful probes. Value range: 2-10.
- Health
Check float64Http Code - Health check status code (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Value range: 1-31, default 31.
1=1xx healthy,2=2xx,4=3xx,8=4xx,16=5xx. To treat multiple return codes as healthy, add the corresponding values together. - Health
Check stringHttp Domain - Health check domain, carried in the HTTP Host header (only applicable to HTTP/HTTPS listeners and the HTTP health check method of TCP listeners; for TCP listeners using HTTP health check, this field is required).
- Health
Check stringHttp Method - Health check method (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Default
HEAD. Valid values:HEAD,GET. - Health
Check stringHttp Path - Health check path (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners).
- Health
Check stringHttp Version - HTTP version of the backend service. Required when
health_check_typeisHTTP. Valid values:HTTP/1.0,HTTP/1.1. Only applicable toTCPlisteners. - Health
Check float64Interval Time - Health check probe interval in seconds. Default 5. Value range: 2-300 for IPv4 CLB instances and 5-300 for IPv6 CLB instances. Note: some older IPv4 CLB instances have a range of 5-300.
- Health
Check float64Port - Health check port. Defaults to the backend service port; leave blank unless a specific port is required. Pass
-1to restore the default. Only applicable toTCP/UDPlisteners. - Health
Check stringRecv Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the result returned by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - Health
Check stringSend Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the request content sent by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - Health
Check boolSwitch - Indicates whether health check is enabled.
- Health
Check float64Time Out - Response timeout of health check in seconds. Value range: 2-60, default 2. The response timeout must be less than the check interval.
- Health
Check stringType - Health check protocol. Valid values:
TCP,HTTP,HTTPS,GRPC,PING,CUSTOM. UDP listeners supportPING/CUSTOM; TCP listeners supportTCP/HTTP/CUSTOM; TCP_SSL/QUIC listeners supportTCP/HTTP; HTTP rules supportHTTP/GRPC; HTTPS rules supportHTTP/HTTPS/GRPC. Defaults:HTTPfor HTTP listeners,TCPfor TCP/TCP_SSL/QUIC listeners,PINGfor UDP listeners; for HTTPS listeners the default matches the backend forwarding protocol. - Health
Check float64Unhealth Num - Unhealthy threshold. Default 3, meaning the backend is considered unhealthy after 3 consecutive failed probes. Value range: 2-10.
- Health
Source float64Ip Type - Health check source IP type.
0: use the CLB VIP as the source IP,1: use a 100.64 IP range as the source IP. - Idle
Connect float64Timeout - Idle connection timeout. This parameter is only available for TCP/UDP listeners, in seconds. Default: 900s for TCP listeners, 300s for UDP listeners. Value range: 10-900 for shared and dedicated instances; 10-1980 for LCU-supported CLB instances. To set a value beyond the range, please submit a ticket for application.
- Keepalive
Enable float64 - Whether to enable persistent connection (long connection). Only applicable to
HTTP/HTTPSlisteners. Valid values:0(disable, default),1(enable). This feature is currently in beta. - Max
Conn float64 - Listener-level maximum concurrent connections. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- Max
Cps float64 - Listener-level maximum new connections per second. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- Multi
Cert ClbInfo Listener Multi Cert Info Args - Certificate information, supporting multiple server certificates with different algorithm types at the same time. Only applicable to
TCP_SSLlisteners andHTTPSlisteners with SNI disabled. When creating aTCP_SSLlistener or anHTTPSlistener with SNI disabled, at least one ofcertificate/multi_cert_infomust be specified, but they cannot be specified at the same time. - Port float64
- Port of the CLB listener. Port range: [1 - 65535].
- Proxy
Protocol bool - Enable proxy protocol for TCP_SSL and QUIC listeners. Note: this field is not returned by the DescribeListeners API, so it will not be refreshed in state after creation.
- Reschedule
Expand boolTarget - The rescheduling function, a switch for scaling backend services, triggers rescheduling when backend servers are added or removed. Only supported by TCP/UDP listeners.
- Reschedule
Interval float64 - Rescheduled trigger duration, ranging from 0 to 3600 seconds. Supported only by TCP/UDP listeners.
- Reschedule
Start float64Time - Reschedule the trigger start time, with a value ranging from 0 to 3600 seconds. Only supported by TCP/UDP listeners.
- Reschedule
Target boolZero Weight - The rescheduling function, with a weight of 0 as a switch, triggers rescheduling when the weight of the backend server is set to 0. Only supported by TCP/UDP listeners.
- Reschedule
Unhealthy bool - Rescheduling function, health check exception switch. Enabling this switch triggers rescheduling when a backend server fails a health check. Supported only by TCP/UDP listeners.
- Scheduler string
- Scheduling method. Valid values:
WRR(weighted round-robin),LEAST_CONN(least connections). Default isWRR. Only applicable toTCP/UDP/TCP_SSL/QUIClisteners. - Session
Expire float64Time - Session persistence time in seconds. Value range: 30-3600, default 0 (disabled). Only applicable to
TCP/UDPlisteners. - Session
Type string - Session persistence type.
NORMAL(default): default session persistence type;QUIC_CID: session persistence by QUIC connection ID. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule. IfQUIC_CIDis selected,protocolmust beUDP,schedulermust beWRR, and only IPv4 is supported. - Snat
Enable bool - Whether to enable SNAT (source IP replacement).
true: enable,false: disable (default). Note: when SNAT is enabled, the client source IP is replaced and the pass-through client source IP option is disabled, and vice versa. - Sni
Switch bool - Indicates whether SNI is enabled. Only applicable to
HTTPSlisteners.0: disabled,1: enabled. - Target
Type string - Backend target type. Valid values:
NODE,TARGETGROUP,TARGETGROUP-V2.NODEmeans binding ordinary nodes,TARGETGROUPmeans binding a target group. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule.
- clb_
id string - ID of the CLB instance.
- listener_
name string - Name of the CLB listener, 1-80 characters. Supports letters, Chinese and other common international language characters, digits, hyphen '-' and underscore '_' (Unicode supplementary characters such as emoji are not allowed).
- protocol string
- Type of protocol within the listener. Valid values:
TCP,UDP,HTTP,HTTPS,TCP_SSLandQUIC. - certificate_
ca_ stringid - ID of the client certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when the ssl mode isMUTUAL. - certificate_
id string - ID of the server certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when it is available. - certificate_
ssl_ stringmode - Type of certificate. Valid values:
UNIDIRECTIONAL,MUTUAL. NOTES: Only supports listeners ofHTTPSandTCP_SSLprotocol and must be set when it is available. - clb_
listener_ stringid - ID of the resource.
- data_
compress_ stringmode - Data compression mode. Valid values:
transparent,compatibility. - deregister_
target_ boolrst - Reschedule function: the switch for unbinding backend services. When enabled, rescheduling is triggered when a backend service is unbound. Only supported by
TCP/UDPlisteners. - end_
port number - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Portsparameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c_
switch bool - Whether to enable H2C for intranet
HTTPlisteners.true: enable,false: disable (default). When enabled, the listener only supports creating L7 rules with backend forwarding typeGRPCorGRPCS;GRPCorGRPCSmust be explicitly specified in the forwarding type when creating rules. - health_
check_ stringcontext_ type - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the input format of the health check. Valid values:HEX,TEXT. WhenHEX, the characters ofsend_context/recv_contextcan only be selected from0123456789ABCDEFand the length must be even. Only applicable toTCP/UDPlisteners. - health_
check_ numberhealth_ num - Health threshold. Default 3, meaning the backend is considered healthy after 3 consecutive successful probes. Value range: 2-10.
- health_
check_ numberhttp_ code - Health check status code (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Value range: 1-31, default 31.
1=1xx healthy,2=2xx,4=3xx,8=4xx,16=5xx. To treat multiple return codes as healthy, add the corresponding values together. - health_
check_ stringhttp_ domain - Health check domain, carried in the HTTP Host header (only applicable to HTTP/HTTPS listeners and the HTTP health check method of TCP listeners; for TCP listeners using HTTP health check, this field is required).
- health_
check_ stringhttp_ method - Health check method (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Default
HEAD. Valid values:HEAD,GET. - health_
check_ stringhttp_ path - Health check path (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners).
- health_
check_ stringhttp_ version - HTTP version of the backend service. Required when
health_check_typeisHTTP. Valid values:HTTP/1.0,HTTP/1.1. Only applicable toTCPlisteners. - health_
check_ numberinterval_ time - Health check probe interval in seconds. Default 5. Value range: 2-300 for IPv4 CLB instances and 5-300 for IPv6 CLB instances. Note: some older IPv4 CLB instances have a range of 5-300.
- health_
check_ numberport - Health check port. Defaults to the backend service port; leave blank unless a specific port is required. Pass
-1to restore the default. Only applicable toTCP/UDPlisteners. - health_
check_ stringrecv_ context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the result returned by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health_
check_ stringsend_ context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the request content sent by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health_
check_ boolswitch - Indicates whether health check is enabled.
- health_
check_ numbertime_ out - Response timeout of health check in seconds. Value range: 2-60, default 2. The response timeout must be less than the check interval.
- health_
check_ stringtype - Health check protocol. Valid values:
TCP,HTTP,HTTPS,GRPC,PING,CUSTOM. UDP listeners supportPING/CUSTOM; TCP listeners supportTCP/HTTP/CUSTOM; TCP_SSL/QUIC listeners supportTCP/HTTP; HTTP rules supportHTTP/GRPC; HTTPS rules supportHTTP/HTTPS/GRPC. Defaults:HTTPfor HTTP listeners,TCPfor TCP/TCP_SSL/QUIC listeners,PINGfor UDP listeners; for HTTPS listeners the default matches the backend forwarding protocol. - health_
check_ numberunhealth_ num - Unhealthy threshold. Default 3, meaning the backend is considered unhealthy after 3 consecutive failed probes. Value range: 2-10.
- health_
source_ numberip_ type - Health check source IP type.
0: use the CLB VIP as the source IP,1: use a 100.64 IP range as the source IP. - idle_
connect_ numbertimeout - Idle connection timeout. This parameter is only available for TCP/UDP listeners, in seconds. Default: 900s for TCP listeners, 300s for UDP listeners. Value range: 10-900 for shared and dedicated instances; 10-1980 for LCU-supported CLB instances. To set a value beyond the range, please submit a ticket for application.
- keepalive_
enable number - Whether to enable persistent connection (long connection). Only applicable to
HTTP/HTTPSlisteners. Valid values:0(disable, default),1(enable). This feature is currently in beta. - max_
conn number - Listener-level maximum concurrent connections. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- max_
cps number - Listener-level maximum new connections per second. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- multi_
cert_ objectinfo - Certificate information, supporting multiple server certificates with different algorithm types at the same time. Only applicable to
TCP_SSLlisteners andHTTPSlisteners with SNI disabled. When creating aTCP_SSLlistener or anHTTPSlistener with SNI disabled, at least one ofcertificate/multi_cert_infomust be specified, but they cannot be specified at the same time. - port number
- Port of the CLB listener. Port range: [1 - 65535].
- proxy_
protocol bool - Enable proxy protocol for TCP_SSL and QUIC listeners. Note: this field is not returned by the DescribeListeners API, so it will not be refreshed in state after creation.
- reschedule_
expand_ booltarget - The rescheduling function, a switch for scaling backend services, triggers rescheduling when backend servers are added or removed. Only supported by TCP/UDP listeners.
- reschedule_
interval number - Rescheduled trigger duration, ranging from 0 to 3600 seconds. Supported only by TCP/UDP listeners.
- reschedule_
start_ numbertime - Reschedule the trigger start time, with a value ranging from 0 to 3600 seconds. Only supported by TCP/UDP listeners.
- reschedule_
target_ boolzero_ weight - The rescheduling function, with a weight of 0 as a switch, triggers rescheduling when the weight of the backend server is set to 0. Only supported by TCP/UDP listeners.
- reschedule_
unhealthy bool - Rescheduling function, health check exception switch. Enabling this switch triggers rescheduling when a backend server fails a health check. Supported only by TCP/UDP listeners.
- scheduler string
- Scheduling method. Valid values:
WRR(weighted round-robin),LEAST_CONN(least connections). Default isWRR. Only applicable toTCP/UDP/TCP_SSL/QUIClisteners. - session_
expire_ numbertime - Session persistence time in seconds. Value range: 30-3600, default 0 (disabled). Only applicable to
TCP/UDPlisteners. - session_
type string - Session persistence type.
NORMAL(default): default session persistence type;QUIC_CID: session persistence by QUIC connection ID. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule. IfQUIC_CIDis selected,protocolmust beUDP,schedulermust beWRR, and only IPv4 is supported. - snat_
enable bool - Whether to enable SNAT (source IP replacement).
true: enable,false: disable (default). Note: when SNAT is enabled, the client source IP is replaced and the pass-through client source IP option is disabled, and vice versa. - sni_
switch bool - Indicates whether SNI is enabled. Only applicable to
HTTPSlisteners.0: disabled,1: enabled. - target_
type string - Backend target type. Valid values:
NODE,TARGETGROUP,TARGETGROUP-V2.NODEmeans binding ordinary nodes,TARGETGROUPmeans binding a target group. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule.
- clb
Id String - ID of the CLB instance.
- listener
Name String - Name of the CLB listener, 1-80 characters. Supports letters, Chinese and other common international language characters, digits, hyphen '-' and underscore '_' (Unicode supplementary characters such as emoji are not allowed).
- protocol String
- Type of protocol within the listener. Valid values:
TCP,UDP,HTTP,HTTPS,TCP_SSLandQUIC. - certificate
Ca StringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when the ssl mode isMUTUAL. - certificate
Id String - ID of the server certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when it is available. - certificate
Ssl StringMode - Type of certificate. Valid values:
UNIDIRECTIONAL,MUTUAL. NOTES: Only supports listeners ofHTTPSandTCP_SSLprotocol and must be set when it is available. - clb
Listener StringId - ID of the resource.
- data
Compress StringMode - Data compression mode. Valid values:
transparent,compatibility. - deregister
Target BooleanRst - Reschedule function: the switch for unbinding backend services. When enabled, rescheduling is triggered when a backend service is unbound. Only supported by
TCP/UDPlisteners. - end
Port Double - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Portsparameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c
Switch Boolean - Whether to enable H2C for intranet
HTTPlisteners.true: enable,false: disable (default). When enabled, the listener only supports creating L7 rules with backend forwarding typeGRPCorGRPCS;GRPCorGRPCSmust be explicitly specified in the forwarding type when creating rules. - health
Check StringContext Type - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the input format of the health check. Valid values:HEX,TEXT. WhenHEX, the characters ofsend_context/recv_contextcan only be selected from0123456789ABCDEFand the length must be even. Only applicable toTCP/UDPlisteners. - health
Check DoubleHealth Num - Health threshold. Default 3, meaning the backend is considered healthy after 3 consecutive successful probes. Value range: 2-10.
- health
Check DoubleHttp Code - Health check status code (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Value range: 1-31, default 31.
1=1xx healthy,2=2xx,4=3xx,8=4xx,16=5xx. To treat multiple return codes as healthy, add the corresponding values together. - health
Check StringHttp Domain - Health check domain, carried in the HTTP Host header (only applicable to HTTP/HTTPS listeners and the HTTP health check method of TCP listeners; for TCP listeners using HTTP health check, this field is required).
- health
Check StringHttp Method - Health check method (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Default
HEAD. Valid values:HEAD,GET. - health
Check StringHttp Path - Health check path (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners).
- health
Check StringHttp Version - HTTP version of the backend service. Required when
health_check_typeisHTTP. Valid values:HTTP/1.0,HTTP/1.1. Only applicable toTCPlisteners. - health
Check DoubleInterval Time - Health check probe interval in seconds. Default 5. Value range: 2-300 for IPv4 CLB instances and 5-300 for IPv6 CLB instances. Note: some older IPv4 CLB instances have a range of 5-300.
- health
Check DoublePort - Health check port. Defaults to the backend service port; leave blank unless a specific port is required. Pass
-1to restore the default. Only applicable toTCP/UDPlisteners. - health
Check StringRecv Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the result returned by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health
Check StringSend Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the request content sent by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health
Check BooleanSwitch - Indicates whether health check is enabled.
- health
Check DoubleTime Out - Response timeout of health check in seconds. Value range: 2-60, default 2. The response timeout must be less than the check interval.
- health
Check StringType - Health check protocol. Valid values:
TCP,HTTP,HTTPS,GRPC,PING,CUSTOM. UDP listeners supportPING/CUSTOM; TCP listeners supportTCP/HTTP/CUSTOM; TCP_SSL/QUIC listeners supportTCP/HTTP; HTTP rules supportHTTP/GRPC; HTTPS rules supportHTTP/HTTPS/GRPC. Defaults:HTTPfor HTTP listeners,TCPfor TCP/TCP_SSL/QUIC listeners,PINGfor UDP listeners; for HTTPS listeners the default matches the backend forwarding protocol. - health
Check DoubleUnhealth Num - Unhealthy threshold. Default 3, meaning the backend is considered unhealthy after 3 consecutive failed probes. Value range: 2-10.
- health
Source DoubleIp Type - Health check source IP type.
0: use the CLB VIP as the source IP,1: use a 100.64 IP range as the source IP. - idle
Connect DoubleTimeout - Idle connection timeout. This parameter is only available for TCP/UDP listeners, in seconds. Default: 900s for TCP listeners, 300s for UDP listeners. Value range: 10-900 for shared and dedicated instances; 10-1980 for LCU-supported CLB instances. To set a value beyond the range, please submit a ticket for application.
- keepalive
Enable Double - Whether to enable persistent connection (long connection). Only applicable to
HTTP/HTTPSlisteners. Valid values:0(disable, default),1(enable). This feature is currently in beta. - max
Conn Double - Listener-level maximum concurrent connections. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- max
Cps Double - Listener-level maximum new connections per second. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- multi
Cert ClbInfo Listener Multi Cert Info - Certificate information, supporting multiple server certificates with different algorithm types at the same time. Only applicable to
TCP_SSLlisteners andHTTPSlisteners with SNI disabled. When creating aTCP_SSLlistener or anHTTPSlistener with SNI disabled, at least one ofcertificate/multi_cert_infomust be specified, but they cannot be specified at the same time. - port Double
- Port of the CLB listener. Port range: [1 - 65535].
- proxy
Protocol Boolean - Enable proxy protocol for TCP_SSL and QUIC listeners. Note: this field is not returned by the DescribeListeners API, so it will not be refreshed in state after creation.
- reschedule
Expand BooleanTarget - The rescheduling function, a switch for scaling backend services, triggers rescheduling when backend servers are added or removed. Only supported by TCP/UDP listeners.
- reschedule
Interval Double - Rescheduled trigger duration, ranging from 0 to 3600 seconds. Supported only by TCP/UDP listeners.
- reschedule
Start DoubleTime - Reschedule the trigger start time, with a value ranging from 0 to 3600 seconds. Only supported by TCP/UDP listeners.
- reschedule
Target BooleanZero Weight - The rescheduling function, with a weight of 0 as a switch, triggers rescheduling when the weight of the backend server is set to 0. Only supported by TCP/UDP listeners.
- reschedule
Unhealthy Boolean - Rescheduling function, health check exception switch. Enabling this switch triggers rescheduling when a backend server fails a health check. Supported only by TCP/UDP listeners.
- scheduler String
- Scheduling method. Valid values:
WRR(weighted round-robin),LEAST_CONN(least connections). Default isWRR. Only applicable toTCP/UDP/TCP_SSL/QUIClisteners. - session
Expire DoubleTime - Session persistence time in seconds. Value range: 30-3600, default 0 (disabled). Only applicable to
TCP/UDPlisteners. - session
Type String - Session persistence type.
NORMAL(default): default session persistence type;QUIC_CID: session persistence by QUIC connection ID. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule. IfQUIC_CIDis selected,protocolmust beUDP,schedulermust beWRR, and only IPv4 is supported. - snat
Enable Boolean - Whether to enable SNAT (source IP replacement).
true: enable,false: disable (default). Note: when SNAT is enabled, the client source IP is replaced and the pass-through client source IP option is disabled, and vice versa. - sni
Switch Boolean - Indicates whether SNI is enabled. Only applicable to
HTTPSlisteners.0: disabled,1: enabled. - target
Type String - Backend target type. Valid values:
NODE,TARGETGROUP,TARGETGROUP-V2.NODEmeans binding ordinary nodes,TARGETGROUPmeans binding a target group. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule.
- clb
Id string - ID of the CLB instance.
- listener
Name string - Name of the CLB listener, 1-80 characters. Supports letters, Chinese and other common international language characters, digits, hyphen '-' and underscore '_' (Unicode supplementary characters such as emoji are not allowed).
- protocol string
- Type of protocol within the listener. Valid values:
TCP,UDP,HTTP,HTTPS,TCP_SSLandQUIC. - certificate
Ca stringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when the ssl mode isMUTUAL. - certificate
Id string - ID of the server certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when it is available. - certificate
Ssl stringMode - Type of certificate. Valid values:
UNIDIRECTIONAL,MUTUAL. NOTES: Only supports listeners ofHTTPSandTCP_SSLprotocol and must be set when it is available. - clb
Listener stringId - ID of the resource.
- data
Compress stringMode - Data compression mode. Valid values:
transparent,compatibility. - deregister
Target booleanRst - Reschedule function: the switch for unbinding backend services. When enabled, rescheduling is triggered when a backend service is unbound. Only supported by
TCP/UDPlisteners. - end
Port number - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Portsparameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c
Switch boolean - Whether to enable H2C for intranet
HTTPlisteners.true: enable,false: disable (default). When enabled, the listener only supports creating L7 rules with backend forwarding typeGRPCorGRPCS;GRPCorGRPCSmust be explicitly specified in the forwarding type when creating rules. - health
Check stringContext Type - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the input format of the health check. Valid values:HEX,TEXT. WhenHEX, the characters ofsend_context/recv_contextcan only be selected from0123456789ABCDEFand the length must be even. Only applicable toTCP/UDPlisteners. - health
Check numberHealth Num - Health threshold. Default 3, meaning the backend is considered healthy after 3 consecutive successful probes. Value range: 2-10.
- health
Check numberHttp Code - Health check status code (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Value range: 1-31, default 31.
1=1xx healthy,2=2xx,4=3xx,8=4xx,16=5xx. To treat multiple return codes as healthy, add the corresponding values together. - health
Check stringHttp Domain - Health check domain, carried in the HTTP Host header (only applicable to HTTP/HTTPS listeners and the HTTP health check method of TCP listeners; for TCP listeners using HTTP health check, this field is required).
- health
Check stringHttp Method - Health check method (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Default
HEAD. Valid values:HEAD,GET. - health
Check stringHttp Path - Health check path (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners).
- health
Check stringHttp Version - HTTP version of the backend service. Required when
health_check_typeisHTTP. Valid values:HTTP/1.0,HTTP/1.1. Only applicable toTCPlisteners. - health
Check numberInterval Time - Health check probe interval in seconds. Default 5. Value range: 2-300 for IPv4 CLB instances and 5-300 for IPv6 CLB instances. Note: some older IPv4 CLB instances have a range of 5-300.
- health
Check numberPort - Health check port. Defaults to the backend service port; leave blank unless a specific port is required. Pass
-1to restore the default. Only applicable toTCP/UDPlisteners. - health
Check stringRecv Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the result returned by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health
Check stringSend Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the request content sent by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health
Check booleanSwitch - Indicates whether health check is enabled.
- health
Check numberTime Out - Response timeout of health check in seconds. Value range: 2-60, default 2. The response timeout must be less than the check interval.
- health
Check stringType - Health check protocol. Valid values:
TCP,HTTP,HTTPS,GRPC,PING,CUSTOM. UDP listeners supportPING/CUSTOM; TCP listeners supportTCP/HTTP/CUSTOM; TCP_SSL/QUIC listeners supportTCP/HTTP; HTTP rules supportHTTP/GRPC; HTTPS rules supportHTTP/HTTPS/GRPC. Defaults:HTTPfor HTTP listeners,TCPfor TCP/TCP_SSL/QUIC listeners,PINGfor UDP listeners; for HTTPS listeners the default matches the backend forwarding protocol. - health
Check numberUnhealth Num - Unhealthy threshold. Default 3, meaning the backend is considered unhealthy after 3 consecutive failed probes. Value range: 2-10.
- health
Source numberIp Type - Health check source IP type.
0: use the CLB VIP as the source IP,1: use a 100.64 IP range as the source IP. - idle
Connect numberTimeout - Idle connection timeout. This parameter is only available for TCP/UDP listeners, in seconds. Default: 900s for TCP listeners, 300s for UDP listeners. Value range: 10-900 for shared and dedicated instances; 10-1980 for LCU-supported CLB instances. To set a value beyond the range, please submit a ticket for application.
- keepalive
Enable number - Whether to enable persistent connection (long connection). Only applicable to
HTTP/HTTPSlisteners. Valid values:0(disable, default),1(enable). This feature is currently in beta. - max
Conn number - Listener-level maximum concurrent connections. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- max
Cps number - Listener-level maximum new connections per second. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- multi
Cert ClbInfo Listener Multi Cert Info - Certificate information, supporting multiple server certificates with different algorithm types at the same time. Only applicable to
TCP_SSLlisteners andHTTPSlisteners with SNI disabled. When creating aTCP_SSLlistener or anHTTPSlistener with SNI disabled, at least one ofcertificate/multi_cert_infomust be specified, but they cannot be specified at the same time. - port number
- Port of the CLB listener. Port range: [1 - 65535].
- proxy
Protocol boolean - Enable proxy protocol for TCP_SSL and QUIC listeners. Note: this field is not returned by the DescribeListeners API, so it will not be refreshed in state after creation.
- reschedule
Expand booleanTarget - The rescheduling function, a switch for scaling backend services, triggers rescheduling when backend servers are added or removed. Only supported by TCP/UDP listeners.
- reschedule
Interval number - Rescheduled trigger duration, ranging from 0 to 3600 seconds. Supported only by TCP/UDP listeners.
- reschedule
Start numberTime - Reschedule the trigger start time, with a value ranging from 0 to 3600 seconds. Only supported by TCP/UDP listeners.
- reschedule
Target booleanZero Weight - The rescheduling function, with a weight of 0 as a switch, triggers rescheduling when the weight of the backend server is set to 0. Only supported by TCP/UDP listeners.
- reschedule
Unhealthy boolean - Rescheduling function, health check exception switch. Enabling this switch triggers rescheduling when a backend server fails a health check. Supported only by TCP/UDP listeners.
- scheduler string
- Scheduling method. Valid values:
WRR(weighted round-robin),LEAST_CONN(least connections). Default isWRR. Only applicable toTCP/UDP/TCP_SSL/QUIClisteners. - session
Expire numberTime - Session persistence time in seconds. Value range: 30-3600, default 0 (disabled). Only applicable to
TCP/UDPlisteners. - session
Type string - Session persistence type.
NORMAL(default): default session persistence type;QUIC_CID: session persistence by QUIC connection ID. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule. IfQUIC_CIDis selected,protocolmust beUDP,schedulermust beWRR, and only IPv4 is supported. - snat
Enable boolean - Whether to enable SNAT (source IP replacement).
true: enable,false: disable (default). Note: when SNAT is enabled, the client source IP is replaced and the pass-through client source IP option is disabled, and vice versa. - sni
Switch boolean - Indicates whether SNI is enabled. Only applicable to
HTTPSlisteners.0: disabled,1: enabled. - target
Type string - Backend target type. Valid values:
NODE,TARGETGROUP,TARGETGROUP-V2.NODEmeans binding ordinary nodes,TARGETGROUPmeans binding a target group. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule.
- clb_
id str - ID of the CLB instance.
- listener_
name str - Name of the CLB listener, 1-80 characters. Supports letters, Chinese and other common international language characters, digits, hyphen '-' and underscore '_' (Unicode supplementary characters such as emoji are not allowed).
- protocol str
- Type of protocol within the listener. Valid values:
TCP,UDP,HTTP,HTTPS,TCP_SSLandQUIC. - certificate_
ca_ strid - ID of the client certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when the ssl mode isMUTUAL. - certificate_
id str - ID of the server certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when it is available. - certificate_
ssl_ strmode - Type of certificate. Valid values:
UNIDIRECTIONAL,MUTUAL. NOTES: Only supports listeners ofHTTPSandTCP_SSLprotocol and must be set when it is available. - clb_
listener_ strid - ID of the resource.
- data_
compress_ strmode - Data compression mode. Valid values:
transparent,compatibility. - deregister_
target_ boolrst - Reschedule function: the switch for unbinding backend services. When enabled, rescheduling is triggered when a backend service is unbound. Only supported by
TCP/UDPlisteners. - end_
port float - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Portsparameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c_
switch bool - Whether to enable H2C for intranet
HTTPlisteners.true: enable,false: disable (default). When enabled, the listener only supports creating L7 rules with backend forwarding typeGRPCorGRPCS;GRPCorGRPCSmust be explicitly specified in the forwarding type when creating rules. - health_
check_ strcontext_ type - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the input format of the health check. Valid values:HEX,TEXT. WhenHEX, the characters ofsend_context/recv_contextcan only be selected from0123456789ABCDEFand the length must be even. Only applicable toTCP/UDPlisteners. - health_
check_ floathealth_ num - Health threshold. Default 3, meaning the backend is considered healthy after 3 consecutive successful probes. Value range: 2-10.
- health_
check_ floathttp_ code - Health check status code (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Value range: 1-31, default 31.
1=1xx healthy,2=2xx,4=3xx,8=4xx,16=5xx. To treat multiple return codes as healthy, add the corresponding values together. - health_
check_ strhttp_ domain - Health check domain, carried in the HTTP Host header (only applicable to HTTP/HTTPS listeners and the HTTP health check method of TCP listeners; for TCP listeners using HTTP health check, this field is required).
- health_
check_ strhttp_ method - Health check method (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Default
HEAD. Valid values:HEAD,GET. - health_
check_ strhttp_ path - Health check path (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners).
- health_
check_ strhttp_ version - HTTP version of the backend service. Required when
health_check_typeisHTTP. Valid values:HTTP/1.0,HTTP/1.1. Only applicable toTCPlisteners. - health_
check_ floatinterval_ time - Health check probe interval in seconds. Default 5. Value range: 2-300 for IPv4 CLB instances and 5-300 for IPv6 CLB instances. Note: some older IPv4 CLB instances have a range of 5-300.
- health_
check_ floatport - Health check port. Defaults to the backend service port; leave blank unless a specific port is required. Pass
-1to restore the default. Only applicable toTCP/UDPlisteners. - health_
check_ strrecv_ context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the result returned by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health_
check_ strsend_ context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the request content sent by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health_
check_ boolswitch - Indicates whether health check is enabled.
- health_
check_ floattime_ out - Response timeout of health check in seconds. Value range: 2-60, default 2. The response timeout must be less than the check interval.
- health_
check_ strtype - Health check protocol. Valid values:
TCP,HTTP,HTTPS,GRPC,PING,CUSTOM. UDP listeners supportPING/CUSTOM; TCP listeners supportTCP/HTTP/CUSTOM; TCP_SSL/QUIC listeners supportTCP/HTTP; HTTP rules supportHTTP/GRPC; HTTPS rules supportHTTP/HTTPS/GRPC. Defaults:HTTPfor HTTP listeners,TCPfor TCP/TCP_SSL/QUIC listeners,PINGfor UDP listeners; for HTTPS listeners the default matches the backend forwarding protocol. - health_
check_ floatunhealth_ num - Unhealthy threshold. Default 3, meaning the backend is considered unhealthy after 3 consecutive failed probes. Value range: 2-10.
- health_
source_ floatip_ type - Health check source IP type.
0: use the CLB VIP as the source IP,1: use a 100.64 IP range as the source IP. - idle_
connect_ floattimeout - Idle connection timeout. This parameter is only available for TCP/UDP listeners, in seconds. Default: 900s for TCP listeners, 300s for UDP listeners. Value range: 10-900 for shared and dedicated instances; 10-1980 for LCU-supported CLB instances. To set a value beyond the range, please submit a ticket for application.
- keepalive_
enable float - Whether to enable persistent connection (long connection). Only applicable to
HTTP/HTTPSlisteners. Valid values:0(disable, default),1(enable). This feature is currently in beta. - max_
conn float - Listener-level maximum concurrent connections. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- max_
cps float - Listener-level maximum new connections per second. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- multi_
cert_ Clbinfo Listener Multi Cert Info Args - Certificate information, supporting multiple server certificates with different algorithm types at the same time. Only applicable to
TCP_SSLlisteners andHTTPSlisteners with SNI disabled. When creating aTCP_SSLlistener or anHTTPSlistener with SNI disabled, at least one ofcertificate/multi_cert_infomust be specified, but they cannot be specified at the same time. - port float
- Port of the CLB listener. Port range: [1 - 65535].
- proxy_
protocol bool - Enable proxy protocol for TCP_SSL and QUIC listeners. Note: this field is not returned by the DescribeListeners API, so it will not be refreshed in state after creation.
- reschedule_
expand_ booltarget - The rescheduling function, a switch for scaling backend services, triggers rescheduling when backend servers are added or removed. Only supported by TCP/UDP listeners.
- reschedule_
interval float - Rescheduled trigger duration, ranging from 0 to 3600 seconds. Supported only by TCP/UDP listeners.
- reschedule_
start_ floattime - Reschedule the trigger start time, with a value ranging from 0 to 3600 seconds. Only supported by TCP/UDP listeners.
- reschedule_
target_ boolzero_ weight - The rescheduling function, with a weight of 0 as a switch, triggers rescheduling when the weight of the backend server is set to 0. Only supported by TCP/UDP listeners.
- reschedule_
unhealthy bool - Rescheduling function, health check exception switch. Enabling this switch triggers rescheduling when a backend server fails a health check. Supported only by TCP/UDP listeners.
- scheduler str
- Scheduling method. Valid values:
WRR(weighted round-robin),LEAST_CONN(least connections). Default isWRR. Only applicable toTCP/UDP/TCP_SSL/QUIClisteners. - session_
expire_ floattime - Session persistence time in seconds. Value range: 30-3600, default 0 (disabled). Only applicable to
TCP/UDPlisteners. - session_
type str - Session persistence type.
NORMAL(default): default session persistence type;QUIC_CID: session persistence by QUIC connection ID. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule. IfQUIC_CIDis selected,protocolmust beUDP,schedulermust beWRR, and only IPv4 is supported. - snat_
enable bool - Whether to enable SNAT (source IP replacement).
true: enable,false: disable (default). Note: when SNAT is enabled, the client source IP is replaced and the pass-through client source IP option is disabled, and vice versa. - sni_
switch bool - Indicates whether SNI is enabled. Only applicable to
HTTPSlisteners.0: disabled,1: enabled. - target_
type str - Backend target type. Valid values:
NODE,TARGETGROUP,TARGETGROUP-V2.NODEmeans binding ordinary nodes,TARGETGROUPmeans binding a target group. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule.
- clb
Id String - ID of the CLB instance.
- listener
Name String - Name of the CLB listener, 1-80 characters. Supports letters, Chinese and other common international language characters, digits, hyphen '-' and underscore '_' (Unicode supplementary characters such as emoji are not allowed).
- protocol String
- Type of protocol within the listener. Valid values:
TCP,UDP,HTTP,HTTPS,TCP_SSLandQUIC. - certificate
Ca StringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when the ssl mode isMUTUAL. - certificate
Id String - ID of the server certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when it is available. - certificate
Ssl StringMode - Type of certificate. Valid values:
UNIDIRECTIONAL,MUTUAL. NOTES: Only supports listeners ofHTTPSandTCP_SSLprotocol and must be set when it is available. - clb
Listener StringId - ID of the resource.
- data
Compress StringMode - Data compression mode. Valid values:
transparent,compatibility. - deregister
Target BooleanRst - Reschedule function: the switch for unbinding backend services. When enabled, rescheduling is triggered when a backend service is unbound. Only supported by
TCP/UDPlisteners. - end
Port Number - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Portsparameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c
Switch Boolean - Whether to enable H2C for intranet
HTTPlisteners.true: enable,false: disable (default). When enabled, the listener only supports creating L7 rules with backend forwarding typeGRPCorGRPCS;GRPCorGRPCSmust be explicitly specified in the forwarding type when creating rules. - health
Check StringContext Type - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the input format of the health check. Valid values:HEX,TEXT. WhenHEX, the characters ofsend_context/recv_contextcan only be selected from0123456789ABCDEFand the length must be even. Only applicable toTCP/UDPlisteners. - health
Check NumberHealth Num - Health threshold. Default 3, meaning the backend is considered healthy after 3 consecutive successful probes. Value range: 2-10.
- health
Check NumberHttp Code - Health check status code (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Value range: 1-31, default 31.
1=1xx healthy,2=2xx,4=3xx,8=4xx,16=5xx. To treat multiple return codes as healthy, add the corresponding values together. - health
Check StringHttp Domain - Health check domain, carried in the HTTP Host header (only applicable to HTTP/HTTPS listeners and the HTTP health check method of TCP listeners; for TCP listeners using HTTP health check, this field is required).
- health
Check StringHttp Method - Health check method (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Default
HEAD. Valid values:HEAD,GET. - health
Check StringHttp Path - Health check path (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners).
- health
Check StringHttp Version - HTTP version of the backend service. Required when
health_check_typeisHTTP. Valid values:HTTP/1.0,HTTP/1.1. Only applicable toTCPlisteners. - health
Check NumberInterval Time - Health check probe interval in seconds. Default 5. Value range: 2-300 for IPv4 CLB instances and 5-300 for IPv6 CLB instances. Note: some older IPv4 CLB instances have a range of 5-300.
- health
Check NumberPort - Health check port. Defaults to the backend service port; leave blank unless a specific port is required. Pass
-1to restore the default. Only applicable toTCP/UDPlisteners. - health
Check StringRecv Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the result returned by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health
Check StringSend Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the request content sent by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health
Check BooleanSwitch - Indicates whether health check is enabled.
- health
Check NumberTime Out - Response timeout of health check in seconds. Value range: 2-60, default 2. The response timeout must be less than the check interval.
- health
Check StringType - Health check protocol. Valid values:
TCP,HTTP,HTTPS,GRPC,PING,CUSTOM. UDP listeners supportPING/CUSTOM; TCP listeners supportTCP/HTTP/CUSTOM; TCP_SSL/QUIC listeners supportTCP/HTTP; HTTP rules supportHTTP/GRPC; HTTPS rules supportHTTP/HTTPS/GRPC. Defaults:HTTPfor HTTP listeners,TCPfor TCP/TCP_SSL/QUIC listeners,PINGfor UDP listeners; for HTTPS listeners the default matches the backend forwarding protocol. - health
Check NumberUnhealth Num - Unhealthy threshold. Default 3, meaning the backend is considered unhealthy after 3 consecutive failed probes. Value range: 2-10.
- health
Source NumberIp Type - Health check source IP type.
0: use the CLB VIP as the source IP,1: use a 100.64 IP range as the source IP. - idle
Connect NumberTimeout - Idle connection timeout. This parameter is only available for TCP/UDP listeners, in seconds. Default: 900s for TCP listeners, 300s for UDP listeners. Value range: 10-900 for shared and dedicated instances; 10-1980 for LCU-supported CLB instances. To set a value beyond the range, please submit a ticket for application.
- keepalive
Enable Number - Whether to enable persistent connection (long connection). Only applicable to
HTTP/HTTPSlisteners. Valid values:0(disable, default),1(enable). This feature is currently in beta. - max
Conn Number - Listener-level maximum concurrent connections. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- max
Cps Number - Listener-level maximum new connections per second. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- multi
Cert Property MapInfo - Certificate information, supporting multiple server certificates with different algorithm types at the same time. Only applicable to
TCP_SSLlisteners andHTTPSlisteners with SNI disabled. When creating aTCP_SSLlistener or anHTTPSlistener with SNI disabled, at least one ofcertificate/multi_cert_infomust be specified, but they cannot be specified at the same time. - port Number
- Port of the CLB listener. Port range: [1 - 65535].
- proxy
Protocol Boolean - Enable proxy protocol for TCP_SSL and QUIC listeners. Note: this field is not returned by the DescribeListeners API, so it will not be refreshed in state after creation.
- reschedule
Expand BooleanTarget - The rescheduling function, a switch for scaling backend services, triggers rescheduling when backend servers are added or removed. Only supported by TCP/UDP listeners.
- reschedule
Interval Number - Rescheduled trigger duration, ranging from 0 to 3600 seconds. Supported only by TCP/UDP listeners.
- reschedule
Start NumberTime - Reschedule the trigger start time, with a value ranging from 0 to 3600 seconds. Only supported by TCP/UDP listeners.
- reschedule
Target BooleanZero Weight - The rescheduling function, with a weight of 0 as a switch, triggers rescheduling when the weight of the backend server is set to 0. Only supported by TCP/UDP listeners.
- reschedule
Unhealthy Boolean - Rescheduling function, health check exception switch. Enabling this switch triggers rescheduling when a backend server fails a health check. Supported only by TCP/UDP listeners.
- scheduler String
- Scheduling method. Valid values:
WRR(weighted round-robin),LEAST_CONN(least connections). Default isWRR. Only applicable toTCP/UDP/TCP_SSL/QUIClisteners. - session
Expire NumberTime - Session persistence time in seconds. Value range: 30-3600, default 0 (disabled). Only applicable to
TCP/UDPlisteners. - session
Type String - Session persistence type.
NORMAL(default): default session persistence type;QUIC_CID: session persistence by QUIC connection ID. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule. IfQUIC_CIDis selected,protocolmust beUDP,schedulermust beWRR, and only IPv4 is supported. - snat
Enable Boolean - Whether to enable SNAT (source IP replacement).
true: enable,false: disable (default). Note: when SNAT is enabled, the client source IP is replaced and the pass-through client source IP option is disabled, and vice versa. - sni
Switch Boolean - Indicates whether SNI is enabled. Only applicable to
HTTPSlisteners.0: disabled,1: enabled. - target
Type String - Backend target type. Valid values:
NODE,TARGETGROUP,TARGETGROUP-V2.NODEmeans binding ordinary nodes,TARGETGROUPmeans binding a target group. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule.
Outputs
All input properties are implicitly available as output properties. Additionally, the ClbListener resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Listener
Id string - ID of this CLB listener.
- Id string
- The provider-assigned unique ID for this managed resource.
- Listener
Id string - ID of this CLB listener.
- id string
- The provider-assigned unique ID for this managed resource.
- listener_
id string - ID of this CLB listener.
- id String
- The provider-assigned unique ID for this managed resource.
- listener
Id String - ID of this CLB listener.
- id string
- The provider-assigned unique ID for this managed resource.
- listener
Id string - ID of this CLB listener.
- id str
- The provider-assigned unique ID for this managed resource.
- listener_
id str - ID of this CLB listener.
- id String
- The provider-assigned unique ID for this managed resource.
- listener
Id String - ID of this CLB listener.
Look up Existing ClbListener Resource
Get an existing ClbListener 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?: ClbListenerState, opts?: CustomResourceOptions): ClbListener@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
certificate_ca_id: Optional[str] = None,
certificate_id: Optional[str] = None,
certificate_ssl_mode: Optional[str] = None,
clb_id: Optional[str] = None,
clb_listener_id: Optional[str] = None,
data_compress_mode: Optional[str] = None,
deregister_target_rst: Optional[bool] = None,
end_port: Optional[float] = None,
h2c_switch: Optional[bool] = None,
health_check_context_type: Optional[str] = None,
health_check_health_num: Optional[float] = None,
health_check_http_code: Optional[float] = None,
health_check_http_domain: Optional[str] = None,
health_check_http_method: Optional[str] = None,
health_check_http_path: Optional[str] = None,
health_check_http_version: Optional[str] = None,
health_check_interval_time: Optional[float] = None,
health_check_port: Optional[float] = None,
health_check_recv_context: Optional[str] = None,
health_check_send_context: Optional[str] = None,
health_check_switch: Optional[bool] = None,
health_check_time_out: Optional[float] = None,
health_check_type: Optional[str] = None,
health_check_unhealth_num: Optional[float] = None,
health_source_ip_type: Optional[float] = None,
idle_connect_timeout: Optional[float] = None,
keepalive_enable: Optional[float] = None,
listener_id: Optional[str] = None,
listener_name: Optional[str] = None,
max_conn: Optional[float] = None,
max_cps: Optional[float] = None,
multi_cert_info: Optional[ClbListenerMultiCertInfoArgs] = None,
port: Optional[float] = None,
protocol: Optional[str] = None,
proxy_protocol: Optional[bool] = None,
reschedule_expand_target: Optional[bool] = None,
reschedule_interval: Optional[float] = None,
reschedule_start_time: Optional[float] = None,
reschedule_target_zero_weight: Optional[bool] = None,
reschedule_unhealthy: Optional[bool] = None,
scheduler: Optional[str] = None,
session_expire_time: Optional[float] = None,
session_type: Optional[str] = None,
snat_enable: Optional[bool] = None,
sni_switch: Optional[bool] = None,
target_type: Optional[str] = None) -> ClbListenerfunc GetClbListener(ctx *Context, name string, id IDInput, state *ClbListenerState, opts ...ResourceOption) (*ClbListener, error)public static ClbListener Get(string name, Input<string> id, ClbListenerState? state, CustomResourceOptions? opts = null)public static ClbListener get(String name, Output<String> id, ClbListenerState state, CustomResourceOptions options)resources: _: type: tencentcloud:ClbListener get: id: ${id}import {
to = tencentcloud_clb_listener.example
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.
- Certificate
Ca stringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when the ssl mode isMUTUAL. - Certificate
Id string - ID of the server certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when it is available. - Certificate
Ssl stringMode - Type of certificate. Valid values:
UNIDIRECTIONAL,MUTUAL. NOTES: Only supports listeners ofHTTPSandTCP_SSLprotocol and must be set when it is available. - Clb
Id string - ID of the CLB instance.
- Clb
Listener stringId - ID of the resource.
- Data
Compress stringMode - Data compression mode. Valid values:
transparent,compatibility. - Deregister
Target boolRst - Reschedule function: the switch for unbinding backend services. When enabled, rescheduling is triggered when a backend service is unbound. Only supported by
TCP/UDPlisteners. - End
Port double - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Portsparameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - H2c
Switch bool - Whether to enable H2C for intranet
HTTPlisteners.true: enable,false: disable (default). When enabled, the listener only supports creating L7 rules with backend forwarding typeGRPCorGRPCS;GRPCorGRPCSmust be explicitly specified in the forwarding type when creating rules. - Health
Check stringContext Type - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the input format of the health check. Valid values:HEX,TEXT. WhenHEX, the characters ofsend_context/recv_contextcan only be selected from0123456789ABCDEFand the length must be even. Only applicable toTCP/UDPlisteners. - Health
Check doubleHealth Num - Health threshold. Default 3, meaning the backend is considered healthy after 3 consecutive successful probes. Value range: 2-10.
- Health
Check doubleHttp Code - Health check status code (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Value range: 1-31, default 31.
1=1xx healthy,2=2xx,4=3xx,8=4xx,16=5xx. To treat multiple return codes as healthy, add the corresponding values together. - Health
Check stringHttp Domain - Health check domain, carried in the HTTP Host header (only applicable to HTTP/HTTPS listeners and the HTTP health check method of TCP listeners; for TCP listeners using HTTP health check, this field is required).
- Health
Check stringHttp Method - Health check method (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Default
HEAD. Valid values:HEAD,GET. - Health
Check stringHttp Path - Health check path (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners).
- Health
Check stringHttp Version - HTTP version of the backend service. Required when
health_check_typeisHTTP. Valid values:HTTP/1.0,HTTP/1.1. Only applicable toTCPlisteners. - Health
Check doubleInterval Time - Health check probe interval in seconds. Default 5. Value range: 2-300 for IPv4 CLB instances and 5-300 for IPv6 CLB instances. Note: some older IPv4 CLB instances have a range of 5-300.
- Health
Check doublePort - Health check port. Defaults to the backend service port; leave blank unless a specific port is required. Pass
-1to restore the default. Only applicable toTCP/UDPlisteners. - Health
Check stringRecv Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the result returned by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - Health
Check stringSend Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the request content sent by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - Health
Check boolSwitch - Indicates whether health check is enabled.
- Health
Check doubleTime Out - Response timeout of health check in seconds. Value range: 2-60, default 2. The response timeout must be less than the check interval.
- Health
Check stringType - Health check protocol. Valid values:
TCP,HTTP,HTTPS,GRPC,PING,CUSTOM. UDP listeners supportPING/CUSTOM; TCP listeners supportTCP/HTTP/CUSTOM; TCP_SSL/QUIC listeners supportTCP/HTTP; HTTP rules supportHTTP/GRPC; HTTPS rules supportHTTP/HTTPS/GRPC. Defaults:HTTPfor HTTP listeners,TCPfor TCP/TCP_SSL/QUIC listeners,PINGfor UDP listeners; for HTTPS listeners the default matches the backend forwarding protocol. - Health
Check doubleUnhealth Num - Unhealthy threshold. Default 3, meaning the backend is considered unhealthy after 3 consecutive failed probes. Value range: 2-10.
- Health
Source doubleIp Type - Health check source IP type.
0: use the CLB VIP as the source IP,1: use a 100.64 IP range as the source IP. - Idle
Connect doubleTimeout - Idle connection timeout. This parameter is only available for TCP/UDP listeners, in seconds. Default: 900s for TCP listeners, 300s for UDP listeners. Value range: 10-900 for shared and dedicated instances; 10-1980 for LCU-supported CLB instances. To set a value beyond the range, please submit a ticket for application.
- Keepalive
Enable double - Whether to enable persistent connection (long connection). Only applicable to
HTTP/HTTPSlisteners. Valid values:0(disable, default),1(enable). This feature is currently in beta. - Listener
Id string - ID of this CLB listener.
- Listener
Name string - Name of the CLB listener, 1-80 characters. Supports letters, Chinese and other common international language characters, digits, hyphen '-' and underscore '_' (Unicode supplementary characters such as emoji are not allowed).
- Max
Conn double - Listener-level maximum concurrent connections. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- Max
Cps double - Listener-level maximum new connections per second. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- Multi
Cert ClbInfo Listener Multi Cert Info - Certificate information, supporting multiple server certificates with different algorithm types at the same time. Only applicable to
TCP_SSLlisteners andHTTPSlisteners with SNI disabled. When creating aTCP_SSLlistener or anHTTPSlistener with SNI disabled, at least one ofcertificate/multi_cert_infomust be specified, but they cannot be specified at the same time. - Port double
- Port of the CLB listener. Port range: [1 - 65535].
- Protocol string
- Type of protocol within the listener. Valid values:
TCP,UDP,HTTP,HTTPS,TCP_SSLandQUIC. - Proxy
Protocol bool - Enable proxy protocol for TCP_SSL and QUIC listeners. Note: this field is not returned by the DescribeListeners API, so it will not be refreshed in state after creation.
- Reschedule
Expand boolTarget - The rescheduling function, a switch for scaling backend services, triggers rescheduling when backend servers are added or removed. Only supported by TCP/UDP listeners.
- Reschedule
Interval double - Rescheduled trigger duration, ranging from 0 to 3600 seconds. Supported only by TCP/UDP listeners.
- Reschedule
Start doubleTime - Reschedule the trigger start time, with a value ranging from 0 to 3600 seconds. Only supported by TCP/UDP listeners.
- Reschedule
Target boolZero Weight - The rescheduling function, with a weight of 0 as a switch, triggers rescheduling when the weight of the backend server is set to 0. Only supported by TCP/UDP listeners.
- Reschedule
Unhealthy bool - Rescheduling function, health check exception switch. Enabling this switch triggers rescheduling when a backend server fails a health check. Supported only by TCP/UDP listeners.
- Scheduler string
- Scheduling method. Valid values:
WRR(weighted round-robin),LEAST_CONN(least connections). Default isWRR. Only applicable toTCP/UDP/TCP_SSL/QUIClisteners. - Session
Expire doubleTime - Session persistence time in seconds. Value range: 30-3600, default 0 (disabled). Only applicable to
TCP/UDPlisteners. - Session
Type string - Session persistence type.
NORMAL(default): default session persistence type;QUIC_CID: session persistence by QUIC connection ID. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule. IfQUIC_CIDis selected,protocolmust beUDP,schedulermust beWRR, and only IPv4 is supported. - Snat
Enable bool - Whether to enable SNAT (source IP replacement).
true: enable,false: disable (default). Note: when SNAT is enabled, the client source IP is replaced and the pass-through client source IP option is disabled, and vice versa. - Sni
Switch bool - Indicates whether SNI is enabled. Only applicable to
HTTPSlisteners.0: disabled,1: enabled. - Target
Type string - Backend target type. Valid values:
NODE,TARGETGROUP,TARGETGROUP-V2.NODEmeans binding ordinary nodes,TARGETGROUPmeans binding a target group. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule.
- Certificate
Ca stringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when the ssl mode isMUTUAL. - Certificate
Id string - ID of the server certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when it is available. - Certificate
Ssl stringMode - Type of certificate. Valid values:
UNIDIRECTIONAL,MUTUAL. NOTES: Only supports listeners ofHTTPSandTCP_SSLprotocol and must be set when it is available. - Clb
Id string - ID of the CLB instance.
- Clb
Listener stringId - ID of the resource.
- Data
Compress stringMode - Data compression mode. Valid values:
transparent,compatibility. - Deregister
Target boolRst - Reschedule function: the switch for unbinding backend services. When enabled, rescheduling is triggered when a backend service is unbound. Only supported by
TCP/UDPlisteners. - End
Port float64 - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Portsparameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - H2c
Switch bool - Whether to enable H2C for intranet
HTTPlisteners.true: enable,false: disable (default). When enabled, the listener only supports creating L7 rules with backend forwarding typeGRPCorGRPCS;GRPCorGRPCSmust be explicitly specified in the forwarding type when creating rules. - Health
Check stringContext Type - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the input format of the health check. Valid values:HEX,TEXT. WhenHEX, the characters ofsend_context/recv_contextcan only be selected from0123456789ABCDEFand the length must be even. Only applicable toTCP/UDPlisteners. - Health
Check float64Health Num - Health threshold. Default 3, meaning the backend is considered healthy after 3 consecutive successful probes. Value range: 2-10.
- Health
Check float64Http Code - Health check status code (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Value range: 1-31, default 31.
1=1xx healthy,2=2xx,4=3xx,8=4xx,16=5xx. To treat multiple return codes as healthy, add the corresponding values together. - Health
Check stringHttp Domain - Health check domain, carried in the HTTP Host header (only applicable to HTTP/HTTPS listeners and the HTTP health check method of TCP listeners; for TCP listeners using HTTP health check, this field is required).
- Health
Check stringHttp Method - Health check method (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Default
HEAD. Valid values:HEAD,GET. - Health
Check stringHttp Path - Health check path (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners).
- Health
Check stringHttp Version - HTTP version of the backend service. Required when
health_check_typeisHTTP. Valid values:HTTP/1.0,HTTP/1.1. Only applicable toTCPlisteners. - Health
Check float64Interval Time - Health check probe interval in seconds. Default 5. Value range: 2-300 for IPv4 CLB instances and 5-300 for IPv6 CLB instances. Note: some older IPv4 CLB instances have a range of 5-300.
- Health
Check float64Port - Health check port. Defaults to the backend service port; leave blank unless a specific port is required. Pass
-1to restore the default. Only applicable toTCP/UDPlisteners. - Health
Check stringRecv Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the result returned by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - Health
Check stringSend Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the request content sent by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - Health
Check boolSwitch - Indicates whether health check is enabled.
- Health
Check float64Time Out - Response timeout of health check in seconds. Value range: 2-60, default 2. The response timeout must be less than the check interval.
- Health
Check stringType - Health check protocol. Valid values:
TCP,HTTP,HTTPS,GRPC,PING,CUSTOM. UDP listeners supportPING/CUSTOM; TCP listeners supportTCP/HTTP/CUSTOM; TCP_SSL/QUIC listeners supportTCP/HTTP; HTTP rules supportHTTP/GRPC; HTTPS rules supportHTTP/HTTPS/GRPC. Defaults:HTTPfor HTTP listeners,TCPfor TCP/TCP_SSL/QUIC listeners,PINGfor UDP listeners; for HTTPS listeners the default matches the backend forwarding protocol. - Health
Check float64Unhealth Num - Unhealthy threshold. Default 3, meaning the backend is considered unhealthy after 3 consecutive failed probes. Value range: 2-10.
- Health
Source float64Ip Type - Health check source IP type.
0: use the CLB VIP as the source IP,1: use a 100.64 IP range as the source IP. - Idle
Connect float64Timeout - Idle connection timeout. This parameter is only available for TCP/UDP listeners, in seconds. Default: 900s for TCP listeners, 300s for UDP listeners. Value range: 10-900 for shared and dedicated instances; 10-1980 for LCU-supported CLB instances. To set a value beyond the range, please submit a ticket for application.
- Keepalive
Enable float64 - Whether to enable persistent connection (long connection). Only applicable to
HTTP/HTTPSlisteners. Valid values:0(disable, default),1(enable). This feature is currently in beta. - Listener
Id string - ID of this CLB listener.
- Listener
Name string - Name of the CLB listener, 1-80 characters. Supports letters, Chinese and other common international language characters, digits, hyphen '-' and underscore '_' (Unicode supplementary characters such as emoji are not allowed).
- Max
Conn float64 - Listener-level maximum concurrent connections. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- Max
Cps float64 - Listener-level maximum new connections per second. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- Multi
Cert ClbInfo Listener Multi Cert Info Args - Certificate information, supporting multiple server certificates with different algorithm types at the same time. Only applicable to
TCP_SSLlisteners andHTTPSlisteners with SNI disabled. When creating aTCP_SSLlistener or anHTTPSlistener with SNI disabled, at least one ofcertificate/multi_cert_infomust be specified, but they cannot be specified at the same time. - Port float64
- Port of the CLB listener. Port range: [1 - 65535].
- Protocol string
- Type of protocol within the listener. Valid values:
TCP,UDP,HTTP,HTTPS,TCP_SSLandQUIC. - Proxy
Protocol bool - Enable proxy protocol for TCP_SSL and QUIC listeners. Note: this field is not returned by the DescribeListeners API, so it will not be refreshed in state after creation.
- Reschedule
Expand boolTarget - The rescheduling function, a switch for scaling backend services, triggers rescheduling when backend servers are added or removed. Only supported by TCP/UDP listeners.
- Reschedule
Interval float64 - Rescheduled trigger duration, ranging from 0 to 3600 seconds. Supported only by TCP/UDP listeners.
- Reschedule
Start float64Time - Reschedule the trigger start time, with a value ranging from 0 to 3600 seconds. Only supported by TCP/UDP listeners.
- Reschedule
Target boolZero Weight - The rescheduling function, with a weight of 0 as a switch, triggers rescheduling when the weight of the backend server is set to 0. Only supported by TCP/UDP listeners.
- Reschedule
Unhealthy bool - Rescheduling function, health check exception switch. Enabling this switch triggers rescheduling when a backend server fails a health check. Supported only by TCP/UDP listeners.
- Scheduler string
- Scheduling method. Valid values:
WRR(weighted round-robin),LEAST_CONN(least connections). Default isWRR. Only applicable toTCP/UDP/TCP_SSL/QUIClisteners. - Session
Expire float64Time - Session persistence time in seconds. Value range: 30-3600, default 0 (disabled). Only applicable to
TCP/UDPlisteners. - Session
Type string - Session persistence type.
NORMAL(default): default session persistence type;QUIC_CID: session persistence by QUIC connection ID. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule. IfQUIC_CIDis selected,protocolmust beUDP,schedulermust beWRR, and only IPv4 is supported. - Snat
Enable bool - Whether to enable SNAT (source IP replacement).
true: enable,false: disable (default). Note: when SNAT is enabled, the client source IP is replaced and the pass-through client source IP option is disabled, and vice versa. - Sni
Switch bool - Indicates whether SNI is enabled. Only applicable to
HTTPSlisteners.0: disabled,1: enabled. - Target
Type string - Backend target type. Valid values:
NODE,TARGETGROUP,TARGETGROUP-V2.NODEmeans binding ordinary nodes,TARGETGROUPmeans binding a target group. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule.
- certificate_
ca_ stringid - ID of the client certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when the ssl mode isMUTUAL. - certificate_
id string - ID of the server certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when it is available. - certificate_
ssl_ stringmode - Type of certificate. Valid values:
UNIDIRECTIONAL,MUTUAL. NOTES: Only supports listeners ofHTTPSandTCP_SSLprotocol and must be set when it is available. - clb_
id string - ID of the CLB instance.
- clb_
listener_ stringid - ID of the resource.
- data_
compress_ stringmode - Data compression mode. Valid values:
transparent,compatibility. - deregister_
target_ boolrst - Reschedule function: the switch for unbinding backend services. When enabled, rescheduling is triggered when a backend service is unbound. Only supported by
TCP/UDPlisteners. - end_
port number - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Portsparameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c_
switch bool - Whether to enable H2C for intranet
HTTPlisteners.true: enable,false: disable (default). When enabled, the listener only supports creating L7 rules with backend forwarding typeGRPCorGRPCS;GRPCorGRPCSmust be explicitly specified in the forwarding type when creating rules. - health_
check_ stringcontext_ type - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the input format of the health check. Valid values:HEX,TEXT. WhenHEX, the characters ofsend_context/recv_contextcan only be selected from0123456789ABCDEFand the length must be even. Only applicable toTCP/UDPlisteners. - health_
check_ numberhealth_ num - Health threshold. Default 3, meaning the backend is considered healthy after 3 consecutive successful probes. Value range: 2-10.
- health_
check_ numberhttp_ code - Health check status code (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Value range: 1-31, default 31.
1=1xx healthy,2=2xx,4=3xx,8=4xx,16=5xx. To treat multiple return codes as healthy, add the corresponding values together. - health_
check_ stringhttp_ domain - Health check domain, carried in the HTTP Host header (only applicable to HTTP/HTTPS listeners and the HTTP health check method of TCP listeners; for TCP listeners using HTTP health check, this field is required).
- health_
check_ stringhttp_ method - Health check method (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Default
HEAD. Valid values:HEAD,GET. - health_
check_ stringhttp_ path - Health check path (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners).
- health_
check_ stringhttp_ version - HTTP version of the backend service. Required when
health_check_typeisHTTP. Valid values:HTTP/1.0,HTTP/1.1. Only applicable toTCPlisteners. - health_
check_ numberinterval_ time - Health check probe interval in seconds. Default 5. Value range: 2-300 for IPv4 CLB instances and 5-300 for IPv6 CLB instances. Note: some older IPv4 CLB instances have a range of 5-300.
- health_
check_ numberport - Health check port. Defaults to the backend service port; leave blank unless a specific port is required. Pass
-1to restore the default. Only applicable toTCP/UDPlisteners. - health_
check_ stringrecv_ context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the result returned by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health_
check_ stringsend_ context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the request content sent by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health_
check_ boolswitch - Indicates whether health check is enabled.
- health_
check_ numbertime_ out - Response timeout of health check in seconds. Value range: 2-60, default 2. The response timeout must be less than the check interval.
- health_
check_ stringtype - Health check protocol. Valid values:
TCP,HTTP,HTTPS,GRPC,PING,CUSTOM. UDP listeners supportPING/CUSTOM; TCP listeners supportTCP/HTTP/CUSTOM; TCP_SSL/QUIC listeners supportTCP/HTTP; HTTP rules supportHTTP/GRPC; HTTPS rules supportHTTP/HTTPS/GRPC. Defaults:HTTPfor HTTP listeners,TCPfor TCP/TCP_SSL/QUIC listeners,PINGfor UDP listeners; for HTTPS listeners the default matches the backend forwarding protocol. - health_
check_ numberunhealth_ num - Unhealthy threshold. Default 3, meaning the backend is considered unhealthy after 3 consecutive failed probes. Value range: 2-10.
- health_
source_ numberip_ type - Health check source IP type.
0: use the CLB VIP as the source IP,1: use a 100.64 IP range as the source IP. - idle_
connect_ numbertimeout - Idle connection timeout. This parameter is only available for TCP/UDP listeners, in seconds. Default: 900s for TCP listeners, 300s for UDP listeners. Value range: 10-900 for shared and dedicated instances; 10-1980 for LCU-supported CLB instances. To set a value beyond the range, please submit a ticket for application.
- keepalive_
enable number - Whether to enable persistent connection (long connection). Only applicable to
HTTP/HTTPSlisteners. Valid values:0(disable, default),1(enable). This feature is currently in beta. - listener_
id string - ID of this CLB listener.
- listener_
name string - Name of the CLB listener, 1-80 characters. Supports letters, Chinese and other common international language characters, digits, hyphen '-' and underscore '_' (Unicode supplementary characters such as emoji are not allowed).
- max_
conn number - Listener-level maximum concurrent connections. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- max_
cps number - Listener-level maximum new connections per second. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- multi_
cert_ objectinfo - Certificate information, supporting multiple server certificates with different algorithm types at the same time. Only applicable to
TCP_SSLlisteners andHTTPSlisteners with SNI disabled. When creating aTCP_SSLlistener or anHTTPSlistener with SNI disabled, at least one ofcertificate/multi_cert_infomust be specified, but they cannot be specified at the same time. - port number
- Port of the CLB listener. Port range: [1 - 65535].
- protocol string
- Type of protocol within the listener. Valid values:
TCP,UDP,HTTP,HTTPS,TCP_SSLandQUIC. - proxy_
protocol bool - Enable proxy protocol for TCP_SSL and QUIC listeners. Note: this field is not returned by the DescribeListeners API, so it will not be refreshed in state after creation.
- reschedule_
expand_ booltarget - The rescheduling function, a switch for scaling backend services, triggers rescheduling when backend servers are added or removed. Only supported by TCP/UDP listeners.
- reschedule_
interval number - Rescheduled trigger duration, ranging from 0 to 3600 seconds. Supported only by TCP/UDP listeners.
- reschedule_
start_ numbertime - Reschedule the trigger start time, with a value ranging from 0 to 3600 seconds. Only supported by TCP/UDP listeners.
- reschedule_
target_ boolzero_ weight - The rescheduling function, with a weight of 0 as a switch, triggers rescheduling when the weight of the backend server is set to 0. Only supported by TCP/UDP listeners.
- reschedule_
unhealthy bool - Rescheduling function, health check exception switch. Enabling this switch triggers rescheduling when a backend server fails a health check. Supported only by TCP/UDP listeners.
- scheduler string
- Scheduling method. Valid values:
WRR(weighted round-robin),LEAST_CONN(least connections). Default isWRR. Only applicable toTCP/UDP/TCP_SSL/QUIClisteners. - session_
expire_ numbertime - Session persistence time in seconds. Value range: 30-3600, default 0 (disabled). Only applicable to
TCP/UDPlisteners. - session_
type string - Session persistence type.
NORMAL(default): default session persistence type;QUIC_CID: session persistence by QUIC connection ID. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule. IfQUIC_CIDis selected,protocolmust beUDP,schedulermust beWRR, and only IPv4 is supported. - snat_
enable bool - Whether to enable SNAT (source IP replacement).
true: enable,false: disable (default). Note: when SNAT is enabled, the client source IP is replaced and the pass-through client source IP option is disabled, and vice versa. - sni_
switch bool - Indicates whether SNI is enabled. Only applicable to
HTTPSlisteners.0: disabled,1: enabled. - target_
type string - Backend target type. Valid values:
NODE,TARGETGROUP,TARGETGROUP-V2.NODEmeans binding ordinary nodes,TARGETGROUPmeans binding a target group. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule.
- certificate
Ca StringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when the ssl mode isMUTUAL. - certificate
Id String - ID of the server certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when it is available. - certificate
Ssl StringMode - Type of certificate. Valid values:
UNIDIRECTIONAL,MUTUAL. NOTES: Only supports listeners ofHTTPSandTCP_SSLprotocol and must be set when it is available. - clb
Id String - ID of the CLB instance.
- clb
Listener StringId - ID of the resource.
- data
Compress StringMode - Data compression mode. Valid values:
transparent,compatibility. - deregister
Target BooleanRst - Reschedule function: the switch for unbinding backend services. When enabled, rescheduling is triggered when a backend service is unbound. Only supported by
TCP/UDPlisteners. - end
Port Double - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Portsparameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c
Switch Boolean - Whether to enable H2C for intranet
HTTPlisteners.true: enable,false: disable (default). When enabled, the listener only supports creating L7 rules with backend forwarding typeGRPCorGRPCS;GRPCorGRPCSmust be explicitly specified in the forwarding type when creating rules. - health
Check StringContext Type - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the input format of the health check. Valid values:HEX,TEXT. WhenHEX, the characters ofsend_context/recv_contextcan only be selected from0123456789ABCDEFand the length must be even. Only applicable toTCP/UDPlisteners. - health
Check DoubleHealth Num - Health threshold. Default 3, meaning the backend is considered healthy after 3 consecutive successful probes. Value range: 2-10.
- health
Check DoubleHttp Code - Health check status code (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Value range: 1-31, default 31.
1=1xx healthy,2=2xx,4=3xx,8=4xx,16=5xx. To treat multiple return codes as healthy, add the corresponding values together. - health
Check StringHttp Domain - Health check domain, carried in the HTTP Host header (only applicable to HTTP/HTTPS listeners and the HTTP health check method of TCP listeners; for TCP listeners using HTTP health check, this field is required).
- health
Check StringHttp Method - Health check method (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Default
HEAD. Valid values:HEAD,GET. - health
Check StringHttp Path - Health check path (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners).
- health
Check StringHttp Version - HTTP version of the backend service. Required when
health_check_typeisHTTP. Valid values:HTTP/1.0,HTTP/1.1. Only applicable toTCPlisteners. - health
Check DoubleInterval Time - Health check probe interval in seconds. Default 5. Value range: 2-300 for IPv4 CLB instances and 5-300 for IPv6 CLB instances. Note: some older IPv4 CLB instances have a range of 5-300.
- health
Check DoublePort - Health check port. Defaults to the backend service port; leave blank unless a specific port is required. Pass
-1to restore the default. Only applicable toTCP/UDPlisteners. - health
Check StringRecv Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the result returned by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health
Check StringSend Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the request content sent by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health
Check BooleanSwitch - Indicates whether health check is enabled.
- health
Check DoubleTime Out - Response timeout of health check in seconds. Value range: 2-60, default 2. The response timeout must be less than the check interval.
- health
Check StringType - Health check protocol. Valid values:
TCP,HTTP,HTTPS,GRPC,PING,CUSTOM. UDP listeners supportPING/CUSTOM; TCP listeners supportTCP/HTTP/CUSTOM; TCP_SSL/QUIC listeners supportTCP/HTTP; HTTP rules supportHTTP/GRPC; HTTPS rules supportHTTP/HTTPS/GRPC. Defaults:HTTPfor HTTP listeners,TCPfor TCP/TCP_SSL/QUIC listeners,PINGfor UDP listeners; for HTTPS listeners the default matches the backend forwarding protocol. - health
Check DoubleUnhealth Num - Unhealthy threshold. Default 3, meaning the backend is considered unhealthy after 3 consecutive failed probes. Value range: 2-10.
- health
Source DoubleIp Type - Health check source IP type.
0: use the CLB VIP as the source IP,1: use a 100.64 IP range as the source IP. - idle
Connect DoubleTimeout - Idle connection timeout. This parameter is only available for TCP/UDP listeners, in seconds. Default: 900s for TCP listeners, 300s for UDP listeners. Value range: 10-900 for shared and dedicated instances; 10-1980 for LCU-supported CLB instances. To set a value beyond the range, please submit a ticket for application.
- keepalive
Enable Double - Whether to enable persistent connection (long connection). Only applicable to
HTTP/HTTPSlisteners. Valid values:0(disable, default),1(enable). This feature is currently in beta. - listener
Id String - ID of this CLB listener.
- listener
Name String - Name of the CLB listener, 1-80 characters. Supports letters, Chinese and other common international language characters, digits, hyphen '-' and underscore '_' (Unicode supplementary characters such as emoji are not allowed).
- max
Conn Double - Listener-level maximum concurrent connections. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- max
Cps Double - Listener-level maximum new connections per second. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- multi
Cert ClbInfo Listener Multi Cert Info - Certificate information, supporting multiple server certificates with different algorithm types at the same time. Only applicable to
TCP_SSLlisteners andHTTPSlisteners with SNI disabled. When creating aTCP_SSLlistener or anHTTPSlistener with SNI disabled, at least one ofcertificate/multi_cert_infomust be specified, but they cannot be specified at the same time. - port Double
- Port of the CLB listener. Port range: [1 - 65535].
- protocol String
- Type of protocol within the listener. Valid values:
TCP,UDP,HTTP,HTTPS,TCP_SSLandQUIC. - proxy
Protocol Boolean - Enable proxy protocol for TCP_SSL and QUIC listeners. Note: this field is not returned by the DescribeListeners API, so it will not be refreshed in state after creation.
- reschedule
Expand BooleanTarget - The rescheduling function, a switch for scaling backend services, triggers rescheduling when backend servers are added or removed. Only supported by TCP/UDP listeners.
- reschedule
Interval Double - Rescheduled trigger duration, ranging from 0 to 3600 seconds. Supported only by TCP/UDP listeners.
- reschedule
Start DoubleTime - Reschedule the trigger start time, with a value ranging from 0 to 3600 seconds. Only supported by TCP/UDP listeners.
- reschedule
Target BooleanZero Weight - The rescheduling function, with a weight of 0 as a switch, triggers rescheduling when the weight of the backend server is set to 0. Only supported by TCP/UDP listeners.
- reschedule
Unhealthy Boolean - Rescheduling function, health check exception switch. Enabling this switch triggers rescheduling when a backend server fails a health check. Supported only by TCP/UDP listeners.
- scheduler String
- Scheduling method. Valid values:
WRR(weighted round-robin),LEAST_CONN(least connections). Default isWRR. Only applicable toTCP/UDP/TCP_SSL/QUIClisteners. - session
Expire DoubleTime - Session persistence time in seconds. Value range: 30-3600, default 0 (disabled). Only applicable to
TCP/UDPlisteners. - session
Type String - Session persistence type.
NORMAL(default): default session persistence type;QUIC_CID: session persistence by QUIC connection ID. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule. IfQUIC_CIDis selected,protocolmust beUDP,schedulermust beWRR, and only IPv4 is supported. - snat
Enable Boolean - Whether to enable SNAT (source IP replacement).
true: enable,false: disable (default). Note: when SNAT is enabled, the client source IP is replaced and the pass-through client source IP option is disabled, and vice versa. - sni
Switch Boolean - Indicates whether SNI is enabled. Only applicable to
HTTPSlisteners.0: disabled,1: enabled. - target
Type String - Backend target type. Valid values:
NODE,TARGETGROUP,TARGETGROUP-V2.NODEmeans binding ordinary nodes,TARGETGROUPmeans binding a target group. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule.
- certificate
Ca stringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when the ssl mode isMUTUAL. - certificate
Id string - ID of the server certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when it is available. - certificate
Ssl stringMode - Type of certificate. Valid values:
UNIDIRECTIONAL,MUTUAL. NOTES: Only supports listeners ofHTTPSandTCP_SSLprotocol and must be set when it is available. - clb
Id string - ID of the CLB instance.
- clb
Listener stringId - ID of the resource.
- data
Compress stringMode - Data compression mode. Valid values:
transparent,compatibility. - deregister
Target booleanRst - Reschedule function: the switch for unbinding backend services. When enabled, rescheduling is triggered when a backend service is unbound. Only supported by
TCP/UDPlisteners. - end
Port number - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Portsparameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c
Switch boolean - Whether to enable H2C for intranet
HTTPlisteners.true: enable,false: disable (default). When enabled, the listener only supports creating L7 rules with backend forwarding typeGRPCorGRPCS;GRPCorGRPCSmust be explicitly specified in the forwarding type when creating rules. - health
Check stringContext Type - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the input format of the health check. Valid values:HEX,TEXT. WhenHEX, the characters ofsend_context/recv_contextcan only be selected from0123456789ABCDEFand the length must be even. Only applicable toTCP/UDPlisteners. - health
Check numberHealth Num - Health threshold. Default 3, meaning the backend is considered healthy after 3 consecutive successful probes. Value range: 2-10.
- health
Check numberHttp Code - Health check status code (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Value range: 1-31, default 31.
1=1xx healthy,2=2xx,4=3xx,8=4xx,16=5xx. To treat multiple return codes as healthy, add the corresponding values together. - health
Check stringHttp Domain - Health check domain, carried in the HTTP Host header (only applicable to HTTP/HTTPS listeners and the HTTP health check method of TCP listeners; for TCP listeners using HTTP health check, this field is required).
- health
Check stringHttp Method - Health check method (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Default
HEAD. Valid values:HEAD,GET. - health
Check stringHttp Path - Health check path (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners).
- health
Check stringHttp Version - HTTP version of the backend service. Required when
health_check_typeisHTTP. Valid values:HTTP/1.0,HTTP/1.1. Only applicable toTCPlisteners. - health
Check numberInterval Time - Health check probe interval in seconds. Default 5. Value range: 2-300 for IPv4 CLB instances and 5-300 for IPv6 CLB instances. Note: some older IPv4 CLB instances have a range of 5-300.
- health
Check numberPort - Health check port. Defaults to the backend service port; leave blank unless a specific port is required. Pass
-1to restore the default. Only applicable toTCP/UDPlisteners. - health
Check stringRecv Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the result returned by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health
Check stringSend Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the request content sent by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health
Check booleanSwitch - Indicates whether health check is enabled.
- health
Check numberTime Out - Response timeout of health check in seconds. Value range: 2-60, default 2. The response timeout must be less than the check interval.
- health
Check stringType - Health check protocol. Valid values:
TCP,HTTP,HTTPS,GRPC,PING,CUSTOM. UDP listeners supportPING/CUSTOM; TCP listeners supportTCP/HTTP/CUSTOM; TCP_SSL/QUIC listeners supportTCP/HTTP; HTTP rules supportHTTP/GRPC; HTTPS rules supportHTTP/HTTPS/GRPC. Defaults:HTTPfor HTTP listeners,TCPfor TCP/TCP_SSL/QUIC listeners,PINGfor UDP listeners; for HTTPS listeners the default matches the backend forwarding protocol. - health
Check numberUnhealth Num - Unhealthy threshold. Default 3, meaning the backend is considered unhealthy after 3 consecutive failed probes. Value range: 2-10.
- health
Source numberIp Type - Health check source IP type.
0: use the CLB VIP as the source IP,1: use a 100.64 IP range as the source IP. - idle
Connect numberTimeout - Idle connection timeout. This parameter is only available for TCP/UDP listeners, in seconds. Default: 900s for TCP listeners, 300s for UDP listeners. Value range: 10-900 for shared and dedicated instances; 10-1980 for LCU-supported CLB instances. To set a value beyond the range, please submit a ticket for application.
- keepalive
Enable number - Whether to enable persistent connection (long connection). Only applicable to
HTTP/HTTPSlisteners. Valid values:0(disable, default),1(enable). This feature is currently in beta. - listener
Id string - ID of this CLB listener.
- listener
Name string - Name of the CLB listener, 1-80 characters. Supports letters, Chinese and other common international language characters, digits, hyphen '-' and underscore '_' (Unicode supplementary characters such as emoji are not allowed).
- max
Conn number - Listener-level maximum concurrent connections. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- max
Cps number - Listener-level maximum new connections per second. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- multi
Cert ClbInfo Listener Multi Cert Info - Certificate information, supporting multiple server certificates with different algorithm types at the same time. Only applicable to
TCP_SSLlisteners andHTTPSlisteners with SNI disabled. When creating aTCP_SSLlistener or anHTTPSlistener with SNI disabled, at least one ofcertificate/multi_cert_infomust be specified, but they cannot be specified at the same time. - port number
- Port of the CLB listener. Port range: [1 - 65535].
- protocol string
- Type of protocol within the listener. Valid values:
TCP,UDP,HTTP,HTTPS,TCP_SSLandQUIC. - proxy
Protocol boolean - Enable proxy protocol for TCP_SSL and QUIC listeners. Note: this field is not returned by the DescribeListeners API, so it will not be refreshed in state after creation.
- reschedule
Expand booleanTarget - The rescheduling function, a switch for scaling backend services, triggers rescheduling when backend servers are added or removed. Only supported by TCP/UDP listeners.
- reschedule
Interval number - Rescheduled trigger duration, ranging from 0 to 3600 seconds. Supported only by TCP/UDP listeners.
- reschedule
Start numberTime - Reschedule the trigger start time, with a value ranging from 0 to 3600 seconds. Only supported by TCP/UDP listeners.
- reschedule
Target booleanZero Weight - The rescheduling function, with a weight of 0 as a switch, triggers rescheduling when the weight of the backend server is set to 0. Only supported by TCP/UDP listeners.
- reschedule
Unhealthy boolean - Rescheduling function, health check exception switch. Enabling this switch triggers rescheduling when a backend server fails a health check. Supported only by TCP/UDP listeners.
- scheduler string
- Scheduling method. Valid values:
WRR(weighted round-robin),LEAST_CONN(least connections). Default isWRR. Only applicable toTCP/UDP/TCP_SSL/QUIClisteners. - session
Expire numberTime - Session persistence time in seconds. Value range: 30-3600, default 0 (disabled). Only applicable to
TCP/UDPlisteners. - session
Type string - Session persistence type.
NORMAL(default): default session persistence type;QUIC_CID: session persistence by QUIC connection ID. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule. IfQUIC_CIDis selected,protocolmust beUDP,schedulermust beWRR, and only IPv4 is supported. - snat
Enable boolean - Whether to enable SNAT (source IP replacement).
true: enable,false: disable (default). Note: when SNAT is enabled, the client source IP is replaced and the pass-through client source IP option is disabled, and vice versa. - sni
Switch boolean - Indicates whether SNI is enabled. Only applicable to
HTTPSlisteners.0: disabled,1: enabled. - target
Type string - Backend target type. Valid values:
NODE,TARGETGROUP,TARGETGROUP-V2.NODEmeans binding ordinary nodes,TARGETGROUPmeans binding a target group. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule.
- certificate_
ca_ strid - ID of the client certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when the ssl mode isMUTUAL. - certificate_
id str - ID of the server certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when it is available. - certificate_
ssl_ strmode - Type of certificate. Valid values:
UNIDIRECTIONAL,MUTUAL. NOTES: Only supports listeners ofHTTPSandTCP_SSLprotocol and must be set when it is available. - clb_
id str - ID of the CLB instance.
- clb_
listener_ strid - ID of the resource.
- data_
compress_ strmode - Data compression mode. Valid values:
transparent,compatibility. - deregister_
target_ boolrst - Reschedule function: the switch for unbinding backend services. When enabled, rescheduling is triggered when a backend service is unbound. Only supported by
TCP/UDPlisteners. - end_
port float - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Portsparameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c_
switch bool - Whether to enable H2C for intranet
HTTPlisteners.true: enable,false: disable (default). When enabled, the listener only supports creating L7 rules with backend forwarding typeGRPCorGRPCS;GRPCorGRPCSmust be explicitly specified in the forwarding type when creating rules. - health_
check_ strcontext_ type - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the input format of the health check. Valid values:HEX,TEXT. WhenHEX, the characters ofsend_context/recv_contextcan only be selected from0123456789ABCDEFand the length must be even. Only applicable toTCP/UDPlisteners. - health_
check_ floathealth_ num - Health threshold. Default 3, meaning the backend is considered healthy after 3 consecutive successful probes. Value range: 2-10.
- health_
check_ floathttp_ code - Health check status code (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Value range: 1-31, default 31.
1=1xx healthy,2=2xx,4=3xx,8=4xx,16=5xx. To treat multiple return codes as healthy, add the corresponding values together. - health_
check_ strhttp_ domain - Health check domain, carried in the HTTP Host header (only applicable to HTTP/HTTPS listeners and the HTTP health check method of TCP listeners; for TCP listeners using HTTP health check, this field is required).
- health_
check_ strhttp_ method - Health check method (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Default
HEAD. Valid values:HEAD,GET. - health_
check_ strhttp_ path - Health check path (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners).
- health_
check_ strhttp_ version - HTTP version of the backend service. Required when
health_check_typeisHTTP. Valid values:HTTP/1.0,HTTP/1.1. Only applicable toTCPlisteners. - health_
check_ floatinterval_ time - Health check probe interval in seconds. Default 5. Value range: 2-300 for IPv4 CLB instances and 5-300 for IPv6 CLB instances. Note: some older IPv4 CLB instances have a range of 5-300.
- health_
check_ floatport - Health check port. Defaults to the backend service port; leave blank unless a specific port is required. Pass
-1to restore the default. Only applicable toTCP/UDPlisteners. - health_
check_ strrecv_ context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the result returned by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health_
check_ strsend_ context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the request content sent by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health_
check_ boolswitch - Indicates whether health check is enabled.
- health_
check_ floattime_ out - Response timeout of health check in seconds. Value range: 2-60, default 2. The response timeout must be less than the check interval.
- health_
check_ strtype - Health check protocol. Valid values:
TCP,HTTP,HTTPS,GRPC,PING,CUSTOM. UDP listeners supportPING/CUSTOM; TCP listeners supportTCP/HTTP/CUSTOM; TCP_SSL/QUIC listeners supportTCP/HTTP; HTTP rules supportHTTP/GRPC; HTTPS rules supportHTTP/HTTPS/GRPC. Defaults:HTTPfor HTTP listeners,TCPfor TCP/TCP_SSL/QUIC listeners,PINGfor UDP listeners; for HTTPS listeners the default matches the backend forwarding protocol. - health_
check_ floatunhealth_ num - Unhealthy threshold. Default 3, meaning the backend is considered unhealthy after 3 consecutive failed probes. Value range: 2-10.
- health_
source_ floatip_ type - Health check source IP type.
0: use the CLB VIP as the source IP,1: use a 100.64 IP range as the source IP. - idle_
connect_ floattimeout - Idle connection timeout. This parameter is only available for TCP/UDP listeners, in seconds. Default: 900s for TCP listeners, 300s for UDP listeners. Value range: 10-900 for shared and dedicated instances; 10-1980 for LCU-supported CLB instances. To set a value beyond the range, please submit a ticket for application.
- keepalive_
enable float - Whether to enable persistent connection (long connection). Only applicable to
HTTP/HTTPSlisteners. Valid values:0(disable, default),1(enable). This feature is currently in beta. - listener_
id str - ID of this CLB listener.
- listener_
name str - Name of the CLB listener, 1-80 characters. Supports letters, Chinese and other common international language characters, digits, hyphen '-' and underscore '_' (Unicode supplementary characters such as emoji are not allowed).
- max_
conn float - Listener-level maximum concurrent connections. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- max_
cps float - Listener-level maximum new connections per second. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- multi_
cert_ Clbinfo Listener Multi Cert Info Args - Certificate information, supporting multiple server certificates with different algorithm types at the same time. Only applicable to
TCP_SSLlisteners andHTTPSlisteners with SNI disabled. When creating aTCP_SSLlistener or anHTTPSlistener with SNI disabled, at least one ofcertificate/multi_cert_infomust be specified, but they cannot be specified at the same time. - port float
- Port of the CLB listener. Port range: [1 - 65535].
- protocol str
- Type of protocol within the listener. Valid values:
TCP,UDP,HTTP,HTTPS,TCP_SSLandQUIC. - proxy_
protocol bool - Enable proxy protocol for TCP_SSL and QUIC listeners. Note: this field is not returned by the DescribeListeners API, so it will not be refreshed in state after creation.
- reschedule_
expand_ booltarget - The rescheduling function, a switch for scaling backend services, triggers rescheduling when backend servers are added or removed. Only supported by TCP/UDP listeners.
- reschedule_
interval float - Rescheduled trigger duration, ranging from 0 to 3600 seconds. Supported only by TCP/UDP listeners.
- reschedule_
start_ floattime - Reschedule the trigger start time, with a value ranging from 0 to 3600 seconds. Only supported by TCP/UDP listeners.
- reschedule_
target_ boolzero_ weight - The rescheduling function, with a weight of 0 as a switch, triggers rescheduling when the weight of the backend server is set to 0. Only supported by TCP/UDP listeners.
- reschedule_
unhealthy bool - Rescheduling function, health check exception switch. Enabling this switch triggers rescheduling when a backend server fails a health check. Supported only by TCP/UDP listeners.
- scheduler str
- Scheduling method. Valid values:
WRR(weighted round-robin),LEAST_CONN(least connections). Default isWRR. Only applicable toTCP/UDP/TCP_SSL/QUIClisteners. - session_
expire_ floattime - Session persistence time in seconds. Value range: 30-3600, default 0 (disabled). Only applicable to
TCP/UDPlisteners. - session_
type str - Session persistence type.
NORMAL(default): default session persistence type;QUIC_CID: session persistence by QUIC connection ID. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule. IfQUIC_CIDis selected,protocolmust beUDP,schedulermust beWRR, and only IPv4 is supported. - snat_
enable bool - Whether to enable SNAT (source IP replacement).
true: enable,false: disable (default). Note: when SNAT is enabled, the client source IP is replaced and the pass-through client source IP option is disabled, and vice versa. - sni_
switch bool - Indicates whether SNI is enabled. Only applicable to
HTTPSlisteners.0: disabled,1: enabled. - target_
type str - Backend target type. Valid values:
NODE,TARGETGROUP,TARGETGROUP-V2.NODEmeans binding ordinary nodes,TARGETGROUPmeans binding a target group. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule.
- certificate
Ca StringId - ID of the client certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when the ssl mode isMUTUAL. - certificate
Id String - ID of the server certificate. NOTES: Only supports listeners of
HTTPSandTCP_SSLprotocol and must be set when it is available. - certificate
Ssl StringMode - Type of certificate. Valid values:
UNIDIRECTIONAL,MUTUAL. NOTES: Only supports listeners ofHTTPSandTCP_SSLprotocol and must be set when it is available. - clb
Id String - ID of the CLB instance.
- clb
Listener StringId - ID of the resource.
- data
Compress StringMode - Data compression mode. Valid values:
transparent,compatibility. - deregister
Target BooleanRst - Reschedule function: the switch for unbinding backend services. When enabled, rescheduling is triggered when a backend service is unbound. Only supported by
TCP/UDPlisteners. - end
Port Number - This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the
Portsparameter, which is used to specify the start port. If you want to try the port range feature, please submit a ticket. - h2c
Switch Boolean - Whether to enable H2C for intranet
HTTPlisteners.true: enable,false: disable (default). When enabled, the listener only supports creating L7 rules with backend forwarding typeGRPCorGRPCS;GRPCorGRPCSmust be explicitly specified in the forwarding type when creating rules. - health
Check StringContext Type - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the input format of the health check. Valid values:HEX,TEXT. WhenHEX, the characters ofsend_context/recv_contextcan only be selected from0123456789ABCDEFand the length must be even. Only applicable toTCP/UDPlisteners. - health
Check NumberHealth Num - Health threshold. Default 3, meaning the backend is considered healthy after 3 consecutive successful probes. Value range: 2-10.
- health
Check NumberHttp Code - Health check status code (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Value range: 1-31, default 31.
1=1xx healthy,2=2xx,4=3xx,8=4xx,16=5xx. To treat multiple return codes as healthy, add the corresponding values together. - health
Check StringHttp Domain - Health check domain, carried in the HTTP Host header (only applicable to HTTP/HTTPS listeners and the HTTP health check method of TCP listeners; for TCP listeners using HTTP health check, this field is required).
- health
Check StringHttp Method - Health check method (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners). Default
HEAD. Valid values:HEAD,GET. - health
Check StringHttp Path - Health check path (only applicable to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners).
- health
Check StringHttp Version - HTTP version of the backend service. Required when
health_check_typeisHTTP. Valid values:HTTP/1.0,HTTP/1.1. Only applicable toTCPlisteners. - health
Check NumberInterval Time - Health check probe interval in seconds. Default 5. Value range: 2-300 for IPv4 CLB instances and 5-300 for IPv6 CLB instances. Note: some older IPv4 CLB instances have a range of 5-300.
- health
Check NumberPort - Health check port. Defaults to the backend service port; leave blank unless a specific port is required. Pass
-1to restore the default. Only applicable toTCP/UDPlisteners. - health
Check StringRecv Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the result returned by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health
Check StringSend Context - Custom probe parameter. Required when
health_check_typeisCUSTOM, representing the request content sent by the health check. Only ASCII visible characters are allowed, max length 500. Only applicable toTCP/UDPlisteners. - health
Check BooleanSwitch - Indicates whether health check is enabled.
- health
Check NumberTime Out - Response timeout of health check in seconds. Value range: 2-60, default 2. The response timeout must be less than the check interval.
- health
Check StringType - Health check protocol. Valid values:
TCP,HTTP,HTTPS,GRPC,PING,CUSTOM. UDP listeners supportPING/CUSTOM; TCP listeners supportTCP/HTTP/CUSTOM; TCP_SSL/QUIC listeners supportTCP/HTTP; HTTP rules supportHTTP/GRPC; HTTPS rules supportHTTP/HTTPS/GRPC. Defaults:HTTPfor HTTP listeners,TCPfor TCP/TCP_SSL/QUIC listeners,PINGfor UDP listeners; for HTTPS listeners the default matches the backend forwarding protocol. - health
Check NumberUnhealth Num - Unhealthy threshold. Default 3, meaning the backend is considered unhealthy after 3 consecutive failed probes. Value range: 2-10.
- health
Source NumberIp Type - Health check source IP type.
0: use the CLB VIP as the source IP,1: use a 100.64 IP range as the source IP. - idle
Connect NumberTimeout - Idle connection timeout. This parameter is only available for TCP/UDP listeners, in seconds. Default: 900s for TCP listeners, 300s for UDP listeners. Value range: 10-900 for shared and dedicated instances; 10-1980 for LCU-supported CLB instances. To set a value beyond the range, please submit a ticket for application.
- keepalive
Enable Number - Whether to enable persistent connection (long connection). Only applicable to
HTTP/HTTPSlisteners. Valid values:0(disable, default),1(enable). This feature is currently in beta. - listener
Id String - ID of this CLB listener.
- listener
Name String - Name of the CLB listener, 1-80 characters. Supports letters, Chinese and other common international language characters, digits, hyphen '-' and underscore '_' (Unicode supplementary characters such as emoji are not allowed).
- max
Conn Number - Listener-level maximum concurrent connections. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- max
Cps Number - Listener-level maximum new connections per second. Currently only supported for performance capacity-type CLB instances with TCP/UDP/TCP_SSL/QUIC listeners. Pass -1 to indicate no limit at the listener level. Basic network instances do not support this parameter.
- multi
Cert Property MapInfo - Certificate information, supporting multiple server certificates with different algorithm types at the same time. Only applicable to
TCP_SSLlisteners andHTTPSlisteners with SNI disabled. When creating aTCP_SSLlistener or anHTTPSlistener with SNI disabled, at least one ofcertificate/multi_cert_infomust be specified, but they cannot be specified at the same time. - port Number
- Port of the CLB listener. Port range: [1 - 65535].
- protocol String
- Type of protocol within the listener. Valid values:
TCP,UDP,HTTP,HTTPS,TCP_SSLandQUIC. - proxy
Protocol Boolean - Enable proxy protocol for TCP_SSL and QUIC listeners. Note: this field is not returned by the DescribeListeners API, so it will not be refreshed in state after creation.
- reschedule
Expand BooleanTarget - The rescheduling function, a switch for scaling backend services, triggers rescheduling when backend servers are added or removed. Only supported by TCP/UDP listeners.
- reschedule
Interval Number - Rescheduled trigger duration, ranging from 0 to 3600 seconds. Supported only by TCP/UDP listeners.
- reschedule
Start NumberTime - Reschedule the trigger start time, with a value ranging from 0 to 3600 seconds. Only supported by TCP/UDP listeners.
- reschedule
Target BooleanZero Weight - The rescheduling function, with a weight of 0 as a switch, triggers rescheduling when the weight of the backend server is set to 0. Only supported by TCP/UDP listeners.
- reschedule
Unhealthy Boolean - Rescheduling function, health check exception switch. Enabling this switch triggers rescheduling when a backend server fails a health check. Supported only by TCP/UDP listeners.
- scheduler String
- Scheduling method. Valid values:
WRR(weighted round-robin),LEAST_CONN(least connections). Default isWRR. Only applicable toTCP/UDP/TCP_SSL/QUIClisteners. - session
Expire NumberTime - Session persistence time in seconds. Value range: 30-3600, default 0 (disabled). Only applicable to
TCP/UDPlisteners. - session
Type String - Session persistence type.
NORMAL(default): default session persistence type;QUIC_CID: session persistence by QUIC connection ID. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule. IfQUIC_CIDis selected,protocolmust beUDP,schedulermust beWRR, and only IPv4 is supported. - snat
Enable Boolean - Whether to enable SNAT (source IP replacement).
true: enable,false: disable (default). Note: when SNAT is enabled, the client source IP is replaced and the pass-through client source IP option is disabled, and vice versa. - sni
Switch Boolean - Indicates whether SNI is enabled. Only applicable to
HTTPSlisteners.0: disabled,1: enabled. - target
Type String - Backend target type. Valid values:
NODE,TARGETGROUP,TARGETGROUP-V2.NODEmeans binding ordinary nodes,TARGETGROUPmeans binding a target group. Only applicable toTCP/UDPlisteners; L7 listeners should be configured in the forwarding rule.
Supporting Types
ClbListenerMultiCertInfo, ClbListenerMultiCertInfoArgs
- Cert
Id List<string>Lists - List of server certificate ID.
- Ssl
Mode string - Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
- Cert
Id []stringLists - List of server certificate ID.
- Ssl
Mode string - Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
- cert_
id_ list(string)lists - List of server certificate ID.
- ssl_
mode string - Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
- cert
Id List<String>Lists - List of server certificate ID.
- ssl
Mode String - Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
- cert
Id string[]Lists - List of server certificate ID.
- ssl
Mode string - Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
- cert_
id_ Sequence[str]lists - List of server certificate ID.
- ssl_
mode str - Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
- cert
Id List<String>Lists - List of server certificate ID.
- ssl
Mode String - Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication).
Import
CLB listener can be imported using the clbId#listenerId (version >= 1.47.0), e.g.
$ pulumi import tencentcloud:index/clbListener:ClbListener example lb-7a0t6zqb#lbl-hh141sn9
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- tencentcloud tencentcloudstack/terraform-provider-tencentcloud
- License
- Notes
- This Pulumi package is based on the
tencentcloudTerraform Provider.
published on Friday, Oct 23, 2026 by tencentcloudstack