Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
oci.NetworkLoadBalancer.getBackendHealth
Explore with Pulumi AI
This data source provides details about a specific Backend Health resource in Oracle Cloud Infrastructure Network Load Balancer service.
Retrieves the current health status of the specified backend server.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testBackendHealth = oci.NetworkLoadBalancer.getBackendHealth({
backendName: testBackend.name,
backendSetName: testBackendSet.name,
networkLoadBalancerId: testNetworkLoadBalancer.id,
});
import pulumi
import pulumi_oci as oci
test_backend_health = oci.NetworkLoadBalancer.get_backend_health(backend_name=test_backend["name"],
backend_set_name=test_backend_set["name"],
network_load_balancer_id=test_network_load_balancer["id"])
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/NetworkLoadBalancer"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := NetworkLoadBalancer.GetBackendHealth(ctx, &networkloadbalancer.GetBackendHealthArgs{
BackendName: testBackend.Name,
BackendSetName: testBackendSet.Name,
NetworkLoadBalancerId: testNetworkLoadBalancer.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 testBackendHealth = Oci.NetworkLoadBalancer.GetBackendHealth.Invoke(new()
{
BackendName = testBackend.Name,
BackendSetName = testBackendSet.Name,
NetworkLoadBalancerId = testNetworkLoadBalancer.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.NetworkLoadBalancer.NetworkLoadBalancerFunctions;
import com.pulumi.oci.NetworkLoadBalancer.inputs.GetBackendHealthArgs;
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 testBackendHealth = NetworkLoadBalancerFunctions.getBackendHealth(GetBackendHealthArgs.builder()
.backendName(testBackend.name())
.backendSetName(testBackendSet.name())
.networkLoadBalancerId(testNetworkLoadBalancer.id())
.build());
}
}
variables:
testBackendHealth:
fn::invoke:
Function: oci:NetworkLoadBalancer:getBackendHealth
Arguments:
backendName: ${testBackend.name}
backendSetName: ${testBackendSet.name}
networkLoadBalancerId: ${testNetworkLoadBalancer.id}
Using getBackendHealth
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 getBackendHealth(args: GetBackendHealthArgs, opts?: InvokeOptions): Promise<GetBackendHealthResult>
function getBackendHealthOutput(args: GetBackendHealthOutputArgs, opts?: InvokeOptions): Output<GetBackendHealthResult>
def get_backend_health(backend_name: Optional[str] = None,
backend_set_name: Optional[str] = None,
network_load_balancer_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetBackendHealthResult
def get_backend_health_output(backend_name: Optional[pulumi.Input[str]] = None,
backend_set_name: Optional[pulumi.Input[str]] = None,
network_load_balancer_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetBackendHealthResult]
func GetBackendHealth(ctx *Context, args *GetBackendHealthArgs, opts ...InvokeOption) (*GetBackendHealthResult, error)
func GetBackendHealthOutput(ctx *Context, args *GetBackendHealthOutputArgs, opts ...InvokeOption) GetBackendHealthResultOutput
> Note: This function is named GetBackendHealth
in the Go SDK.
public static class GetBackendHealth
{
public static Task<GetBackendHealthResult> InvokeAsync(GetBackendHealthArgs args, InvokeOptions? opts = null)
public static Output<GetBackendHealthResult> Invoke(GetBackendHealthInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBackendHealthResult> getBackendHealth(GetBackendHealthArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:NetworkLoadBalancer/getBackendHealth:getBackendHealth
arguments:
# arguments dictionary
The following arguments are supported:
- Backend
Name string - The name of the backend server to retrieve health status for. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as :. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as :. Example:
10.0.0.3:8080
orocid1.privateip..oc1.<var><unique_ID></var>:8080
- Backend
Set stringName - The name of the backend set associated with the backend server for which to retrieve the health status. Example:
example_backend_set
- Network
Load stringBalancer Id - The OCID of the network load balancer to update.
- Backend
Name string - The name of the backend server to retrieve health status for. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as :. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as :. Example:
10.0.0.3:8080
orocid1.privateip..oc1.<var><unique_ID></var>:8080
- Backend
Set stringName - The name of the backend set associated with the backend server for which to retrieve the health status. Example:
example_backend_set
- Network
Load stringBalancer Id - The OCID of the network load balancer to update.
- backend
Name String - The name of the backend server to retrieve health status for. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as :. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as :. Example:
10.0.0.3:8080
orocid1.privateip..oc1.<var><unique_ID></var>:8080
- backend
Set StringName - The name of the backend set associated with the backend server for which to retrieve the health status. Example:
example_backend_set
- network
Load StringBalancer Id - The OCID of the network load balancer to update.
- backend
Name string - The name of the backend server to retrieve health status for. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as :. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as :. Example:
10.0.0.3:8080
orocid1.privateip..oc1.<var><unique_ID></var>:8080
- backend
Set stringName - The name of the backend set associated with the backend server for which to retrieve the health status. Example:
example_backend_set
- network
Load stringBalancer Id - The OCID of the network load balancer to update.
- backend_
name str - The name of the backend server to retrieve health status for. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as :. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as :. Example:
10.0.0.3:8080
orocid1.privateip..oc1.<var><unique_ID></var>:8080
- backend_
set_ strname - The name of the backend set associated with the backend server for which to retrieve the health status. Example:
example_backend_set
- network_
load_ strbalancer_ id - The OCID of the network load balancer to update.
- backend
Name String - The name of the backend server to retrieve health status for. If the backend was created with an explicitly specified name, that name should be used here. If the backend was created without explicitly specifying the name, but was created using ipAddress, this is specified as :. If the backend was created without explicitly specifying the name, but was created using targetId, this is specified as :. Example:
10.0.0.3:8080
orocid1.privateip..oc1.<var><unique_ID></var>:8080
- backend
Set StringName - The name of the backend set associated with the backend server for which to retrieve the health status. Example:
example_backend_set
- network
Load StringBalancer Id - The OCID of the network load balancer to update.
getBackendHealth Result
The following output properties are available:
- Backend
Name string - Backend
Set stringName - Health
Check List<GetResults Backend Health Health Check Result> - A list of the most recent health check results returned for the specified backend server.
- Id string
- The provider-assigned unique ID for this managed resource.
- Network
Load stringBalancer Id - Status string
- The general health status of the specified backend server.
- OK: All health check probes return
OK
- WARNING: At least one of the health check probes does not return
OK
- CRITICAL: None of the health check probes return
OK
. * - UNKNOWN: One of the health checks probes return
UNKNOWN
, - or the system is unable to retrieve metrics at this time.
- OK: All health check probes return
- Backend
Name string - Backend
Set stringName - Health
Check []GetResults Backend Health Health Check Result - A list of the most recent health check results returned for the specified backend server.
- Id string
- The provider-assigned unique ID for this managed resource.
- Network
Load stringBalancer Id - Status string
- The general health status of the specified backend server.
- OK: All health check probes return
OK
- WARNING: At least one of the health check probes does not return
OK
- CRITICAL: None of the health check probes return
OK
. * - UNKNOWN: One of the health checks probes return
UNKNOWN
, - or the system is unable to retrieve metrics at this time.
- OK: All health check probes return
- backend
Name String - backend
Set StringName - health
Check List<GetResults Backend Health Health Check Result> - A list of the most recent health check results returned for the specified backend server.
- id String
- The provider-assigned unique ID for this managed resource.
- network
Load StringBalancer Id - status String
- The general health status of the specified backend server.
- OK: All health check probes return
OK
- WARNING: At least one of the health check probes does not return
OK
- CRITICAL: None of the health check probes return
OK
. * - UNKNOWN: One of the health checks probes return
UNKNOWN
, - or the system is unable to retrieve metrics at this time.
- OK: All health check probes return
- backend
Name string - backend
Set stringName - health
Check GetResults Backend Health Health Check Result[] - A list of the most recent health check results returned for the specified backend server.
- id string
- The provider-assigned unique ID for this managed resource.
- network
Load stringBalancer Id - status string
- The general health status of the specified backend server.
- OK: All health check probes return
OK
- WARNING: At least one of the health check probes does not return
OK
- CRITICAL: None of the health check probes return
OK
. * - UNKNOWN: One of the health checks probes return
UNKNOWN
, - or the system is unable to retrieve metrics at this time.
- OK: All health check probes return
- backend_
name str - backend_
set_ strname - health_
check_ Sequence[networkloadbalancer.results Get Backend Health Health Check Result] - A list of the most recent health check results returned for the specified backend server.
- id str
- The provider-assigned unique ID for this managed resource.
- network_
load_ strbalancer_ id - status str
- The general health status of the specified backend server.
- OK: All health check probes return
OK
- WARNING: At least one of the health check probes does not return
OK
- CRITICAL: None of the health check probes return
OK
. * - UNKNOWN: One of the health checks probes return
UNKNOWN
, - or the system is unable to retrieve metrics at this time.
- OK: All health check probes return
- backend
Name String - backend
Set StringName - health
Check List<Property Map>Results - A list of the most recent health check results returned for the specified backend server.
- id String
- The provider-assigned unique ID for this managed resource.
- network
Load StringBalancer Id - status String
- The general health status of the specified backend server.
- OK: All health check probes return
OK
- WARNING: At least one of the health check probes does not return
OK
- CRITICAL: None of the health check probes return
OK
. * - UNKNOWN: One of the health checks probes return
UNKNOWN
, - or the system is unable to retrieve metrics at this time.
- OK: All health check probes return
Supporting Types
GetBackendHealthHealthCheckResult
- Health
Check stringStatus - The result of the most recent health check.
- Timestamp string
- The date and time the data was retrieved, in the format defined by RFC3339. Example:
2020-05-01T18:28:11+00:00
- Health
Check stringStatus - The result of the most recent health check.
- Timestamp string
- The date and time the data was retrieved, in the format defined by RFC3339. Example:
2020-05-01T18:28:11+00:00
- health
Check StringStatus - The result of the most recent health check.
- timestamp String
- The date and time the data was retrieved, in the format defined by RFC3339. Example:
2020-05-01T18:28:11+00:00
- health
Check stringStatus - The result of the most recent health check.
- timestamp string
- The date and time the data was retrieved, in the format defined by RFC3339. Example:
2020-05-01T18:28:11+00:00
- health_
check_ strstatus - The result of the most recent health check.
- timestamp str
- The date and time the data was retrieved, in the format defined by RFC3339. Example:
2020-05-01T18:28:11+00:00
- health
Check StringStatus - The result of the most recent health check.
- timestamp String
- The date and time the data was retrieved, in the format defined by RFC3339. Example:
2020-05-01T18:28:11+00:00
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.