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[_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:
- Probe
Configuration stringId - The OCID of a monitor or on-demand probe.
- Filters
List<Get
Ping Probe Results Filter> - Start
Time doubleGreater Than Or Equal To - Returns results with a
startTime
equal to or greater than the specified value. - Start
Time doubleLess Than Or Equal To - Returns results with a
startTime
equal to or less than the specified value. - Target string
- Filters results that match the
target
.
- Probe
Configuration stringId - The OCID of a monitor or on-demand probe.
- Filters
[]Get
Ping Probe Results Filter - Start
Time float64Greater Than Or Equal To - Returns results with a
startTime
equal to or greater than the specified value. - Start
Time float64Less Than Or Equal To - Returns results with a
startTime
equal to or less than the specified value. - Target string
- Filters results that match the
target
.
- probe
Configuration StringId - The OCID of a monitor or on-demand probe.
- filters
List<Get
Ping Probe Results Filter> - start
Time DoubleGreater Than Or Equal To - Returns results with a
startTime
equal to or greater than the specified value. - start
Time DoubleLess Than Or Equal To - Returns results with a
startTime
equal to or less than the specified value. - target String
- Filters results that match the
target
.
- probe
Configuration stringId - The OCID of a monitor or on-demand probe.
- filters
Get
Ping Probe Results Filter[] - start
Time numberGreater Than Or Equal To - Returns results with a
startTime
equal to or greater than the specified value. - start
Time numberLess Than Or Equal To - Returns results with a
startTime
equal 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[healthchecks.
Get Ping Probe Results Filter] - start_
time_ floatgreater_ than_ or_ equal_ to - Returns results with a
startTime
equal to or greater than the specified value. - start_
time_ floatless_ than_ or_ equal_ to - Returns results with a
startTime
equal to or less than the specified value. - target str
- Filters results that match the
target
.
- probe
Configuration StringId - The OCID of a monitor or on-demand probe.
- filters List<Property Map>
- start
Time NumberGreater Than Or Equal To - Returns results with a
startTime
equal to or greater than the specified value. - start
Time NumberLess Than Or Equal To - 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.
- Ping
Probe List<GetResults Ping Probe Results Ping Probe Result> - The list of ping_probe_results.
- Probe
Configuration stringId - The OCID of the monitor or on-demand probe responsible for creating this result.
- Filters
List<Get
Ping Probe Results Filter> - Start
Time doubleGreater Than Or Equal To - Start
Time 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.
- Ping
Probe []GetResults Ping Probe Results Ping Probe Result - The list of ping_probe_results.
- Probe
Configuration stringId - The OCID of the monitor or on-demand probe responsible for creating this result.
- Filters
[]Get
Ping Probe Results Filter - Start
Time float64Greater Than Or Equal To - Start
Time 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.
- ping
Probe List<GetResults Ping Probe Results Ping Probe Result> - The list of ping_probe_results.
- probe
Configuration StringId - The OCID of the monitor or on-demand probe responsible for creating this result.
- filters
List<Get
Ping Probe Results Filter> - start
Time DoubleGreater Than Or Equal To - start
Time 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.
- ping
Probe GetResults Ping Probe Results Ping Probe Result[] - The list of ping_probe_results.
- probe
Configuration stringId - The OCID of the monitor or on-demand probe responsible for creating this result.
- filters
Get
Ping Probe Results Filter[] - start
Time numberGreater Than Or Equal To - start
Time 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[healthchecks.results Get 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[healthchecks.
Get Ping 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.
- ping
Probe List<Property Map>Results - The list of ping_probe_results.
- probe
Configuration StringId - The OCID of the monitor or on-demand probe responsible for creating this result.
- filters List<Property Map>
- start
Time NumberGreater Than Or Equal To - start
Time NumberLess Than Or Equal To - target String
- The target hostname or IP address of the probe.
Supporting Types
GetPingProbeResultsFilter
GetPingProbeResultsPingProbeResult
- Connections
List<Get
Ping Probe Results Ping Probe Result Connection> - The network connection results.
- Dns
List<Get
Ping Probe Results Ping Probe Result Dn> - The DNS resolution results.
- Domain
Lookup doubleEnd - The time immediately before the vantage point finishes the domain name lookup for the resource.
- Domain
Lookup doubleStart - The time immediately before the vantage point starts the domain name lookup for the resource.
- Error
Category 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.
- Error
Message string - 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
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.
- Latency
In doubleMs - The latency of the probe execution, in milliseconds.
- Probe
Configuration stringId - The OCID of a monitor or on-demand probe.
- Protocol string
- The protocols for ping probes.
- Start
Time 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
. - Vantage
Point stringName - The name of the vantage point that executed the probe.
- Connections
[]Get
Ping Probe Results Ping Probe Result Connection - The network connection results.
- Dns
[]Get
Ping Probe Results Ping Probe Result Dn - The DNS resolution results.
- Domain
Lookup float64End - The time immediately before the vantage point finishes the domain name lookup for the resource.
- Domain
Lookup float64Start - The time immediately before the vantage point starts the domain name lookup for the resource.
- Error
Category 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.
- Error
Message string - 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
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.
- Latency
In float64Ms - The latency of the probe execution, in milliseconds.
- Probe
Configuration stringId - The OCID of a monitor or on-demand probe.
- Protocol string
- The protocols for ping probes.
- Start
Time 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
. - Vantage
Point stringName - The name of the vantage point that executed the probe.
- connections
List<Get
Ping Probe Results Ping Probe Result Connection> - The network connection results.
- dns
List<Get
Ping Probe Results Ping Probe Result Dn> - The DNS resolution results.
- domain
Lookup DoubleEnd - The time immediately before the vantage point finishes the domain name lookup for the resource.
- domain
Lookup DoubleStart - The time immediately before the vantage point starts the domain name lookup for the resource.
- error
Category 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.
- error
Message String - The error information indicating why a probe execution failed.
- icmp
Code 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.
- is
Healthy 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.
- is
Timed BooleanOut - 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.
- latency
In DoubleMs - The latency of the probe execution, in milliseconds.
- probe
Configuration StringId - The OCID of a monitor or on-demand probe.
- protocol String
- The protocols for ping probes.
- start
Time 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
. - vantage
Point StringName - The name of the vantage point that executed the probe.
- connections
Get
Ping Probe Results Ping Probe Result Connection[] - The network connection results.
- dns
Get
Ping Probe Results Ping Probe Result Dn[] - The DNS resolution results.
- domain
Lookup numberEnd - The time immediately before the vantage point finishes the domain name lookup for the resource.
- domain
Lookup numberStart - The time immediately before the vantage point starts the domain name lookup for the resource.
- error
Category 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.
- error
Message string - The error information indicating why a probe execution failed.
- icmp
Code 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.
- is
Healthy 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.
- is
Timed booleanOut - 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.
- latency
In numberMs - The latency of the probe execution, in milliseconds.
- probe
Configuration stringId - The OCID of a monitor or on-demand probe.
- protocol string
- The protocols for ping probes.
- start
Time 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
. - vantage
Point stringName - The name of the vantage point that executed the probe.
- connections
Sequence[healthchecks.
Get Ping Probe Results Ping Probe Result Connection] - The network connection results.
- dns
Sequence[healthchecks.
Get Ping 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
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 - 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
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_ 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.
- domain
Lookup NumberEnd - The time immediately before the vantage point finishes the domain name lookup for the resource.
- domain
Lookup NumberStart - The time immediately before the vantage point starts the domain name lookup for the resource.
- error
Category 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.
- error
Message String - The error information indicating why a probe execution failed.
- icmp
Code 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.
- is
Healthy 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.
- is
Timed BooleanOut - 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.
- latency
In NumberMs - The latency of the probe execution, in milliseconds.
- probe
Configuration StringId - The OCID of a monitor or on-demand probe.
- protocol String
- The protocols for ping probes.
- start
Time 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
. - vantage
Point StringName - The name of the vantage point that executed the probe.
GetPingProbeResultsPingProbeResultConnection
GetPingProbeResultsPingProbeResultDn
- Addresses List<string>
- The addresses returned by DNS resolution.
- Domain
Lookup doubleDuration - Total DNS resolution duration, in milliseconds. Calculated using
domainLookupEnd
minusdomainLookupStart
.
- Addresses []string
- The addresses returned by DNS resolution.
- Domain
Lookup float64Duration - Total DNS resolution duration, in milliseconds. Calculated using
domainLookupEnd
minusdomainLookupStart
.
- addresses List<String>
- The addresses returned by DNS resolution.
- domain
Lookup DoubleDuration - Total DNS resolution duration, in milliseconds. Calculated using
domainLookupEnd
minusdomainLookupStart
.
- addresses string[]
- The addresses returned by DNS resolution.
- domain
Lookup numberDuration - Total DNS resolution duration, in milliseconds. Calculated using
domainLookupEnd
minusdomainLookupStart
.
- addresses Sequence[str]
- The addresses returned by DNS resolution.
- domain_
lookup_ floatduration - Total DNS resolution duration, in milliseconds. Calculated using
domainLookupEnd
minusdomainLookupStart
.
- addresses List<String>
- The addresses returned by DNS resolution.
- domain
Lookup NumberDuration - Total DNS resolution duration, in milliseconds. Calculated using
domainLookupEnd
minusdomainLookupStart
.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.