Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PingProbeResultSummary

The results returned by running a ping probe. All times and durations are returned in milliseconds. All times are relative to the POSIX epoch (1970-01-01T00:00Z).

Properties

Optional connection

connection: model.Connection

Optional dns

dns: model.DNS

Optional domainLookupEnd

domainLookupEnd: undefined | number

The time immediately before the vantage point finishes the domain name lookup for the resource. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional domainLookupStart

domainLookupStart: undefined | number

The time immediately before the vantage point starts the domain name lookup for the resource. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional errorCategory

errorCategory: ErrorCategory

The category of error if an error occurs executing the probe. The {@code 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.

Optional errorMessage

errorMessage: undefined | string

The error information indicating why a probe execution failed.

Optional icmpCode

icmpCode: undefined | 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. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional isHealthy

isHealthy: undefined | false | true

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.

Optional isTimedOut

isTimedOut: undefined | false | true

True if the probe did not complete before the configured {@code timeoutInSeconds} value.

Optional key

key: undefined | 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.

Optional latencyInMs

latencyInMs: undefined | number

The latency of the probe execution, in milliseconds. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional probeConfigurationId

probeConfigurationId: undefined | string

The OCID of the monitor or on-demand probe responsible for creating this result.

Optional protocol

protocol: model.PingProbeProtocol

Optional startTime

startTime: undefined | 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. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional target

target: undefined | string

The target hostname or IP address of the probe.

Optional vantagePointName

vantagePointName: undefined | string

The name of the vantage point that executed the probe.

Functions

getDeserializedJsonObj

getJsonObj