oci.HealthChecks.getPingProbeResults
Explore with Pulumi AI
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
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testPingProbeResults = oci.HealthChecks.getPingProbeResults({
    probeConfigurationId: testProbeConfiguration.id,
    startTimeGreaterThanOrEqualTo: pingProbeResultStartTimeGreaterThanOrEqualTo,
    startTimeLessThanOrEqualTo: pingProbeResultStartTimeLessThanOrEqualTo,
    target: pingProbeResultTarget,
});
import pulumi
import pulumi_oci as oci
test_ping_probe_results = oci.HealthChecks.get_ping_probe_results(probe_configuration_id=test_probe_configuration["id"],
    start_time_greater_than_or_equal_to=ping_probe_result_start_time_greater_than_or_equal_to,
    start_time_less_than_or_equal_to=ping_probe_result_start_time_less_than_or_equal_to,
    target=ping_probe_result_target)
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v2/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:          testProbeConfiguration.Id,
			StartTimeGreaterThanOrEqualTo: pulumi.Float64Ref(pingProbeResultStartTimeGreaterThanOrEqualTo),
			StartTimeLessThanOrEqualTo:    pulumi.Float64Ref(pingProbeResultStartTimeLessThanOrEqualTo),
			Target:                        pulumi.StringRef(pingProbeResultTarget),
		}, 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 testPingProbeResults = Oci.HealthChecks.GetPingProbeResults.Invoke(new()
    {
        ProbeConfigurationId = testProbeConfiguration.Id,
        StartTimeGreaterThanOrEqualTo = pingProbeResultStartTimeGreaterThanOrEqualTo,
        StartTimeLessThanOrEqualTo = pingProbeResultStartTimeLessThanOrEqualTo,
        Target = pingProbeResultTarget,
    });
});
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(testProbeConfiguration.id())
            .startTimeGreaterThanOrEqualTo(pingProbeResultStartTimeGreaterThanOrEqualTo)
            .startTimeLessThanOrEqualTo(pingProbeResultStartTimeLessThanOrEqualTo)
            .target(pingProbeResultTarget)
            .build());
    }
}
variables:
  testPingProbeResults:
    fn::invoke:
      function: oci:HealthChecks:getPingProbeResults
      arguments:
        probeConfigurationId: ${testProbeConfiguration.id}
        startTimeGreaterThanOrEqualTo: ${pingProbeResultStartTimeGreaterThanOrEqualTo}
        startTimeLessThanOrEqualTo: ${pingProbeResultStartTimeLessThanOrEqualTo}
        target: ${pingProbeResultTarget}
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[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[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)
public static Output<GetPingProbeResultsResult> getPingProbeResults(GetPingProbeResultsArgs args, InvokeOptions options)
fn::invoke:
  function: oci:HealthChecks/getPingProbeResults:getPingProbeResults
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ProbeConfiguration stringId 
- The OCID of a monitor or on-demand probe.
- Filters
List<GetPing Probe Results Filter> 
- StartTime doubleGreater Than Or Equal To 
- Returns results with a startTimeequal to or greater than the specified value.
- StartTime doubleLess Than Or Equal To 
- Returns results with a startTimeequal to or less than the specified value.
- Target string
- Filters results that match the target.
- ProbeConfiguration stringId 
- The OCID of a monitor or on-demand probe.
- Filters
[]GetPing Probe Results Filter 
- StartTime float64Greater Than Or Equal To 
- Returns results with a startTimeequal to or greater than the specified value.
- StartTime float64Less Than Or Equal To 
- Returns results with a startTimeequal to or less than the specified value.
- Target string
- Filters results that match the target.
- probeConfiguration StringId 
- The OCID of a monitor or on-demand probe.
- filters
List<GetPing Probe Results Filter> 
- startTime DoubleGreater Than Or Equal To 
- Returns results with a startTimeequal to or greater than the specified value.
- startTime DoubleLess Than Or Equal To 
- Returns results with a startTimeequal to or less than the specified value.
- target String
- Filters results that match the target.
- probeConfiguration stringId 
- The OCID of a monitor or on-demand probe.
- filters
GetPing Probe Results Filter[] 
- startTime numberGreater Than Or Equal To 
- Returns results with a startTimeequal to or greater than the specified value.
- startTime numberLess Than Or Equal To 
- Returns results with a startTimeequal to or less than the specified value.
- target string
- Filters results that match the target.
- probe_configuration_ strid 
- The OCID of a monitor or on-demand probe.
- filters
Sequence[GetPing Probe Results Filter] 
- start_time_ floatgreater_ than_ or_ equal_ to 
- Returns results with a startTimeequal to or greater than the specified value.
- start_time_ floatless_ than_ or_ equal_ to 
- Returns results with a startTimeequal to or less than the specified value.
- target str
- Filters results that match the target.
- probeConfiguration StringId 
- The OCID of a monitor or on-demand probe.
- filters List<Property Map>
- startTime NumberGreater Than Or Equal To 
- Returns results with a startTimeequal to or greater than the specified value.
- startTime NumberLess Than Or Equal To 
- Returns results with a startTimeequal 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.
- PingProbe List<GetResults Ping Probe Results Ping Probe Result> 
- The list of ping_probe_results.
- ProbeConfiguration stringId 
- The OCID of the monitor or on-demand probe responsible for creating this result.
- Filters
List<GetPing Probe Results Filter> 
- StartTime doubleGreater Than Or Equal To 
- StartTime doubleLess Than Or Equal To 
- Target string
- The target hostname or IP address of the probe.
- Id string
- The provider-assigned unique ID for this managed resource.
- PingProbe []GetResults Ping Probe Results Ping Probe Result 
- The list of ping_probe_results.
- ProbeConfiguration stringId 
- The OCID of the monitor or on-demand probe responsible for creating this result.
- Filters
[]GetPing Probe Results Filter 
- StartTime float64Greater Than Or Equal To 
- StartTime float64Less Than Or Equal To 
- Target string
- The target hostname or IP address of the probe.
- id String
- The provider-assigned unique ID for this managed resource.
- pingProbe List<GetResults Ping Probe Results Ping Probe Result> 
- The list of ping_probe_results.
- probeConfiguration StringId 
- The OCID of the monitor or on-demand probe responsible for creating this result.
- filters
List<GetPing Probe Results Filter> 
- startTime DoubleGreater Than Or Equal To 
- startTime DoubleLess Than Or Equal To 
- target String
- The target hostname or IP address of the probe.
- id string
- The provider-assigned unique ID for this managed resource.
- pingProbe GetResults Ping Probe Results Ping Probe Result[] 
- The list of ping_probe_results.
- probeConfiguration stringId 
- The OCID of the monitor or on-demand probe responsible for creating this result.
- filters
GetPing Probe Results Filter[] 
- startTime numberGreater Than Or Equal To 
- startTime numberLess Than Or Equal To 
- target string
- The target hostname or IP address of the probe.
- id str
- The provider-assigned unique ID for this managed resource.
- ping_probe_ Sequence[Getresults Ping Probe Results Ping Probe Result] 
- The list of ping_probe_results.
- probe_configuration_ strid 
- The OCID of the monitor or on-demand probe responsible for creating this result.
- filters
Sequence[GetPing Probe Results Filter] 
- start_time_ floatgreater_ than_ or_ equal_ to 
- start_time_ floatless_ than_ or_ equal_ to 
- target str
- The target hostname or IP address of the probe.
- id String
- The provider-assigned unique ID for this managed resource.
- pingProbe List<Property Map>Results 
- The list of ping_probe_results.
- probeConfiguration StringId 
- The OCID of the monitor or on-demand probe responsible for creating this result.
- filters List<Property Map>
- startTime NumberGreater Than Or Equal To 
- startTime NumberLess Than Or Equal To 
- target String
- The target hostname or IP address of the probe.
Supporting Types
GetPingProbeResultsFilter    
GetPingProbeResultsPingProbeResult      
- Connections
List<GetPing Probe Results Ping Probe Result Connection> 
- The network connection results.
- Dns
List<GetPing Probe Results Ping Probe Result Dn> 
- The DNS resolution results.
- DomainLookup doubleEnd 
- The time immediately before the vantage point finishes the domain name lookup for the resource.
- DomainLookup doubleStart 
- 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 errorMessagefield 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.
- IsTimed boolOut 
- True if the probe did not complete before the configured timeoutInSecondsvalue.
- 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.
- LatencyIn doubleMs 
- The latency of the probe execution, in milliseconds.
- ProbeConfiguration stringId 
- 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.
- VantagePoint stringName 
- The name of the vantage point that executed the probe.
- Connections
[]GetPing Probe Results Ping Probe Result Connection 
- The network connection results.
- Dns
[]GetPing Probe Results Ping Probe Result Dn 
- The DNS resolution results.
- DomainLookup float64End 
- The time immediately before the vantage point finishes the domain name lookup for the resource.
- DomainLookup float64Start 
- 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 errorMessagefield 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.
- IsTimed boolOut 
- True if the probe did not complete before the configured timeoutInSecondsvalue.
- 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.
- LatencyIn float64Ms 
- The latency of the probe execution, in milliseconds.
- ProbeConfiguration stringId 
- The OCID of a monitor or on-demand probe.
- Protocol string
- The protocols for ping probes.
- StartTime float64
- 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.
- VantagePoint stringName 
- The name of the vantage point that executed the probe.
- connections
List<GetPing Probe Results Ping Probe Result Connection> 
- The network connection results.
- dns
List<GetPing Probe Results Ping Probe Result Dn> 
- The DNS resolution results.
- domainLookup DoubleEnd 
- The time immediately before the vantage point finishes the domain name lookup for the resource.
- domainLookup DoubleStart 
- 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 errorMessagefield 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
- 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.
- isTimed BooleanOut 
- True if the probe did not complete before the configured timeoutInSecondsvalue.
- 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.
- latencyIn DoubleMs 
- The latency of the probe execution, in milliseconds.
- probeConfiguration StringId 
- 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.
- vantagePoint StringName 
- The name of the vantage point that executed the probe.
- connections
GetPing Probe Results Ping Probe Result Connection[] 
- The network connection results.
- dns
GetPing Probe Results Ping Probe Result Dn[] 
- The DNS resolution results.
- domainLookup numberEnd 
- The time immediately before the vantage point finishes the domain name lookup for the resource.
- domainLookup numberStart 
- 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 errorMessagefield 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
- 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.
- isTimed booleanOut 
- True if the probe did not complete before the configured timeoutInSecondsvalue.
- 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.
- latencyIn numberMs 
- The latency of the probe execution, in milliseconds.
- probeConfiguration stringId 
- The OCID of a monitor or on-demand probe.
- protocol string
- The protocols for ping probes.
- startTime number
- 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.
- vantagePoint stringName 
- The name of the vantage point that executed the probe.
- connections
Sequence[GetPing Probe Results Ping Probe Result Connection] 
- The network connection results.
- dns
Sequence[GetPing Probe Results Ping Probe Result Dn] 
- The DNS resolution results.
- domain_lookup_ floatend 
- The time immediately before the vantage point finishes the domain name lookup for the resource.
- domain_lookup_ floatstart 
- 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 errorMessagefield 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
- 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.
- is_timed_ boolout 
- True if the probe did not complete before the configured timeoutInSecondsvalue.
- 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_ floatms 
- The latency of the probe execution, in milliseconds.
- probe_configuration_ strid 
- The OCID of a monitor or on-demand probe.
- protocol str
- The protocols for ping probes.
- start_time float
- 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 str
- Filters results that match the target.
- vantage_point_ strname 
- 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.
- domainLookup NumberEnd 
- The time immediately before the vantage point finishes the domain name lookup for the resource.
- domainLookup NumberStart 
- 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 errorMessagefield 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
- 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.
- isTimed BooleanOut 
- True if the probe did not complete before the configured timeoutInSecondsvalue.
- 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.
- latencyIn NumberMs 
- The latency of the probe execution, in milliseconds.
- probeConfiguration StringId 
- The OCID of a monitor or on-demand probe.
- protocol String
- The protocols for ping probes.
- startTime Number
- 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.
- vantagePoint StringName 
- The name of the vantage point that executed the probe.
GetPingProbeResultsPingProbeResultConnection       
GetPingProbeResultsPingProbeResultDn       
- Addresses List<string>
- The addresses returned by DNS resolution.
- DomainLookup doubleDuration 
- Total DNS resolution duration, in milliseconds. Calculated using domainLookupEndminusdomainLookupStart.
- Addresses []string
- The addresses returned by DNS resolution.
- DomainLookup float64Duration 
- Total DNS resolution duration, in milliseconds. Calculated using domainLookupEndminusdomainLookupStart.
- addresses List<String>
- The addresses returned by DNS resolution.
- domainLookup DoubleDuration 
- Total DNS resolution duration, in milliseconds. Calculated using domainLookupEndminusdomainLookupStart.
- addresses string[]
- The addresses returned by DNS resolution.
- domainLookup numberDuration 
- Total DNS resolution duration, in milliseconds. Calculated using domainLookupEndminusdomainLookupStart.
- addresses Sequence[str]
- The addresses returned by DNS resolution.
- domain_lookup_ floatduration 
- Total DNS resolution duration, in milliseconds. Calculated using domainLookupEndminusdomainLookupStart.
- addresses List<String>
- The addresses returned by DNS resolution.
- domainLookup NumberDuration 
- Total DNS resolution duration, in milliseconds. Calculated using domainLookupEndminusdomainLookupStart.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.