1. Packages
  2. Volcengine
  3. API Docs
  4. clb
  5. ListenerHealths
Volcengine v0.0.44 published on Sunday, Feb 1, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.clb.ListenerHealths

volcengine logo
Volcengine v0.0.44 published on Sunday, Feb 1, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine
    Deprecated: volcengine.clb.ListenerHealths has been deprecated in favor of volcengine.clb.getListenerHealths

    Use this data source to query detailed information of listener healths

    Example Usage

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

const foo = volcengine.clb.getListenerHealths({
    listenerId: "lsn-mjkyvug6pwxs5smt1b9*****",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.clb.get_listener_healths(listener_id="lsn-mjkyvug6pwxs5smt1b9*****")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := clb.GetListenerHealths(ctx, &clb.GetListenerHealthsArgs{
			ListenerId: "lsn-mjkyvug6pwxs5smt1b9*****",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Clb.GetListenerHealths.Invoke(new()
    {
        ListenerId = "lsn-mjkyvug6pwxs5smt1b9*****",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.clb.ClbFunctions;
import com.pulumi.volcengine.clb.inputs.GetListenerHealthsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var foo = ClbFunctions.getListenerHealths(GetListenerHealthsArgs.builder()
            .listenerId("lsn-mjkyvug6pwxs5smt1b9*****")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:clb:getListenerHealths
      Arguments:
        listenerId: lsn-mjkyvug6pwxs5smt1b9*****

    Using ListenerHealths

    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 listenerHealths(args: ListenerHealthsArgs, opts?: InvokeOptions): Promise<ListenerHealthsResult>
function listenerHealthsOutput(args: ListenerHealthsOutputArgs, opts?: InvokeOptions): Output<ListenerHealthsResult>
    def listener_healths(listener_id: Optional[str] = None,
                     only_un_healthy: Optional[bool] = None,
                     output_file: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> ListenerHealthsResult
def listener_healths_output(listener_id: Optional[pulumi.Input[str]] = None,
                     only_un_healthy: Optional[pulumi.Input[bool]] = None,
                     output_file: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[ListenerHealthsResult]
    func ListenerHealths(ctx *Context, args *ListenerHealthsArgs, opts ...InvokeOption) (*ListenerHealthsResult, error)
func ListenerHealthsOutput(ctx *Context, args *ListenerHealthsOutputArgs, opts ...InvokeOption) ListenerHealthsResultOutput
    public static class ListenerHealths 
{
    public static Task<ListenerHealthsResult> InvokeAsync(ListenerHealthsArgs args, InvokeOptions? opts = null)
    public static Output<ListenerHealthsResult> Invoke(ListenerHealthsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<ListenerHealthsResult> listenerHealths(ListenerHealthsArgs args, InvokeOptions options)
public static Output<ListenerHealthsResult> listenerHealths(ListenerHealthsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ListenerId string
    The ID of the listener.
    OnlyUnHealthy bool
    Whether to return only unhealthy backend servers. Valid values: true, false.
    OutputFile string
    File name where to save data source results.
    ListenerId string
    The ID of the listener.
    OnlyUnHealthy bool
    Whether to return only unhealthy backend servers. Valid values: true, false.
    OutputFile string
    File name where to save data source results.
    listenerId String
    The ID of the listener.
    onlyUnHealthy Boolean
    Whether to return only unhealthy backend servers. Valid values: true, false.
    outputFile String
    File name where to save data source results.
    listenerId string
    The ID of the listener.
    onlyUnHealthy boolean
    Whether to return only unhealthy backend servers. Valid values: true, false.
    outputFile string
    File name where to save data source results.
    listener_id str
    The ID of the listener.
    only_un_healthy bool
    Whether to return only unhealthy backend servers. Valid values: true, false.
    output_file str
    File name where to save data source results.
    listenerId String
    The ID of the listener.
    onlyUnHealthy Boolean
    Whether to return only unhealthy backend servers. Valid values: true, false.
    outputFile String
    File name where to save data source results.

    ListenerHealths Result

    The following output properties are available:

    HealthInfos List<ListenerHealthsHealthInfo>
    The health info of backend servers.
    Id string
    The provider-assigned unique ID for this managed resource.
    ListenerId string
    TotalCount int
    The total count of backend servers.
    OnlyUnHealthy bool
    OutputFile string
    HealthInfos []ListenerHealthsHealthInfo
    The health info of backend servers.
    Id string
    The provider-assigned unique ID for this managed resource.
    ListenerId string
    TotalCount int
    The total count of backend servers.
    OnlyUnHealthy bool
    OutputFile string
    healthInfos List<ListenerHealthsHealthInfo>
    The health info of backend servers.
    id String
    The provider-assigned unique ID for this managed resource.
    listenerId String
    totalCount Integer
    The total count of backend servers.
    onlyUnHealthy Boolean
    outputFile String
    healthInfos ListenerHealthsHealthInfo[]
    The health info of backend servers.
    id string
    The provider-assigned unique ID for this managed resource.
    listenerId string
    totalCount number
    The total count of backend servers.
    onlyUnHealthy boolean
    outputFile string
    health_infos Sequence[ListenerHealthsHealthInfo]
    The health info of backend servers.
    id str
    The provider-assigned unique ID for this managed resource.
    listener_id str
    total_count int
    The total count of backend servers.
    only_un_healthy bool
    output_file str
    healthInfos List<Property Map>
    The health info of backend servers.
    id String
    The provider-assigned unique ID for this managed resource.
    listenerId String
    totalCount Number
    The total count of backend servers.
    onlyUnHealthy Boolean
    outputFile String

    Supporting Types

    ListenerHealthsHealthInfo

    ListenerStatus string
    The health check status of the listener. Valid values: Active, Error, Disabled, NoTarget.
    Results List<ListenerHealthsHealthInfoResult>
    The backend server health status results.
    UnHealthyCount int
    The count of unhealthy backend servers.
    ListenerStatus string
    The health check status of the listener. Valid values: Active, Error, Disabled, NoTarget.
    Results []ListenerHealthsHealthInfoResult
    The backend server health status results.
    UnHealthyCount int
    The count of unhealthy backend servers.
    listenerStatus String
    The health check status of the listener. Valid values: Active, Error, Disabled, NoTarget.
    results List<ListenerHealthsHealthInfoResult>
    The backend server health status results.
    unHealthyCount Integer
    The count of unhealthy backend servers.
    listenerStatus string
    The health check status of the listener. Valid values: Active, Error, Disabled, NoTarget.
    results ListenerHealthsHealthInfoResult[]
    The backend server health status results.
    unHealthyCount number
    The count of unhealthy backend servers.
    listener_status str
    The health check status of the listener. Valid values: Active, Error, Disabled, NoTarget.
    results Sequence[ListenerHealthsHealthInfoResult]
    The backend server health status results.
    un_healthy_count int
    The count of unhealthy backend servers.
    listenerStatus String
    The health check status of the listener. Valid values: Active, Error, Disabled, NoTarget.
    results List<Property Map>
    The backend server health status results.
    unHealthyCount Number
    The count of unhealthy backend servers.

    ListenerHealthsHealthInfoResult

    InstanceId string
    The ECS instance or ENI ID.
    Ip string
    The IP address of the backend server.
    Port int
    The port of the backend server.
    RuleNumber int
    The number of forwarding rules associated with the backend server. TCP/UDP listeners return 0.
    ServerGroupId string
    The server group ID that the backend server belongs to.
    ServerId string
    The backend server ID.
    ServerType string
    The backend server type. Valid values: ecs, eni.
    Status string
    The health status of the backend server. Valid values: Up, Down.
    UpdatedAt string
    The last update time of the backend server.
    InstanceId string
    The ECS instance or ENI ID.
    Ip string
    The IP address of the backend server.
    Port int
    The port of the backend server.
    RuleNumber int
    The number of forwarding rules associated with the backend server. TCP/UDP listeners return 0.
    ServerGroupId string
    The server group ID that the backend server belongs to.
    ServerId string
    The backend server ID.
    ServerType string
    The backend server type. Valid values: ecs, eni.
    Status string
    The health status of the backend server. Valid values: Up, Down.
    UpdatedAt string
    The last update time of the backend server.
    instanceId String
    The ECS instance or ENI ID.
    ip String
    The IP address of the backend server.
    port Integer
    The port of the backend server.
    ruleNumber Integer
    The number of forwarding rules associated with the backend server. TCP/UDP listeners return 0.
    serverGroupId String
    The server group ID that the backend server belongs to.
    serverId String
    The backend server ID.
    serverType String
    The backend server type. Valid values: ecs, eni.
    status String
    The health status of the backend server. Valid values: Up, Down.
    updatedAt String
    The last update time of the backend server.
    instanceId string
    The ECS instance or ENI ID.
    ip string
    The IP address of the backend server.
    port number
    The port of the backend server.
    ruleNumber number
    The number of forwarding rules associated with the backend server. TCP/UDP listeners return 0.
    serverGroupId string
    The server group ID that the backend server belongs to.
    serverId string
    The backend server ID.
    serverType string
    The backend server type. Valid values: ecs, eni.
    status string
    The health status of the backend server. Valid values: Up, Down.
    updatedAt string
    The last update time of the backend server.
    instance_id str
    The ECS instance or ENI ID.
    ip str
    The IP address of the backend server.
    port int
    The port of the backend server.
    rule_number int
    The number of forwarding rules associated with the backend server. TCP/UDP listeners return 0.
    server_group_id str
    The server group ID that the backend server belongs to.
    server_id str
    The backend server ID.
    server_type str
    The backend server type. Valid values: ecs, eni.
    status str
    The health status of the backend server. Valid values: Up, Down.
    updated_at str
    The last update time of the backend server.
    instanceId String
    The ECS instance or ENI ID.
    ip String
    The IP address of the backend server.
    port Number
    The port of the backend server.
    ruleNumber Number
    The number of forwarding rules associated with the backend server. TCP/UDP listeners return 0.
    serverGroupId String
    The server group ID that the backend server belongs to.
    serverId String
    The backend server ID.
    serverType String
    The backend server type. Valid values: ecs, eni.
    status String
    The health status of the backend server. Valid values: Up, Down.
    updatedAt String
    The last update time of the backend server.

    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.44 published on Sunday, Feb 1, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate