Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.HealthChecks.getPingProbeResults

This data source provides the list of Ping Probe Results in Oracle Cloud Infrastructure Health Checks service.

Returns the results for the specified probe, where the probeConfigurationId is the OCID of either a monitor or an on-demand probe.

Results are paginated based on page and limit. The opc-next-page header provides a URL for fetching the next page. Use sortOrder to set the order of the results. If sortOrder is unspecified, results are sorted in ascending order by startTime.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testPingProbeResults = Oci.HealthChecks.GetPingProbeResults.Invoke(new()
    {
        ProbeConfigurationId = oci_health_checks_probe_configuration.Test_probe_configuration.Id,
        StartTimeGreaterThanOrEqualTo = @var.Ping_probe_result_start_time_greater_than_or_equal_to,
        StartTimeLessThanOrEqualTo = @var.Ping_probe_result_start_time_less_than_or_equal_to,
        Target = @var.Ping_probe_result_target,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := HealthChecks.GetPingProbeResults(ctx, &healthchecks.GetPingProbeResultsArgs{
			ProbeConfigurationId:          oci_health_checks_probe_configuration.Test_probe_configuration.Id,
			StartTimeGreaterThanOrEqualTo: pulumi.Float64Ref(_var.Ping_probe_result_start_time_greater_than_or_equal_to),
			StartTimeLessThanOrEqualTo:    pulumi.Float64Ref(_var.Ping_probe_result_start_time_less_than_or_equal_to),
			Target:                        pulumi.StringRef(_var.Ping_probe_result_target),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.HealthChecks.HealthChecksFunctions;
import com.pulumi.oci.HealthChecks.inputs.GetPingProbeResultsArgs;
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 testPingProbeResults = HealthChecksFunctions.getPingProbeResults(GetPingProbeResultsArgs.builder()
            .probeConfigurationId(oci_health_checks_probe_configuration.test_probe_configuration().id())
            .startTimeGreaterThanOrEqualTo(var_.ping_probe_result_start_time_greater_than_or_equal_to())
            .startTimeLessThanOrEqualTo(var_.ping_probe_result_start_time_less_than_or_equal_to())
            .target(var_.ping_probe_result_target())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_ping_probe_results = oci.HealthChecks.get_ping_probe_results(probe_configuration_id=oci_health_checks_probe_configuration["test_probe_configuration"]["id"],
    start_time_greater_than_or_equal_to=var["ping_probe_result_start_time_greater_than_or_equal_to"],
    start_time_less_than_or_equal_to=var["ping_probe_result_start_time_less_than_or_equal_to"],
    target=var["ping_probe_result_target"])

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

const testPingProbeResults = oci.HealthChecks.getPingProbeResults({
    probeConfigurationId: oci_health_checks_probe_configuration.test_probe_configuration.id,
    startTimeGreaterThanOrEqualTo: _var.ping_probe_result_start_time_greater_than_or_equal_to,
    startTimeLessThanOrEqualTo: _var.ping_probe_result_start_time_less_than_or_equal_to,
    target: _var.ping_probe_result_target,
});

variables:
  testPingProbeResults:
    fn::invoke:
      Function: oci:HealthChecks:getPingProbeResults
      Arguments:
        probeConfigurationId: ${oci_health_checks_probe_configuration.test_probe_configuration.id}
        startTimeGreaterThanOrEqualTo: ${var.ping_probe_result_start_time_greater_than_or_equal_to}
        startTimeLessThanOrEqualTo: ${var.ping_probe_result_start_time_less_than_or_equal_to}
        target: ${var.ping_probe_result_target}

Using getPingProbeResults

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 getPingProbeResults(args: GetPingProbeResultsArgs, opts?: InvokeOptions): Promise<GetPingProbeResultsResult>
function getPingProbeResultsOutput(args: GetPingProbeResultsOutputArgs, opts?: InvokeOptions): Output<GetPingProbeResultsResult>

def get_ping_probe_results(filters: Optional[Sequence[_healthchecks.GetPingProbeResultsFilter]] = None,
                           probe_configuration_id: Optional[str] = None,
                           start_time_greater_than_or_equal_to: Optional[float] = None,
                           start_time_less_than_or_equal_to: Optional[float] = None,
                           target: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetPingProbeResultsResult
def get_ping_probe_results_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[_healthchecks.GetPingProbeResultsFilterArgs]]]] = None,
                           probe_configuration_id: Optional[pulumi.Input[str]] = None,
                           start_time_greater_than_or_equal_to: Optional[pulumi.Input[float]] = None,
                           start_time_less_than_or_equal_to: Optional[pulumi.Input[float]] = None,
                           target: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetPingProbeResultsResult]

func GetPingProbeResults(ctx *Context, args *GetPingProbeResultsArgs, opts ...InvokeOption) (*GetPingProbeResultsResult, error)
func GetPingProbeResultsOutput(ctx *Context, args *GetPingProbeResultsOutputArgs, opts ...InvokeOption) GetPingProbeResultsResultOutput

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

public static class GetPingProbeResults 
{
    public static Task<GetPingProbeResultsResult> InvokeAsync(GetPingProbeResultsArgs args, InvokeOptions? opts = null)
    public static Output<GetPingProbeResultsResult> Invoke(GetPingProbeResultsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPingProbeResultsResult> getPingProbeResults(GetPingProbeResultsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:HealthChecks/getPingProbeResults:getPingProbeResults
  arguments:
    # arguments dictionary

The following arguments are supported:

ProbeConfigurationId string: The OCID of a monitor or on-demand probe.
Filters List<GetPingProbeResultsFilter>
StartTimeGreaterThanOrEqualTo double: Returns results with a startTime equal to or greater than the specified value.
StartTimeLessThanOrEqualTo double: Returns results with a startTime equal to or less than the specified value.
Target string: Filters results that match the target.

ProbeConfigurationId string: The OCID of a monitor or on-demand probe.
Filters []GetPingProbeResultsFilter
StartTimeGreaterThanOrEqualTo float64: Returns results with a startTime equal to or greater than the specified value.
StartTimeLessThanOrEqualTo float64: Returns results with a startTime equal to or less than the specified value.
Target string: Filters results that match the target.

probeConfigurationId String: The OCID of a monitor or on-demand probe.
filters List<GetPingProbeResultsFilter>
startTimeGreaterThanOrEqualTo Double: Returns results with a startTime equal to or greater than the specified value.
startTimeLessThanOrEqualTo Double: Returns results with a startTime equal to or less than the specified value.
target String: Filters results that match the target.

probeConfigurationId string: The OCID of a monitor or on-demand probe.
filters GetPingProbeResultsFilter[]
startTimeGreaterThanOrEqualTo number: Returns results with a startTime equal to or greater than the specified value.
startTimeLessThanOrEqualTo number: Returns results with a startTime equal to or less than the specified value.
target string: Filters results that match the target.

probe_configuration_id str: The OCID of a monitor or on-demand probe.
filters GetPingProbeResultsFilter]
start_time_greater_than_or_equal_to float: Returns results with a startTime equal to or greater than the specified value.
start_time_less_than_or_equal_to float: Returns results with a startTime equal to or less than the specified value.
target str: Filters results that match the target.

probeConfigurationId String: The OCID of a monitor or on-demand probe.
filters List<Property Map>
startTimeGreaterThanOrEqualTo Number: Returns results with a startTime equal to or greater than the specified value.
startTimeLessThanOrEqualTo Number: Returns results with a startTime equal to or less than the specified value.
target String: Filters results that match the target.

getPingProbeResults Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
PingProbeResults List<GetPingProbeResultsPingProbeResult>: The list of ping_probe_results.
ProbeConfigurationId string: The OCID of the monitor or on-demand probe responsible for creating this result.
Filters List<GetPingProbeResultsFilter>
StartTimeGreaterThanOrEqualTo double
StartTimeLessThanOrEqualTo double
Target string: The target hostname or IP address of the probe.

Id string: The provider-assigned unique ID for this managed resource.
PingProbeResults []GetPingProbeResultsPingProbeResult: The list of ping_probe_results.
ProbeConfigurationId string: The OCID of the monitor or on-demand probe responsible for creating this result.
Filters []GetPingProbeResultsFilter
StartTimeGreaterThanOrEqualTo float64
StartTimeLessThanOrEqualTo float64
Target string: The target hostname or IP address of the probe.

id String: The provider-assigned unique ID for this managed resource.
pingProbeResults List<GetPingProbeResultsPingProbeResult>: The list of ping_probe_results.
probeConfigurationId String: The OCID of the monitor or on-demand probe responsible for creating this result.
filters List<GetPingProbeResultsFilter>
startTimeGreaterThanOrEqualTo Double
startTimeLessThanOrEqualTo Double
target String: The target hostname or IP address of the probe.

id string: The provider-assigned unique ID for this managed resource.
pingProbeResults GetPingProbeResultsPingProbeResult[]: The list of ping_probe_results.
probeConfigurationId string: The OCID of the monitor or on-demand probe responsible for creating this result.
filters GetPingProbeResultsFilter[]
startTimeGreaterThanOrEqualTo number
startTimeLessThanOrEqualTo number
target string: The target hostname or IP address of the probe.

id str: The provider-assigned unique ID for this managed resource.
ping_probe_results GetPingProbeResultsPingProbeResult]: The list of ping_probe_results.
probe_configuration_id str: The OCID of the monitor or on-demand probe responsible for creating this result.
filters GetPingProbeResultsFilter]
start_time_greater_than_or_equal_to float
start_time_less_than_or_equal_to float
target str: The target hostname or IP address of the probe.

id String: The provider-assigned unique ID for this managed resource.
pingProbeResults List<Property Map>: The list of ping_probe_results.
probeConfigurationId String: The OCID of the monitor or on-demand probe responsible for creating this result.
filters List<Property Map>
startTimeGreaterThanOrEqualTo Number
startTimeLessThanOrEqualTo Number
target String: The target hostname or IP address of the probe.

Supporting Types

GetPingProbeResultsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

GetPingProbeResultsPingProbeResult

Connections List<GetPingProbeResultsPingProbeResultConnection>

The network connection results.

Dns List<GetPingProbeResultsPingProbeResultDn>

The DNS resolution results.

DomainLookupEnd double

The time immediately before the vantage point finishes the domain name lookup for the resource.

DomainLookupStart double

The time immediately before the vantage point starts the domain name lookup for the resource.

ErrorCategory string

The category of error if an error occurs executing the probe. The errorMessage field provides a message with the error details.

NONE - No error
DNS - DNS errors
TRANSPORT - Transport-related errors, for example a "TLS certificate expired" error.
NETWORK - Network-related errors, for example a "network unreachable" error.
SYSTEM - Internal system errors.

ErrorMessage string

The error information indicating why a probe execution failed.

IcmpCode int

The ICMP code of the response message. This field is not used when the protocol is set to TCP. For more information on ICMP codes, see Internet Control Message Protocol (ICMP) Parameters.

IsHealthy bool

True if the probe result is determined to be healthy based on probe type-specific criteria. For HTTP probes, a probe result is considered healthy if the HTTP response code is greater than or equal to 200 and less than 300.

IsTimedOut bool

True if the probe did not complete before the configured timeoutInSeconds value.

Key string

A value identifying this specific probe result. The key is only unique within the results of its probe configuration. The key may be reused after 90 days.

LatencyInMs double

The latency of the probe execution, in milliseconds.

ProbeConfigurationId string

The OCID of a monitor or on-demand probe.

Protocol string

The protocols for ping probes.

StartTime double

The date and time the probe was executed, expressed in milliseconds since the POSIX epoch. This field is defined by the PerformanceResourceTiming interface of the W3C Resource Timing specification. For more information, see Resource Timing.

Target string

Filters results that match the target.

VantagePointName string

The name of the vantage point that executed the probe.

Connections []GetPingProbeResultsPingProbeResultConnection

The network connection results.

Dns []GetPingProbeResultsPingProbeResultDn

The DNS resolution results.

DomainLookupEnd float64

The time immediately before the vantage point finishes the domain name lookup for the resource.

DomainLookupStart float64

The time immediately before the vantage point starts the domain name lookup for the resource.

ErrorCategory string

The category of error if an error occurs executing the probe. The errorMessage field provides a message with the error details.

NONE - No error
DNS - DNS errors
TRANSPORT - Transport-related errors, for example a "TLS certificate expired" error.
NETWORK - Network-related errors, for example a "network unreachable" error.
SYSTEM - Internal system errors.

ErrorMessage string

The error information indicating why a probe execution failed.

IcmpCode int

The ICMP code of the response message. This field is not used when the protocol is set to TCP. For more information on ICMP codes, see Internet Control Message Protocol (ICMP) Parameters.

IsHealthy bool

IsTimedOut bool

True if the probe did not complete before the configured timeoutInSeconds value.

Key string

A value identifying this specific probe result. The key is only unique within the results of its probe configuration. The key may be reused after 90 days.

LatencyInMs float64

The latency of the probe execution, in milliseconds.

ProbeConfigurationId string

The OCID of a monitor or on-demand probe.

Protocol string

The protocols for ping probes.

StartTime float64

Target string

Filters results that match the target.

VantagePointName string

The name of the vantage point that executed the probe.

connections List<GetPingProbeResultsPingProbeResultConnection>

The network connection results.

dns List<GetPingProbeResultsPingProbeResultDn>

The DNS resolution results.

domainLookupEnd Double

The time immediately before the vantage point finishes the domain name lookup for the resource.

domainLookupStart Double

The time immediately before the vantage point starts the domain name lookup for the resource.

errorCategory String

The category of error if an error occurs executing the probe. The errorMessage field provides a message with the error details.

NONE - No error
DNS - DNS errors
TRANSPORT - Transport-related errors, for example a "TLS certificate expired" error.
NETWORK - Network-related errors, for example a "network unreachable" error.
SYSTEM - Internal system errors.

errorMessage String

The error information indicating why a probe execution failed.

icmpCode Integer

The ICMP code of the response message. This field is not used when the protocol is set to TCP. For more information on ICMP codes, see Internet Control Message Protocol (ICMP) Parameters.

isHealthy Boolean

isTimedOut Boolean

True if the probe did not complete before the configured timeoutInSeconds value.

key String

A value identifying this specific probe result. The key is only unique within the results of its probe configuration. The key may be reused after 90 days.

latencyInMs Double

The latency of the probe execution, in milliseconds.

probeConfigurationId String

The OCID of a monitor or on-demand probe.

protocol String

The protocols for ping probes.

startTime Double

target String

Filters results that match the target.

vantagePointName String

The name of the vantage point that executed the probe.

connections GetPingProbeResultsPingProbeResultConnection[]

The network connection results.

dns GetPingProbeResultsPingProbeResultDn[]

The DNS resolution results.

domainLookupEnd number

The time immediately before the vantage point finishes the domain name lookup for the resource.

domainLookupStart number

The time immediately before the vantage point starts the domain name lookup for the resource.

errorCategory string

The category of error if an error occurs executing the probe. The errorMessage field provides a message with the error details.

NONE - No error
DNS - DNS errors
TRANSPORT - Transport-related errors, for example a "TLS certificate expired" error.
NETWORK - Network-related errors, for example a "network unreachable" error.
SYSTEM - Internal system errors.

errorMessage string

The error information indicating why a probe execution failed.

icmpCode number

The ICMP code of the response message. This field is not used when the protocol is set to TCP. For more information on ICMP codes, see Internet Control Message Protocol (ICMP) Parameters.

isHealthy boolean

isTimedOut boolean

True if the probe did not complete before the configured timeoutInSeconds value.

key string

A value identifying this specific probe result. The key is only unique within the results of its probe configuration. The key may be reused after 90 days.

latencyInMs number

The latency of the probe execution, in milliseconds.

probeConfigurationId string

The OCID of a monitor or on-demand probe.

protocol string

The protocols for ping probes.

startTime number

target string

Filters results that match the target.

vantagePointName string

The name of the vantage point that executed the probe.

connections GetPingProbeResultsPingProbeResultConnection]

The network connection results.

dns GetPingProbeResultsPingProbeResultDn]

The DNS resolution results.

domain_lookup_end float

The time immediately before the vantage point finishes the domain name lookup for the resource.

domain_lookup_start float

The time immediately before the vantage point starts the domain name lookup for the resource.

error_category str

The category of error if an error occurs executing the probe. The errorMessage field provides a message with the error details.

NONE - No error
DNS - DNS errors
TRANSPORT - Transport-related errors, for example a "TLS certificate expired" error.
NETWORK - Network-related errors, for example a "network unreachable" error.
SYSTEM - Internal system errors.

error_message str

The error information indicating why a probe execution failed.

icmp_code int

The ICMP code of the response message. This field is not used when the protocol is set to TCP. For more information on ICMP codes, see Internet Control Message Protocol (ICMP) Parameters.

is_healthy bool

is_timed_out bool

True if the probe did not complete before the configured timeoutInSeconds value.

key str

A value identifying this specific probe result. The key is only unique within the results of its probe configuration. The key may be reused after 90 days.

latency_in_ms float

The latency of the probe execution, in milliseconds.

probe_configuration_id str

The OCID of a monitor or on-demand probe.

protocol str

The protocols for ping probes.

start_time float

target str

Filters results that match the target.

vantage_point_name str

The name of the vantage point that executed the probe.

connections List<Property Map>

The network connection results.

dns List<Property Map>

The DNS resolution results.

domainLookupEnd Number

The time immediately before the vantage point finishes the domain name lookup for the resource.

domainLookupStart Number

The time immediately before the vantage point starts the domain name lookup for the resource.

errorCategory String

The category of error if an error occurs executing the probe. The errorMessage field provides a message with the error details.

NONE - No error
DNS - DNS errors
TRANSPORT - Transport-related errors, for example a "TLS certificate expired" error.
NETWORK - Network-related errors, for example a "network unreachable" error.
SYSTEM - Internal system errors.

errorMessage String

The error information indicating why a probe execution failed.

icmpCode Number

The ICMP code of the response message. This field is not used when the protocol is set to TCP. For more information on ICMP codes, see Internet Control Message Protocol (ICMP) Parameters.

isHealthy Boolean

isTimedOut Boolean

True if the probe did not complete before the configured timeoutInSeconds value.

key String

A value identifying this specific probe result. The key is only unique within the results of its probe configuration. The key may be reused after 90 days.

latencyInMs Number

The latency of the probe execution, in milliseconds.

probeConfigurationId String

The OCID of a monitor or on-demand probe.

protocol String

The protocols for ping probes.

startTime Number

target String

Filters results that match the target.

vantagePointName String

The name of the vantage point that executed the probe.

GetPingProbeResultsPingProbeResultConnection

Address string: The connection IP address.
Port int: The port.

Address string: The connection IP address.
Port int: The port.

address String: The connection IP address.
port Integer: The port.

address string: The connection IP address.
port number: The port.

address str: The connection IP address.
port int: The port.

address String: The connection IP address.
port Number: The port.

GetPingProbeResultsPingProbeResultDn

Addresses List<string>: The addresses returned by DNS resolution.
DomainLookupDuration double: Total DNS resolution duration, in milliseconds. Calculated using domainLookupEnd minus domainLookupStart.

Addresses []string: The addresses returned by DNS resolution.
DomainLookupDuration float64: Total DNS resolution duration, in milliseconds. Calculated using domainLookupEnd minus domainLookupStart.

addresses List<String>: The addresses returned by DNS resolution.
domainLookupDuration Double: Total DNS resolution duration, in milliseconds. Calculated using domainLookupEnd minus domainLookupStart.

addresses string[]: The addresses returned by DNS resolution.
domainLookupDuration number: Total DNS resolution duration, in milliseconds. Calculated using domainLookupEnd minus domainLookupStart.

addresses Sequence[str]: The addresses returned by DNS resolution.
domain_lookup_duration float: Total DNS resolution duration, in milliseconds. Calculated using domainLookupEnd minus domainLookupStart.

addresses List<String>: The addresses returned by DNS resolution.
domainLookupDuration Number: Total DNS resolution duration, in milliseconds. Calculated using domainLookupEnd minus domainLookupStart.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

oci.HealthChecks.getPingProbeResults

Example Usage

Using getPingProbeResults

getPingProbeResults Result

Supporting Types

GetPingProbeResultsFilter

GetPingProbeResultsPingProbeResult

GetPingProbeResultsPingProbeResultConnection

GetPingProbeResultsPingProbeResultDn

Package Details

Contents