1. Packages
  2. Volcengine
  3. API Docs
  4. nlb
  5. getListenerHealths
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.nlb.getListenerHealths

volcengine logo
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Using getListenerHealths

    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 getListenerHealths(args: GetListenerHealthsArgs, opts?: InvokeOptions): Promise<GetListenerHealthsResult>
function getListenerHealthsOutput(args: GetListenerHealthsOutputArgs, opts?: InvokeOptions): Output<GetListenerHealthsResult>
    def get_listener_healths(listener_id: Optional[str] = None,
                         output_file: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetListenerHealthsResult
def get_listener_healths_output(listener_id: Optional[pulumi.Input[str]] = None,
                         output_file: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetListenerHealthsResult]
    func GetListenerHealths(ctx *Context, args *GetListenerHealthsArgs, opts ...InvokeOption) (*GetListenerHealthsResult, error)
func GetListenerHealthsOutput(ctx *Context, args *GetListenerHealthsOutputArgs, opts ...InvokeOption) GetListenerHealthsResultOutput

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

    public static class GetListenerHealths 
{
    public static Task<GetListenerHealthsResult> InvokeAsync(GetListenerHealthsArgs args, InvokeOptions? opts = null)
    public static Output<GetListenerHealthsResult> Invoke(GetListenerHealthsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetListenerHealthsResult> getListenerHealths(GetListenerHealthsArgs args, InvokeOptions options)
public static Output<GetListenerHealthsResult> getListenerHealths(GetListenerHealthsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:nlb/getListenerHealths:getListenerHealths
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ListenerId string
    OutputFile string
    ListenerId string
    OutputFile string
    listenerId String
    outputFile String
    listenerId string
    outputFile string
    listenerId String
    outputFile String

    getListenerHealths Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    ListenerHealths List<GetListenerHealthsListenerHealth>
    ListenerId string
    TotalCount int
    OutputFile string
    Id string
    The provider-assigned unique ID for this managed resource.
    ListenerHealths []GetListenerHealthsListenerHealth
    ListenerId string
    TotalCount int
    OutputFile string
    id String
    The provider-assigned unique ID for this managed resource.
    listenerHealths List<GetListenerHealthsListenerHealth>
    listenerId String
    totalCount Integer
    outputFile String
    id string
    The provider-assigned unique ID for this managed resource.
    listenerHealths GetListenerHealthsListenerHealth[]
    listenerId string
    totalCount number
    outputFile string
    id str
    The provider-assigned unique ID for this managed resource.
    listener_healths Sequence[GetListenerHealthsListenerHealth]
    listener_id str
    total_count int
    output_file str
    id String
    The provider-assigned unique ID for this managed resource.
    listenerHealths List<Property Map>
    listenerId String
    totalCount Number
    outputFile String

    Supporting Types

    GetListenerHealthsListenerHealth

    HealthyCount int
    The number of healthy backend servers.
    ListenerId string
    The ID of the listener.
    Results List<GetListenerHealthsListenerHealthResult>
    The list of backend servers.
    ServerGroupId string
    The ID of the server group.
    Status string
    The status of the server group. Valid values: Active, NoTarget, Error, Disabled. NoTarget: The server group does not have any backend servers added, or the server group has closed cross-zone forwarding and there are no backend servers in the zone where the access traffic originates. Error: There are unhealthy backend servers in the server group. Active: All backend servers in the server group are healthy. Disabled: The server group has closed health checks, or the NLB instance associated with the server group is in a stopped state.
    UnhealthyCount int
    The number of unhealthy backend servers.
    HealthyCount int
    The number of healthy backend servers.
    ListenerId string
    The ID of the listener.
    Results []GetListenerHealthsListenerHealthResult
    The list of backend servers.
    ServerGroupId string
    The ID of the server group.
    Status string
    The status of the server group. Valid values: Active, NoTarget, Error, Disabled. NoTarget: The server group does not have any backend servers added, or the server group has closed cross-zone forwarding and there are no backend servers in the zone where the access traffic originates. Error: There are unhealthy backend servers in the server group. Active: All backend servers in the server group are healthy. Disabled: The server group has closed health checks, or the NLB instance associated with the server group is in a stopped state.
    UnhealthyCount int
    The number of unhealthy backend servers.
    healthyCount Integer
    The number of healthy backend servers.
    listenerId String
    The ID of the listener.
    results List<GetListenerHealthsListenerHealthResult>
    The list of backend servers.
    serverGroupId String
    The ID of the server group.
    status String
    The status of the server group. Valid values: Active, NoTarget, Error, Disabled. NoTarget: The server group does not have any backend servers added, or the server group has closed cross-zone forwarding and there are no backend servers in the zone where the access traffic originates. Error: There are unhealthy backend servers in the server group. Active: All backend servers in the server group are healthy. Disabled: The server group has closed health checks, or the NLB instance associated with the server group is in a stopped state.
    unhealthyCount Integer
    The number of unhealthy backend servers.
    healthyCount number
    The number of healthy backend servers.
    listenerId string
    The ID of the listener.
    results GetListenerHealthsListenerHealthResult[]
    The list of backend servers.
    serverGroupId string
    The ID of the server group.
    status string
    The status of the server group. Valid values: Active, NoTarget, Error, Disabled. NoTarget: The server group does not have any backend servers added, or the server group has closed cross-zone forwarding and there are no backend servers in the zone where the access traffic originates. Error: There are unhealthy backend servers in the server group. Active: All backend servers in the server group are healthy. Disabled: The server group has closed health checks, or the NLB instance associated with the server group is in a stopped state.
    unhealthyCount number
    The number of unhealthy backend servers.
    healthy_count int
    The number of healthy backend servers.
    listener_id str
    The ID of the listener.
    results Sequence[GetListenerHealthsListenerHealthResult]
    The list of backend servers.
    server_group_id str
    The ID of the server group.
    status str
    The status of the server group. Valid values: Active, NoTarget, Error, Disabled. NoTarget: The server group does not have any backend servers added, or the server group has closed cross-zone forwarding and there are no backend servers in the zone where the access traffic originates. Error: There are unhealthy backend servers in the server group. Active: All backend servers in the server group are healthy. Disabled: The server group has closed health checks, or the NLB instance associated with the server group is in a stopped state.
    unhealthy_count int
    The number of unhealthy backend servers.
    healthyCount Number
    The number of healthy backend servers.
    listenerId String
    The ID of the listener.
    results List<Property Map>
    The list of backend servers.
    serverGroupId String
    The ID of the server group.
    status String
    The status of the server group. Valid values: Active, NoTarget, Error, Disabled. NoTarget: The server group does not have any backend servers added, or the server group has closed cross-zone forwarding and there are no backend servers in the zone where the access traffic originates. Error: There are unhealthy backend servers in the server group. Active: All backend servers in the server group are healthy. Disabled: The server group has closed health checks, or the NLB instance associated with the server group is in a stopped state.
    unhealthyCount Number
    The number of unhealthy backend servers.

    GetListenerHealthsListenerHealthResult

    InstanceId string
    The ID or IP address of the backend server.
    Ip string
    The IP address of the backend server.
    Port int
    The port of the backend server.
    ServerId string
    The ID of the backend server.
    ServerType string
    The type of the backend server. Valid values: ecs, eni, ip. ecs: ECS instance (primary network interface). eni: Secondary network interface. ip: IP address.
    Status string
    The health status of the backend server. Valid values: Up, Down, Unused. Up: Normal. Down: Abnormal. Unused: Unused. The NLB instance has closed cross-zone forwarding, and there is no access traffic from the zone of the backend server.
    ZoneId string
    The zone ID that the backend server receives access traffic from.
    InstanceId string
    The ID or IP address of the backend server.
    Ip string
    The IP address of the backend server.
    Port int
    The port of the backend server.
    ServerId string
    The ID of the backend server.
    ServerType string
    The type of the backend server. Valid values: ecs, eni, ip. ecs: ECS instance (primary network interface). eni: Secondary network interface. ip: IP address.
    Status string
    The health status of the backend server. Valid values: Up, Down, Unused. Up: Normal. Down: Abnormal. Unused: Unused. The NLB instance has closed cross-zone forwarding, and there is no access traffic from the zone of the backend server.
    ZoneId string
    The zone ID that the backend server receives access traffic from.
    instanceId String
    The ID or IP address of the backend server.
    ip String
    The IP address of the backend server.
    port Integer
    The port of the backend server.
    serverId String
    The ID of the backend server.
    serverType String
    The type of the backend server. Valid values: ecs, eni, ip. ecs: ECS instance (primary network interface). eni: Secondary network interface. ip: IP address.
    status String
    The health status of the backend server. Valid values: Up, Down, Unused. Up: Normal. Down: Abnormal. Unused: Unused. The NLB instance has closed cross-zone forwarding, and there is no access traffic from the zone of the backend server.
    zoneId String
    The zone ID that the backend server receives access traffic from.
    instanceId string
    The ID or IP address of the backend server.
    ip string
    The IP address of the backend server.
    port number
    The port of the backend server.
    serverId string
    The ID of the backend server.
    serverType string
    The type of the backend server. Valid values: ecs, eni, ip. ecs: ECS instance (primary network interface). eni: Secondary network interface. ip: IP address.
    status string
    The health status of the backend server. Valid values: Up, Down, Unused. Up: Normal. Down: Abnormal. Unused: Unused. The NLB instance has closed cross-zone forwarding, and there is no access traffic from the zone of the backend server.
    zoneId string
    The zone ID that the backend server receives access traffic from.
    instance_id str
    The ID or IP address of the backend server.
    ip str
    The IP address of the backend server.
    port int
    The port of the backend server.
    server_id str
    The ID of the backend server.
    server_type str
    The type of the backend server. Valid values: ecs, eni, ip. ecs: ECS instance (primary network interface). eni: Secondary network interface. ip: IP address.
    status str
    The health status of the backend server. Valid values: Up, Down, Unused. Up: Normal. Down: Abnormal. Unused: Unused. The NLB instance has closed cross-zone forwarding, and there is no access traffic from the zone of the backend server.
    zone_id str
    The zone ID that the backend server receives access traffic from.
    instanceId String
    The ID or IP address of the backend server.
    ip String
    The IP address of the backend server.
    port Number
    The port of the backend server.
    serverId String
    The ID of the backend server.
    serverType String
    The type of the backend server. Valid values: ecs, eni, ip. ecs: ECS instance (primary network interface). eni: Secondary network interface. ip: IP address.
    status String
    The health status of the backend server. Valid values: Up, Down, Unused. Up: Normal. Down: Abnormal. Unused: Unused. The NLB instance has closed cross-zone forwarding, and there is no access traffic from the zone of the backend server.
    zoneId String
    The zone ID that the backend server receives access traffic from.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Viewing docs for Volcengine v0.0.47
    published on Friday, Mar 13, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Try Pulumi Cloud free. Your team will thank you.