Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace HttpProbe

A summary that contains all of the mutable and immutable properties for an HTTP probe.

Properties

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment.

Optional headers

headers: undefined | object

A dictionary of HTTP request headers.

Note:* Monitors and probes do not support the use of the {@code Authorization} HTTP header.

Optional homeRegion

homeRegion: undefined | string

The region where updates must be made and where results must be fetched from.

Optional id

id: undefined | string

The OCID of the resource.

Optional method

method: model.HttpProbeMethod

Optional path

path: undefined | string

The optional URL path to probe, including query parameters.

Optional port

port: undefined | number

The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional protocol

protocol: model.HttpProbeProtocol

Optional resultsUrl

resultsUrl: undefined | string

A URL for fetching the probe results.

Optional targets

targets: Array<string>

A list of targets (hostnames or IP addresses) of the probe.

Optional timeCreated

timeCreated: Date

The RFC 3339-formatted creation date and time of the probe.

Optional timeoutInSeconds

timeoutInSeconds: undefined | number

The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to {@code intervalInSeconds} for monitors. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional vantagePointNames

vantagePointNames: Array<string>

A list of names of vantage points from which to execute the probe.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: HttpProbe): object

getJsonObj