Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. LoadBalancer
  5. getHealth
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.LoadBalancer.getHealth

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Load Balancer Health resource in Oracle Cloud Infrastructure Load Balancer service.

    Gets the health status for the specified load balancer.

    Example Usage

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

const testLoadBalancerHealth = oci.LoadBalancer.getHealth({
    loadBalancerId: testLoadBalancer.id,
});

    import pulumi
import pulumi_oci as oci

test_load_balancer_health = oci.LoadBalancer.get_health(load_balancer_id=test_load_balancer["id"])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/loadbalancer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := loadbalancer.GetHealth(ctx, &loadbalancer.GetHealthArgs{
			LoadBalancerId: testLoadBalancer.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testLoadBalancerHealth = Oci.LoadBalancer.GetHealth.Invoke(new()
    {
        LoadBalancerId = testLoadBalancer.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.LoadBalancer.LoadBalancerFunctions;
import com.pulumi.oci.LoadBalancer.inputs.GetHealthArgs;
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 testLoadBalancerHealth = LoadBalancerFunctions.getHealth(GetHealthArgs.builder()
            .loadBalancerId(testLoadBalancer.id())
            .build());

    }
}

    variables:
  testLoadBalancerHealth:
    fn::invoke:
      function: oci:LoadBalancer:getHealth
      arguments:
        loadBalancerId: ${testLoadBalancer.id}

    Using getHealth

    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 getHealth(args: GetHealthArgs, opts?: InvokeOptions): Promise<GetHealthResult>
function getHealthOutput(args: GetHealthOutputArgs, opts?: InvokeOptions): Output<GetHealthResult>
    def get_health(load_balancer_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetHealthResult
def get_health_output(load_balancer_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetHealthResult]
    func GetHealth(ctx *Context, args *GetHealthArgs, opts ...InvokeOption) (*GetHealthResult, error)
func GetHealthOutput(ctx *Context, args *GetHealthOutputArgs, opts ...InvokeOption) GetHealthResultOutput

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

    public static class GetHealth 
{
    public static Task<GetHealthResult> InvokeAsync(GetHealthArgs args, InvokeOptions? opts = null)
    public static Output<GetHealthResult> Invoke(GetHealthInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetHealthResult> getHealth(GetHealthArgs args, InvokeOptions options)
public static Output<GetHealthResult> getHealth(GetHealthArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:LoadBalancer/getHealth:getHealth
  arguments:
    # arguments dictionary

    The following arguments are supported:

    LoadBalancerId string
    The OCID of the load balancer to return health status for.
    LoadBalancerId string
    The OCID of the load balancer to return health status for.
    loadBalancerId String
    The OCID of the load balancer to return health status for.
    loadBalancerId string
    The OCID of the load balancer to return health status for.
    load_balancer_id str
    The OCID of the load balancer to return health status for.
    loadBalancerId String
    The OCID of the load balancer to return health status for.

    getHealth Result

    The following output properties are available:

    CriticalStateBackendSetNames List<string>
    A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancerId string
    Status string
    The overall health status of the load balancer.

    • OK: All backend sets associated with the load balancer return a status of OK.
    • WARNING: At least one of the backend sets associated with the load balancer returns a status of WARNING, no backend sets return a status of CRITICAL, and the load balancer life cycle state is ACTIVE.
    • CRITICAL: One or more of the backend sets associated with the load balancer return a status of CRITICAL.
    • UNKNOWN: If any one of the following conditions is true:
    • The load balancer life cycle state is not ACTIVE.
    • No backend sets are defined for the load balancer.
    • More than half of the backend sets associated with the load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the load balancer life cycle state is ACTIVE.
    • The system could not retrieve metrics for any reason.
    TotalBackendSetCount int
    The total number of backend sets associated with this load balancer. Example: 4
    UnknownStateBackendSetNames List<string>
    A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set2
    WarningStateBackendSetNames List<string>
    A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set3
    CriticalStateBackendSetNames []string
    A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancerId string
    Status string
    The overall health status of the load balancer.

    • OK: All backend sets associated with the load balancer return a status of OK.
    • WARNING: At least one of the backend sets associated with the load balancer returns a status of WARNING, no backend sets return a status of CRITICAL, and the load balancer life cycle state is ACTIVE.
    • CRITICAL: One or more of the backend sets associated with the load balancer return a status of CRITICAL.
    • UNKNOWN: If any one of the following conditions is true:
    • The load balancer life cycle state is not ACTIVE.
    • No backend sets are defined for the load balancer.
    • More than half of the backend sets associated with the load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the load balancer life cycle state is ACTIVE.
    • The system could not retrieve metrics for any reason.
    TotalBackendSetCount int
    The total number of backend sets associated with this load balancer. Example: 4
    UnknownStateBackendSetNames []string
    A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set2
    WarningStateBackendSetNames []string
    A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set3
    criticalStateBackendSetNames List<String>
    A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancerId String
    status String
    The overall health status of the load balancer.

    • OK: All backend sets associated with the load balancer return a status of OK.
    • WARNING: At least one of the backend sets associated with the load balancer returns a status of WARNING, no backend sets return a status of CRITICAL, and the load balancer life cycle state is ACTIVE.
    • CRITICAL: One or more of the backend sets associated with the load balancer return a status of CRITICAL.
    • UNKNOWN: If any one of the following conditions is true:
    • The load balancer life cycle state is not ACTIVE.
    • No backend sets are defined for the load balancer.
    • More than half of the backend sets associated with the load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the load balancer life cycle state is ACTIVE.
    • The system could not retrieve metrics for any reason.
    totalBackendSetCount Integer
    The total number of backend sets associated with this load balancer. Example: 4
    unknownStateBackendSetNames List<String>
    A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set2
    warningStateBackendSetNames List<String>
    A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set3
    criticalStateBackendSetNames string[]
    A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set
    id string
    The provider-assigned unique ID for this managed resource.
    loadBalancerId string
    status string
    The overall health status of the load balancer.

    • OK: All backend sets associated with the load balancer return a status of OK.
    • WARNING: At least one of the backend sets associated with the load balancer returns a status of WARNING, no backend sets return a status of CRITICAL, and the load balancer life cycle state is ACTIVE.
    • CRITICAL: One or more of the backend sets associated with the load balancer return a status of CRITICAL.
    • UNKNOWN: If any one of the following conditions is true:
    • The load balancer life cycle state is not ACTIVE.
    • No backend sets are defined for the load balancer.
    • More than half of the backend sets associated with the load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the load balancer life cycle state is ACTIVE.
    • The system could not retrieve metrics for any reason.
    totalBackendSetCount number
    The total number of backend sets associated with this load balancer. Example: 4
    unknownStateBackendSetNames string[]
    A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set2
    warningStateBackendSetNames string[]
    A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set3
    critical_state_backend_set_names Sequence[str]
    A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set
    id str
    The provider-assigned unique ID for this managed resource.
    load_balancer_id str
    status str
    The overall health status of the load balancer.

    • OK: All backend sets associated with the load balancer return a status of OK.
    • WARNING: At least one of the backend sets associated with the load balancer returns a status of WARNING, no backend sets return a status of CRITICAL, and the load balancer life cycle state is ACTIVE.
    • CRITICAL: One or more of the backend sets associated with the load balancer return a status of CRITICAL.
    • UNKNOWN: If any one of the following conditions is true:
    • The load balancer life cycle state is not ACTIVE.
    • No backend sets are defined for the load balancer.
    • More than half of the backend sets associated with the load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the load balancer life cycle state is ACTIVE.
    • The system could not retrieve metrics for any reason.
    total_backend_set_count int
    The total number of backend sets associated with this load balancer. Example: 4
    unknown_state_backend_set_names Sequence[str]
    A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set2
    warning_state_backend_set_names Sequence[str]
    A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set3
    criticalStateBackendSetNames List<String>
    A list of backend sets that are currently in the CRITICAL health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancerId String
    status String
    The overall health status of the load balancer.

    • OK: All backend sets associated with the load balancer return a status of OK.
    • WARNING: At least one of the backend sets associated with the load balancer returns a status of WARNING, no backend sets return a status of CRITICAL, and the load balancer life cycle state is ACTIVE.
    • CRITICAL: One or more of the backend sets associated with the load balancer return a status of CRITICAL.
    • UNKNOWN: If any one of the following conditions is true:
    • The load balancer life cycle state is not ACTIVE.
    • No backend sets are defined for the load balancer.
    • More than half of the backend sets associated with the load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the load balancer life cycle state is ACTIVE.
    • The system could not retrieve metrics for any reason.
    totalBackendSetCount Number
    The total number of backend sets associated with this load balancer. Example: 4
    unknownStateBackendSetNames List<String>
    A list of backend sets that are currently in the UNKNOWN health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set2
    warningStateBackendSetNames List<String>
    A list of backend sets that are currently in the WARNING health state. The list identifies each backend set by the friendly name you assigned when you created it. Example: example_backend_set3

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci