1. Packages
  2. Volcengine
  3. API Docs
  4. clb
  5. Listeners
Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.clb.Listeners

volcengine logo
Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine
    Deprecated: volcengine.clb.Listeners has been deprecated in favor of volcengine.clb.getListeners

    Use this data source to query detailed information of listeners

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
import * as volcengine from "@volcengine/pulumi";

const fooZones = volcengine.ecs.getZones({});
const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
});
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.0.0/24",
    zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
    vpcId: fooVpc.id,
});
const fooClb = new volcengine.clb.Clb("fooClb", {
    type: "public",
    subnetId: fooSubnet.id,
    loadBalancerSpec: "small_1",
    description: "acc0Demo",
    loadBalancerName: "acc-test-create",
    eipBillingConfig: {
        isp: "BGP",
        eipBillingType: "PostPaidByBandwidth",
        bandwidth: 1,
    },
});
const fooServerGroup = new volcengine.clb.ServerGroup("fooServerGroup", {
    loadBalancerId: fooClb.id,
    serverGroupName: "acc-test-create",
    description: "hello demo11",
});
const fooListener = new volcengine.clb.Listener("fooListener", {
    loadBalancerId: fooClb.id,
    listenerName: "acc-test-listener",
    protocol: "HTTP",
    port: 90,
    serverGroupId: fooServerGroup.id,
    healthCheck: {
        enabled: "on",
        interval: 10,
        timeout: 3,
        healthyThreshold: 5,
        unHealthyThreshold: 2,
        domain: "volcengine.com",
        httpCode: "http_2xx",
        method: "GET",
        uri: "/",
    },
    enabled: "on",
});
const fooListeners = volcengine.clb.getListenersOutput({
    ids: [fooListener.id],
});

    import pulumi
import pulumi_volcengine as volcengine

foo_zones = volcengine.ecs.get_zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id=foo_zones.zones[0].id,
    vpc_id=foo_vpc.id)
foo_clb = volcengine.clb.Clb("fooClb",
    type="public",
    subnet_id=foo_subnet.id,
    load_balancer_spec="small_1",
    description="acc0Demo",
    load_balancer_name="acc-test-create",
    eip_billing_config=volcengine.clb.ClbEipBillingConfigArgs(
        isp="BGP",
        eip_billing_type="PostPaidByBandwidth",
        bandwidth=1,
    ))
foo_server_group = volcengine.clb.ServerGroup("fooServerGroup",
    load_balancer_id=foo_clb.id,
    server_group_name="acc-test-create",
    description="hello demo11")
foo_listener = volcengine.clb.Listener("fooListener",
    load_balancer_id=foo_clb.id,
    listener_name="acc-test-listener",
    protocol="HTTP",
    port=90,
    server_group_id=foo_server_group.id,
    health_check=volcengine.clb.ListenerHealthCheckArgs(
        enabled="on",
        interval=10,
        timeout=3,
        healthy_threshold=5,
        un_healthy_threshold=2,
        domain="volcengine.com",
        http_code="http_2xx",
        method="GET",
        uri="/",
    ),
    enabled="on")
foo_listeners = volcengine.clb.get_listeners_output(ids=[foo_listener.id])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/clb"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooZones, err := ecs.GetZones(ctx, nil, nil)
		if err != nil {
			return err
		}
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String(fooZones.Zones[0].Id),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		fooClb, err := clb.NewClb(ctx, "fooClb", &clb.ClbArgs{
			Type:             pulumi.String("public"),
			SubnetId:         fooSubnet.ID(),
			LoadBalancerSpec: pulumi.String("small_1"),
			Description:      pulumi.String("acc0Demo"),
			LoadBalancerName: pulumi.String("acc-test-create"),
			EipBillingConfig: &clb.ClbEipBillingConfigArgs{
				Isp:            pulumi.String("BGP"),
				EipBillingType: pulumi.String("PostPaidByBandwidth"),
				Bandwidth:      pulumi.Int(1),
			},
		})
		if err != nil {
			return err
		}
		fooServerGroup, err := clb.NewServerGroup(ctx, "fooServerGroup", &clb.ServerGroupArgs{
			LoadBalancerId:  fooClb.ID(),
			ServerGroupName: pulumi.String("acc-test-create"),
			Description:     pulumi.String("hello demo11"),
		})
		if err != nil {
			return err
		}
		fooListener, err := clb.NewListener(ctx, "fooListener", &clb.ListenerArgs{
			LoadBalancerId: fooClb.ID(),
			ListenerName:   pulumi.String("acc-test-listener"),
			Protocol:       pulumi.String("HTTP"),
			Port:           pulumi.Int(90),
			ServerGroupId:  fooServerGroup.ID(),
			HealthCheck: &clb.ListenerHealthCheckArgs{
				Enabled:            pulumi.String("on"),
				Interval:           pulumi.Int(10),
				Timeout:            pulumi.Int(3),
				HealthyThreshold:   pulumi.Int(5),
				UnHealthyThreshold: pulumi.Int(2),
				Domain:             pulumi.String("volcengine.com"),
				HttpCode:           pulumi.String("http_2xx"),
				Method:             pulumi.String("GET"),
				Uri:                pulumi.String("/"),
			},
			Enabled: pulumi.String("on"),
		})
		if err != nil {
			return err
		}
		_ = clb.GetListenersOutput(ctx, clb.GetListenersOutputArgs{
			Ids: pulumi.StringArray{
				fooListener.ID(),
			},
		}, nil)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var fooZones = Volcengine.Ecs.GetZones.Invoke();

    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = fooZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        VpcId = fooVpc.Id,
    });

    var fooClb = new Volcengine.Clb.Clb("fooClb", new()
    {
        Type = "public",
        SubnetId = fooSubnet.Id,
        LoadBalancerSpec = "small_1",
        Description = "acc0Demo",
        LoadBalancerName = "acc-test-create",
        EipBillingConfig = new Volcengine.Clb.Inputs.ClbEipBillingConfigArgs
        {
            Isp = "BGP",
            EipBillingType = "PostPaidByBandwidth",
            Bandwidth = 1,
        },
    });

    var fooServerGroup = new Volcengine.Clb.ServerGroup("fooServerGroup", new()
    {
        LoadBalancerId = fooClb.Id,
        ServerGroupName = "acc-test-create",
        Description = "hello demo11",
    });

    var fooListener = new Volcengine.Clb.Listener("fooListener", new()
    {
        LoadBalancerId = fooClb.Id,
        ListenerName = "acc-test-listener",
        Protocol = "HTTP",
        Port = 90,
        ServerGroupId = fooServerGroup.Id,
        HealthCheck = new Volcengine.Clb.Inputs.ListenerHealthCheckArgs
        {
            Enabled = "on",
            Interval = 10,
            Timeout = 3,
            HealthyThreshold = 5,
            UnHealthyThreshold = 2,
            Domain = "volcengine.com",
            HttpCode = "http_2xx",
            Method = "GET",
            Uri = "/",
        },
        Enabled = "on",
    });

    var fooListeners = Volcengine.Clb.GetListeners.Invoke(new()
    {
        Ids = new[]
        {
            fooListener.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.GetZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.clb.Clb;
import com.pulumi.volcengine.clb.ClbArgs;
import com.pulumi.volcengine.clb.inputs.ClbEipBillingConfigArgs;
import com.pulumi.volcengine.clb.ServerGroup;
import com.pulumi.volcengine.clb.ServerGroupArgs;
import com.pulumi.volcengine.clb.Listener;
import com.pulumi.volcengine.clb.ListenerArgs;
import com.pulumi.volcengine.clb.inputs.ListenerHealthCheckArgs;
import com.pulumi.volcengine.clb.ClbFunctions;
import com.pulumi.volcengine.clb.inputs.GetListenersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var fooZones = EcsFunctions.getZones();

        var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .vpcId(fooVpc.id())
            .build());

        var fooClb = new Clb("fooClb", ClbArgs.builder()        
            .type("public")
            .subnetId(fooSubnet.id())
            .loadBalancerSpec("small_1")
            .description("acc0Demo")
            .loadBalancerName("acc-test-create")
            .eipBillingConfig(ClbEipBillingConfigArgs.builder()
                .isp("BGP")
                .eipBillingType("PostPaidByBandwidth")
                .bandwidth(1)
                .build())
            .build());

        var fooServerGroup = new ServerGroup("fooServerGroup", ServerGroupArgs.builder()        
            .loadBalancerId(fooClb.id())
            .serverGroupName("acc-test-create")
            .description("hello demo11")
            .build());

        var fooListener = new Listener("fooListener", ListenerArgs.builder()        
            .loadBalancerId(fooClb.id())
            .listenerName("acc-test-listener")
            .protocol("HTTP")
            .port(90)
            .serverGroupId(fooServerGroup.id())
            .healthCheck(ListenerHealthCheckArgs.builder()
                .enabled("on")
                .interval(10)
                .timeout(3)
                .healthyThreshold(5)
                .unHealthyThreshold(2)
                .domain("volcengine.com")
                .httpCode("http_2xx")
                .method("GET")
                .uri("/")
                .build())
            .enabled("on")
            .build());

        final var fooListeners = ClbFunctions.getListeners(GetListenersArgs.builder()
            .ids(fooListener.id())
            .build());

    }
}

    resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  fooSubnet:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: ${fooZones.zones[0].id}
      vpcId: ${fooVpc.id}
  fooClb:
    type: volcengine:clb:Clb
    properties:
      type: public
      subnetId: ${fooSubnet.id}
      loadBalancerSpec: small_1
      description: acc0Demo
      loadBalancerName: acc-test-create
      eipBillingConfig:
        isp: BGP
        eipBillingType: PostPaidByBandwidth
        bandwidth: 1
  fooServerGroup:
    type: volcengine:clb:ServerGroup
    properties:
      loadBalancerId: ${fooClb.id}
      serverGroupName: acc-test-create
      description: hello demo11
  fooListener:
    type: volcengine:clb:Listener
    properties:
      loadBalancerId: ${fooClb.id}
      listenerName: acc-test-listener
      protocol: HTTP
      port: 90
      serverGroupId: ${fooServerGroup.id}
      healthCheck:
        enabled: on
        interval: 10
        timeout: 3
        healthyThreshold: 5
        unHealthyThreshold: 2
        domain: volcengine.com
        httpCode: http_2xx
        method: GET
        uri: /
      enabled: on
variables:
  fooZones:
    fn::invoke:
      Function: volcengine:ecs:getZones
      Arguments: {}
  fooListeners:
    fn::invoke:
      Function: volcengine:clb:getListeners
      Arguments:
        ids:
          - ${fooListener.id}

    Using Listeners

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

    function listeners(args: ListenersArgs, opts?: InvokeOptions): Promise<ListenersResult>
function listenersOutput(args: ListenersOutputArgs, opts?: InvokeOptions): Output<ListenersResult>
    def listeners(ids: Optional[Sequence[str]] = None,
              listener_name: Optional[str] = None,
              load_balancer_id: Optional[str] = None,
              name_regex: Optional[str] = None,
              output_file: Optional[str] = None,
              protocol: Optional[str] = None,
              tags: Optional[Sequence[ListenersTag]] = None,
              opts: Optional[InvokeOptions] = None) -> ListenersResult
def listeners_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              listener_name: Optional[pulumi.Input[str]] = None,
              load_balancer_id: Optional[pulumi.Input[str]] = None,
              name_regex: Optional[pulumi.Input[str]] = None,
              output_file: Optional[pulumi.Input[str]] = None,
              protocol: Optional[pulumi.Input[str]] = None,
              tags: Optional[pulumi.Input[Sequence[pulumi.Input[ListenersTagArgs]]]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[ListenersResult]
    func Listeners(ctx *Context, args *ListenersArgs, opts ...InvokeOption) (*ListenersResult, error)
func ListenersOutput(ctx *Context, args *ListenersOutputArgs, opts ...InvokeOption) ListenersResultOutput
    public static class Listeners 
{
    public static Task<ListenersResult> InvokeAsync(ListenersArgs args, InvokeOptions? opts = null)
    public static Output<ListenersResult> Invoke(ListenersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<ListenersResult> listeners(ListenersArgs args, InvokeOptions options)
public static Output<ListenersResult> listeners(ListenersArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:clb:Listeners
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A list of Listener IDs.
    ListenerName string
    The name of the Listener.
    LoadBalancerId string
    The id of the Clb.
    NameRegex string
    A Name Regex of Listener.
    OutputFile string
    File name where to save data source results.
    Protocol string
    The protocol of the Listener. Values: TCP, UDP, HTTP, HTTPS.
    Tags List<ListenersTag>
    Tags.
    Ids []string
    A list of Listener IDs.
    ListenerName string
    The name of the Listener.
    LoadBalancerId string
    The id of the Clb.
    NameRegex string
    A Name Regex of Listener.
    OutputFile string
    File name where to save data source results.
    Protocol string
    The protocol of the Listener. Values: TCP, UDP, HTTP, HTTPS.
    Tags []ListenersTag
    Tags.
    ids List<String>
    A list of Listener IDs.
    listenerName String
    The name of the Listener.
    loadBalancerId String
    The id of the Clb.
    nameRegex String
    A Name Regex of Listener.
    outputFile String
    File name where to save data source results.
    protocol String
    The protocol of the Listener. Values: TCP, UDP, HTTP, HTTPS.
    tags List<ListenersTag>
    Tags.
    ids string[]
    A list of Listener IDs.
    listenerName string
    The name of the Listener.
    loadBalancerId string
    The id of the Clb.
    nameRegex string
    A Name Regex of Listener.
    outputFile string
    File name where to save data source results.
    protocol string
    The protocol of the Listener. Values: TCP, UDP, HTTP, HTTPS.
    tags ListenersTag[]
    Tags.
    ids Sequence[str]
    A list of Listener IDs.
    listener_name str
    The name of the Listener.
    load_balancer_id str
    The id of the Clb.
    name_regex str
    A Name Regex of Listener.
    output_file str
    File name where to save data source results.
    protocol str
    The protocol of the Listener. Values: TCP, UDP, HTTP, HTTPS.
    tags Sequence[ListenersTag]
    Tags.
    ids List<String>
    A list of Listener IDs.
    listenerName String
    The name of the Listener.
    loadBalancerId String
    The id of the Clb.
    nameRegex String
    A Name Regex of Listener.
    outputFile String
    File name where to save data source results.
    protocol String
    The protocol of the Listener. Values: TCP, UDP, HTTP, HTTPS.
    tags List<Property Map>
    Tags.

    Listeners Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Listeners List<ListenersListener>
    The collection of Listener query.
    TotalCount int
    The total count of Listener query.
    Ids List<string>
    ListenerName string
    The name of the Listener.
    LoadBalancerId string
    The id of the Clb.
    NameRegex string
    OutputFile string
    Protocol string
    The protocol of the Listener.
    Tags List<ListenersTag>
    Tags.
    Id string
    The provider-assigned unique ID for this managed resource.
    Listeners []ListenersListener
    The collection of Listener query.
    TotalCount int
    The total count of Listener query.
    Ids []string
    ListenerName string
    The name of the Listener.
    LoadBalancerId string
    The id of the Clb.
    NameRegex string
    OutputFile string
    Protocol string
    The protocol of the Listener.
    Tags []ListenersTag
    Tags.
    id String
    The provider-assigned unique ID for this managed resource.
    listeners List<ListenersListener>
    The collection of Listener query.
    totalCount Integer
    The total count of Listener query.
    ids List<String>
    listenerName String
    The name of the Listener.
    loadBalancerId String
    The id of the Clb.
    nameRegex String
    outputFile String
    protocol String
    The protocol of the Listener.
    tags List<ListenersTag>
    Tags.
    id string
    The provider-assigned unique ID for this managed resource.
    listeners ListenersListener[]
    The collection of Listener query.
    totalCount number
    The total count of Listener query.
    ids string[]
    listenerName string
    The name of the Listener.
    loadBalancerId string
    The id of the Clb.
    nameRegex string
    outputFile string
    protocol string
    The protocol of the Listener.
    tags ListenersTag[]
    Tags.
    id str
    The provider-assigned unique ID for this managed resource.
    listeners Sequence[ListenersListener]
    The collection of Listener query.
    total_count int
    The total count of Listener query.
    ids Sequence[str]
    listener_name str
    The name of the Listener.
    load_balancer_id str
    The id of the Clb.
    name_regex str
    output_file str
    protocol str
    The protocol of the Listener.
    tags Sequence[ListenersTag]
    Tags.
    id String
    The provider-assigned unique ID for this managed resource.
    listeners List<Property Map>
    The collection of Listener query.
    totalCount Number
    The total count of Listener query.
    ids List<String>
    listenerName String
    The name of the Listener.
    loadBalancerId String
    The id of the Clb.
    nameRegex String
    outputFile String
    protocol String
    The protocol of the Listener.
    tags List<Property Map>
    Tags.

    Supporting Types

    ListenersListener

    AclIds List<string>
    The acl ID list to which the Listener is bound.
    AclStatus string
    The acl status of the Listener.
    AclType string
    The acl type of the Listener.
    Bandwidth int
    The bandwidth of the Listener. Unit: Mbps.
    CaCertificateId string
    The ID of the CA certificate which is associated with the Listener. When ca_enabled is true, this parameter is returned.
    CaEnabled string
    Whether to enable CACertificate two-way authentication.
    CertCenterCertificateId string
    The ID of the certificate in Certificate Center. When certificate_source is cert_center, this parameter is returned.
    CertificateId string
    The ID of the certificate which is associated with the Listener.
    CertificateSource string
    The source of the certificate which is associated with the Listener. Values: clb, cert_center.
    ClientBodyTimeout int
    The client body timeout of the Listener. Only HTTP/HTTPS listeners return this parameter.
    ClientHeaderTimeout int
    The client header timeout of the Listener. Only HTTP/HTTPS listeners return this parameter.
    ConnectionDrainEnabled string
    Whether to enable connection drain of the Listener.
    ConnectionDrainTimeout int
    The connection drain timeout of the Listener.
    Cookie string
    The name of the cookie for session persistence configured on the backend server.
    Cps int
    The maximum number of new connections for Lsistener.
    CreateTime string
    The create time of the Listener.
    Description string
    The description of the Listener.
    Enabled string
    The enable status of the Listener.
    EndPort int
    The end port of the Listener. This parameter is returned only when full-port listening is enabled.
    EstablishedTimeout int
    The established timeout of the Listener.
    HealthCheckDomain string
    The domain of health check.
    HealthCheckEnabled string
    The enable status of health check function.
    HealthCheckHealthyThreshold int
    The healthy threshold of health check.
    HealthCheckHttpCode string
    The normal http status code of health check.
    HealthCheckInterval int
    The interval executing health check.
    HealthCheckMethod string
    The method of health check.
    HealthCheckTimeout int
    The response timeout of health check.
    HealthCheckUdpExpect string
    The expected response string for the health check.
    HealthCheckUdpRequest string
    A request string to perform a health check.
    HealthCheckUnHealthyThreshold int
    The unhealthy threshold of health check.
    HealthCheckUri string
    The uri of health check.
    HelthCheckPort int
    The backend server port for health checks. When full-port listening is enabled, this parameter is returned to indicate the port used for health checks. When full-port listening is not enabled, this parameter is not returned, and the health check uses the service port of the backend server.
    Http2Enabled string
    Whether the HTTPS protocol listener enables the front-end HTTP 2.0 protocol.
    Id string
    The ID of the Listener.
    KeepaliveTimeout int
    The timeout period for the long connection between the client and the CLB. Only HTTP/HTTPS listeners return this parameter.
    ListenerId string
    The ID of the Listener.
    ListenerName string
    The name of the Listener.
    LoadBalancerId string
    The id of the Clb.
    MaxConnections int
    The maximum number of connections for the Listener.
    PersistenceTimeout int
    The persistence timeout of the Listener.
    PersistenceType string
    The persistence type of the Listener.
    Port int
    The port receiving request of the Listener.
    Protocol string
    The protocol of the Listener. Values: TCP, UDP, HTTP, HTTPS.
    ProxyConnectTimeout int
    The timeout period for establishing a connection between the CLB and the backend server. Only HTTP/HTTPS listeners return this parameter.
    ProxyProtocolType string
    Whether to enable proxy protocol.
    ProxyReadTimeout int
    The timeout period for CLB to read the response from the backend server. Only HTTP/HTTPS listeners return this parameter.
    ProxySendTimeout int
    The timeout period for CLB to transmit requests to backend servers. Only HTTP/HTTPS listeners return this parameter.
    Scheduler string
    The scheduling algorithm of the Listener. Values: wrr, wlc, sh.
    SecurityPolicyId string
    The TLS security policy of the HTTPS listener. Only HTTPS listeners return this parameter.
    SendTimeout int
    The timeout period for CLB to send responses to the client. Only HTTP/HTTPS listeners return this parameter.
    ServerGroupId string
    The ID of the backend server group which is associated with the Listener.
    StartPort int
    The start port of the Listener. This parameter is returned only when full-port listening is enabled.
    Status string
    The status of the Listener.
    Tags List<ListenersListenerTag>
    Tags.
    UpdateTime string
    The update time of the Listener.
    WafProtectionEnabled string
    Whether to enable WAF protection.
    AclIds []string
    The acl ID list to which the Listener is bound.
    AclStatus string
    The acl status of the Listener.
    AclType string
    The acl type of the Listener.
    Bandwidth int
    The bandwidth of the Listener. Unit: Mbps.
    CaCertificateId string
    The ID of the CA certificate which is associated with the Listener. When ca_enabled is true, this parameter is returned.
    CaEnabled string
    Whether to enable CACertificate two-way authentication.
    CertCenterCertificateId string
    The ID of the certificate in Certificate Center. When certificate_source is cert_center, this parameter is returned.
    CertificateId string
    The ID of the certificate which is associated with the Listener.
    CertificateSource string
    The source of the certificate which is associated with the Listener. Values: clb, cert_center.
    ClientBodyTimeout int
    The client body timeout of the Listener. Only HTTP/HTTPS listeners return this parameter.
    ClientHeaderTimeout int
    The client header timeout of the Listener. Only HTTP/HTTPS listeners return this parameter.
    ConnectionDrainEnabled string
    Whether to enable connection drain of the Listener.
    ConnectionDrainTimeout int
    The connection drain timeout of the Listener.
    Cookie string
    The name of the cookie for session persistence configured on the backend server.
    Cps int
    The maximum number of new connections for Lsistener.
    CreateTime string
    The create time of the Listener.
    Description string
    The description of the Listener.
    Enabled string
    The enable status of the Listener.
    EndPort int
    The end port of the Listener. This parameter is returned only when full-port listening is enabled.
    EstablishedTimeout int
    The established timeout of the Listener.
    HealthCheckDomain string
    The domain of health check.
    HealthCheckEnabled string
    The enable status of health check function.
    HealthCheckHealthyThreshold int
    The healthy threshold of health check.
    HealthCheckHttpCode string
    The normal http status code of health check.
    HealthCheckInterval int
    The interval executing health check.
    HealthCheckMethod string
    The method of health check.
    HealthCheckTimeout int
    The response timeout of health check.
    HealthCheckUdpExpect string
    The expected response string for the health check.
    HealthCheckUdpRequest string
    A request string to perform a health check.
    HealthCheckUnHealthyThreshold int
    The unhealthy threshold of health check.
    HealthCheckUri string
    The uri of health check.
    HelthCheckPort int
    The backend server port for health checks. When full-port listening is enabled, this parameter is returned to indicate the port used for health checks. When full-port listening is not enabled, this parameter is not returned, and the health check uses the service port of the backend server.
    Http2Enabled string
    Whether the HTTPS protocol listener enables the front-end HTTP 2.0 protocol.
    Id string
    The ID of the Listener.
    KeepaliveTimeout int
    The timeout period for the long connection between the client and the CLB. Only HTTP/HTTPS listeners return this parameter.
    ListenerId string
    The ID of the Listener.
    ListenerName string
    The name of the Listener.
    LoadBalancerId string
    The id of the Clb.
    MaxConnections int
    The maximum number of connections for the Listener.
    PersistenceTimeout int
    The persistence timeout of the Listener.
    PersistenceType string
    The persistence type of the Listener.
    Port int
    The port receiving request of the Listener.
    Protocol string
    The protocol of the Listener. Values: TCP, UDP, HTTP, HTTPS.
    ProxyConnectTimeout int
    The timeout period for establishing a connection between the CLB and the backend server. Only HTTP/HTTPS listeners return this parameter.
    ProxyProtocolType string
    Whether to enable proxy protocol.
    ProxyReadTimeout int
    The timeout period for CLB to read the response from the backend server. Only HTTP/HTTPS listeners return this parameter.
    ProxySendTimeout int
    The timeout period for CLB to transmit requests to backend servers. Only HTTP/HTTPS listeners return this parameter.
    Scheduler string
    The scheduling algorithm of the Listener. Values: wrr, wlc, sh.
    SecurityPolicyId string
    The TLS security policy of the HTTPS listener. Only HTTPS listeners return this parameter.
    SendTimeout int
    The timeout period for CLB to send responses to the client. Only HTTP/HTTPS listeners return this parameter.
    ServerGroupId string
    The ID of the backend server group which is associated with the Listener.
    StartPort int
    The start port of the Listener. This parameter is returned only when full-port listening is enabled.
    Status string
    The status of the Listener.
    Tags []ListenersListenerTag
    Tags.
    UpdateTime string
    The update time of the Listener.
    WafProtectionEnabled string
    Whether to enable WAF protection.
    aclIds List<String>
    The acl ID list to which the Listener is bound.
    aclStatus String
    The acl status of the Listener.
    aclType String
    The acl type of the Listener.
    bandwidth Integer
    The bandwidth of the Listener. Unit: Mbps.
    caCertificateId String
    The ID of the CA certificate which is associated with the Listener. When ca_enabled is true, this parameter is returned.
    caEnabled String
    Whether to enable CACertificate two-way authentication.
    certCenterCertificateId String
    The ID of the certificate in Certificate Center. When certificate_source is cert_center, this parameter is returned.
    certificateId String
    The ID of the certificate which is associated with the Listener.
    certificateSource String
    The source of the certificate which is associated with the Listener. Values: clb, cert_center.
    clientBodyTimeout Integer
    The client body timeout of the Listener. Only HTTP/HTTPS listeners return this parameter.
    clientHeaderTimeout Integer
    The client header timeout of the Listener. Only HTTP/HTTPS listeners return this parameter.
    connectionDrainEnabled String
    Whether to enable connection drain of the Listener.
    connectionDrainTimeout Integer
    The connection drain timeout of the Listener.
    cookie String
    The name of the cookie for session persistence configured on the backend server.
    cps Integer
    The maximum number of new connections for Lsistener.
    createTime String
    The create time of the Listener.
    description String
    The description of the Listener.
    enabled String
    The enable status of the Listener.
    endPort Integer
    The end port of the Listener. This parameter is returned only when full-port listening is enabled.
    establishedTimeout Integer
    The established timeout of the Listener.
    healthCheckDomain String
    The domain of health check.
    healthCheckEnabled String
    The enable status of health check function.
    healthCheckHealthyThreshold Integer
    The healthy threshold of health check.
    healthCheckHttpCode String
    The normal http status code of health check.
    healthCheckInterval Integer
    The interval executing health check.
    healthCheckMethod String
    The method of health check.
    healthCheckTimeout Integer
    The response timeout of health check.
    healthCheckUdpExpect String
    The expected response string for the health check.
    healthCheckUdpRequest String
    A request string to perform a health check.
    healthCheckUnHealthyThreshold Integer
    The unhealthy threshold of health check.
    healthCheckUri String
    The uri of health check.
    helthCheckPort Integer
    The backend server port for health checks. When full-port listening is enabled, this parameter is returned to indicate the port used for health checks. When full-port listening is not enabled, this parameter is not returned, and the health check uses the service port of the backend server.
    http2Enabled String
    Whether the HTTPS protocol listener enables the front-end HTTP 2.0 protocol.
    id String
    The ID of the Listener.
    keepaliveTimeout Integer
    The timeout period for the long connection between the client and the CLB. Only HTTP/HTTPS listeners return this parameter.
    listenerId String
    The ID of the Listener.
    listenerName String
    The name of the Listener.
    loadBalancerId String
    The id of the Clb.
    maxConnections Integer
    The maximum number of connections for the Listener.
    persistenceTimeout Integer
    The persistence timeout of the Listener.
    persistenceType String
    The persistence type of the Listener.
    port Integer
    The port receiving request of the Listener.
    protocol String
    The protocol of the Listener. Values: TCP, UDP, HTTP, HTTPS.
    proxyConnectTimeout Integer
    The timeout period for establishing a connection between the CLB and the backend server. Only HTTP/HTTPS listeners return this parameter.
    proxyProtocolType String
    Whether to enable proxy protocol.
    proxyReadTimeout Integer
    The timeout period for CLB to read the response from the backend server. Only HTTP/HTTPS listeners return this parameter.
    proxySendTimeout Integer
    The timeout period for CLB to transmit requests to backend servers. Only HTTP/HTTPS listeners return this parameter.
    scheduler String
    The scheduling algorithm of the Listener. Values: wrr, wlc, sh.
    securityPolicyId String
    The TLS security policy of the HTTPS listener. Only HTTPS listeners return this parameter.
    sendTimeout Integer
    The timeout period for CLB to send responses to the client. Only HTTP/HTTPS listeners return this parameter.
    serverGroupId String
    The ID of the backend server group which is associated with the Listener.
    startPort Integer
    The start port of the Listener. This parameter is returned only when full-port listening is enabled.
    status String
    The status of the Listener.
    tags List<ListenersListenerTag>
    Tags.
    updateTime String
    The update time of the Listener.
    wafProtectionEnabled String
    Whether to enable WAF protection.
    aclIds string[]
    The acl ID list to which the Listener is bound.
    aclStatus string
    The acl status of the Listener.
    aclType string
    The acl type of the Listener.
    bandwidth number
    The bandwidth of the Listener. Unit: Mbps.
    caCertificateId string
    The ID of the CA certificate which is associated with the Listener. When ca_enabled is true, this parameter is returned.
    caEnabled string
    Whether to enable CACertificate two-way authentication.
    certCenterCertificateId string
    The ID of the certificate in Certificate Center. When certificate_source is cert_center, this parameter is returned.
    certificateId string
    The ID of the certificate which is associated with the Listener.
    certificateSource string
    The source of the certificate which is associated with the Listener. Values: clb, cert_center.
    clientBodyTimeout number
    The client body timeout of the Listener. Only HTTP/HTTPS listeners return this parameter.
    clientHeaderTimeout number
    The client header timeout of the Listener. Only HTTP/HTTPS listeners return this parameter.
    connectionDrainEnabled string
    Whether to enable connection drain of the Listener.
    connectionDrainTimeout number
    The connection drain timeout of the Listener.
    cookie string
    The name of the cookie for session persistence configured on the backend server.
    cps number
    The maximum number of new connections for Lsistener.
    createTime string
    The create time of the Listener.
    description string
    The description of the Listener.
    enabled string
    The enable status of the Listener.
    endPort number
    The end port of the Listener. This parameter is returned only when full-port listening is enabled.
    establishedTimeout number
    The established timeout of the Listener.
    healthCheckDomain string
    The domain of health check.
    healthCheckEnabled string
    The enable status of health check function.
    healthCheckHealthyThreshold number
    The healthy threshold of health check.
    healthCheckHttpCode string
    The normal http status code of health check.
    healthCheckInterval number
    The interval executing health check.
    healthCheckMethod string
    The method of health check.
    healthCheckTimeout number
    The response timeout of health check.
    healthCheckUdpExpect string
    The expected response string for the health check.
    healthCheckUdpRequest string
    A request string to perform a health check.
    healthCheckUnHealthyThreshold number
    The unhealthy threshold of health check.
    healthCheckUri string
    The uri of health check.
    helthCheckPort number
    The backend server port for health checks. When full-port listening is enabled, this parameter is returned to indicate the port used for health checks. When full-port listening is not enabled, this parameter is not returned, and the health check uses the service port of the backend server.
    http2Enabled string
    Whether the HTTPS protocol listener enables the front-end HTTP 2.0 protocol.
    id string
    The ID of the Listener.
    keepaliveTimeout number
    The timeout period for the long connection between the client and the CLB. Only HTTP/HTTPS listeners return this parameter.
    listenerId string
    The ID of the Listener.
    listenerName string
    The name of the Listener.
    loadBalancerId string
    The id of the Clb.
    maxConnections number
    The maximum number of connections for the Listener.
    persistenceTimeout number
    The persistence timeout of the Listener.
    persistenceType string
    The persistence type of the Listener.
    port number
    The port receiving request of the Listener.
    protocol string
    The protocol of the Listener. Values: TCP, UDP, HTTP, HTTPS.
    proxyConnectTimeout number
    The timeout period for establishing a connection between the CLB and the backend server. Only HTTP/HTTPS listeners return this parameter.
    proxyProtocolType string
    Whether to enable proxy protocol.
    proxyReadTimeout number
    The timeout period for CLB to read the response from the backend server. Only HTTP/HTTPS listeners return this parameter.
    proxySendTimeout number
    The timeout period for CLB to transmit requests to backend servers. Only HTTP/HTTPS listeners return this parameter.
    scheduler string
    The scheduling algorithm of the Listener. Values: wrr, wlc, sh.
    securityPolicyId string
    The TLS security policy of the HTTPS listener. Only HTTPS listeners return this parameter.
    sendTimeout number
    The timeout period for CLB to send responses to the client. Only HTTP/HTTPS listeners return this parameter.
    serverGroupId string
    The ID of the backend server group which is associated with the Listener.
    startPort number
    The start port of the Listener. This parameter is returned only when full-port listening is enabled.
    status string
    The status of the Listener.
    tags ListenersListenerTag[]
    Tags.
    updateTime string
    The update time of the Listener.
    wafProtectionEnabled string
    Whether to enable WAF protection.
    acl_ids Sequence[str]
    The acl ID list to which the Listener is bound.
    acl_status str
    The acl status of the Listener.
    acl_type str
    The acl type of the Listener.
    bandwidth int
    The bandwidth of the Listener. Unit: Mbps.
    ca_certificate_id str
    The ID of the CA certificate which is associated with the Listener. When ca_enabled is true, this parameter is returned.
    ca_enabled str
    Whether to enable CACertificate two-way authentication.
    cert_center_certificate_id str
    The ID of the certificate in Certificate Center. When certificate_source is cert_center, this parameter is returned.
    certificate_id str
    The ID of the certificate which is associated with the Listener.
    certificate_source str
    The source of the certificate which is associated with the Listener. Values: clb, cert_center.
    client_body_timeout int
    The client body timeout of the Listener. Only HTTP/HTTPS listeners return this parameter.
    client_header_timeout int
    The client header timeout of the Listener. Only HTTP/HTTPS listeners return this parameter.
    connection_drain_enabled str
    Whether to enable connection drain of the Listener.
    connection_drain_timeout int
    The connection drain timeout of the Listener.
    cookie str
    The name of the cookie for session persistence configured on the backend server.
    cps int
    The maximum number of new connections for Lsistener.
    create_time str
    The create time of the Listener.
    description str
    The description of the Listener.
    enabled str
    The enable status of the Listener.
    end_port int
    The end port of the Listener. This parameter is returned only when full-port listening is enabled.
    established_timeout int
    The established timeout of the Listener.
    health_check_domain str
    The domain of health check.
    health_check_enabled str
    The enable status of health check function.
    health_check_healthy_threshold int
    The healthy threshold of health check.
    health_check_http_code str
    The normal http status code of health check.
    health_check_interval int
    The interval executing health check.
    health_check_method str
    The method of health check.
    health_check_timeout int
    The response timeout of health check.
    health_check_udp_expect str
    The expected response string for the health check.
    health_check_udp_request str
    A request string to perform a health check.
    health_check_un_healthy_threshold int
    The unhealthy threshold of health check.
    health_check_uri str
    The uri of health check.
    helth_check_port int
    The backend server port for health checks. When full-port listening is enabled, this parameter is returned to indicate the port used for health checks. When full-port listening is not enabled, this parameter is not returned, and the health check uses the service port of the backend server.
    http2_enabled str
    Whether the HTTPS protocol listener enables the front-end HTTP 2.0 protocol.
    id str
    The ID of the Listener.
    keepalive_timeout int
    The timeout period for the long connection between the client and the CLB. Only HTTP/HTTPS listeners return this parameter.
    listener_id str
    The ID of the Listener.
    listener_name str
    The name of the Listener.
    load_balancer_id str
    The id of the Clb.
    max_connections int
    The maximum number of connections for the Listener.
    persistence_timeout int
    The persistence timeout of the Listener.
    persistence_type str
    The persistence type of the Listener.
    port int
    The port receiving request of the Listener.
    protocol str
    The protocol of the Listener. Values: TCP, UDP, HTTP, HTTPS.
    proxy_connect_timeout int
    The timeout period for establishing a connection between the CLB and the backend server. Only HTTP/HTTPS listeners return this parameter.
    proxy_protocol_type str
    Whether to enable proxy protocol.
    proxy_read_timeout int
    The timeout period for CLB to read the response from the backend server. Only HTTP/HTTPS listeners return this parameter.
    proxy_send_timeout int
    The timeout period for CLB to transmit requests to backend servers. Only HTTP/HTTPS listeners return this parameter.
    scheduler str
    The scheduling algorithm of the Listener. Values: wrr, wlc, sh.
    security_policy_id str
    The TLS security policy of the HTTPS listener. Only HTTPS listeners return this parameter.
    send_timeout int
    The timeout period for CLB to send responses to the client. Only HTTP/HTTPS listeners return this parameter.
    server_group_id str
    The ID of the backend server group which is associated with the Listener.
    start_port int
    The start port of the Listener. This parameter is returned only when full-port listening is enabled.
    status str
    The status of the Listener.
    tags Sequence[ListenersListenerTag]
    Tags.
    update_time str
    The update time of the Listener.
    waf_protection_enabled str
    Whether to enable WAF protection.
    aclIds List<String>
    The acl ID list to which the Listener is bound.
    aclStatus String
    The acl status of the Listener.
    aclType String
    The acl type of the Listener.
    bandwidth Number
    The bandwidth of the Listener. Unit: Mbps.
    caCertificateId String
    The ID of the CA certificate which is associated with the Listener. When ca_enabled is true, this parameter is returned.
    caEnabled String
    Whether to enable CACertificate two-way authentication.
    certCenterCertificateId String
    The ID of the certificate in Certificate Center. When certificate_source is cert_center, this parameter is returned.
    certificateId String
    The ID of the certificate which is associated with the Listener.
    certificateSource String
    The source of the certificate which is associated with the Listener. Values: clb, cert_center.
    clientBodyTimeout Number
    The client body timeout of the Listener. Only HTTP/HTTPS listeners return this parameter.
    clientHeaderTimeout Number
    The client header timeout of the Listener. Only HTTP/HTTPS listeners return this parameter.
    connectionDrainEnabled String
    Whether to enable connection drain of the Listener.
    connectionDrainTimeout Number
    The connection drain timeout of the Listener.
    cookie String
    The name of the cookie for session persistence configured on the backend server.
    cps Number
    The maximum number of new connections for Lsistener.
    createTime String
    The create time of the Listener.
    description String
    The description of the Listener.
    enabled String
    The enable status of the Listener.
    endPort Number
    The end port of the Listener. This parameter is returned only when full-port listening is enabled.
    establishedTimeout Number
    The established timeout of the Listener.
    healthCheckDomain String
    The domain of health check.
    healthCheckEnabled String
    The enable status of health check function.
    healthCheckHealthyThreshold Number
    The healthy threshold of health check.
    healthCheckHttpCode String
    The normal http status code of health check.
    healthCheckInterval Number
    The interval executing health check.
    healthCheckMethod String
    The method of health check.
    healthCheckTimeout Number
    The response timeout of health check.
    healthCheckUdpExpect String
    The expected response string for the health check.
    healthCheckUdpRequest String
    A request string to perform a health check.
    healthCheckUnHealthyThreshold Number
    The unhealthy threshold of health check.
    healthCheckUri String
    The uri of health check.
    helthCheckPort Number
    The backend server port for health checks. When full-port listening is enabled, this parameter is returned to indicate the port used for health checks. When full-port listening is not enabled, this parameter is not returned, and the health check uses the service port of the backend server.
    http2Enabled String
    Whether the HTTPS protocol listener enables the front-end HTTP 2.0 protocol.
    id String
    The ID of the Listener.
    keepaliveTimeout Number
    The timeout period for the long connection between the client and the CLB. Only HTTP/HTTPS listeners return this parameter.
    listenerId String
    The ID of the Listener.
    listenerName String
    The name of the Listener.
    loadBalancerId String
    The id of the Clb.
    maxConnections Number
    The maximum number of connections for the Listener.
    persistenceTimeout Number
    The persistence timeout of the Listener.
    persistenceType String
    The persistence type of the Listener.
    port Number
    The port receiving request of the Listener.
    protocol String
    The protocol of the Listener. Values: TCP, UDP, HTTP, HTTPS.
    proxyConnectTimeout Number
    The timeout period for establishing a connection between the CLB and the backend server. Only HTTP/HTTPS listeners return this parameter.
    proxyProtocolType String
    Whether to enable proxy protocol.
    proxyReadTimeout Number
    The timeout period for CLB to read the response from the backend server. Only HTTP/HTTPS listeners return this parameter.
    proxySendTimeout Number
    The timeout period for CLB to transmit requests to backend servers. Only HTTP/HTTPS listeners return this parameter.
    scheduler String
    The scheduling algorithm of the Listener. Values: wrr, wlc, sh.
    securityPolicyId String
    The TLS security policy of the HTTPS listener. Only HTTPS listeners return this parameter.
    sendTimeout Number
    The timeout period for CLB to send responses to the client. Only HTTP/HTTPS listeners return this parameter.
    serverGroupId String
    The ID of the backend server group which is associated with the Listener.
    startPort Number
    The start port of the Listener. This parameter is returned only when full-port listening is enabled.
    status String
    The status of the Listener.
    tags List<Property Map>
    Tags.
    updateTime String
    The update time of the Listener.
    wafProtectionEnabled String
    Whether to enable WAF protection.

    ListenersListenerTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    ListenersTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate