Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreatePingMonitorDetails

The request body used to create a Ping monitor.

Properties

Functions

Properties

compartmentId

compartmentId: string

The OCID of the compartment.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

displayName

displayName: string

A user-friendly and mutable name suitable for display in a user interface.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {@code {"Department": "Finance"}}

intervalInSeconds

intervalInSeconds: number

The monitor interval in seconds. Valid values: 10, 30, and 60. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional isEnabled

isEnabled: undefined | false | true

Enables or disables the monitor. Set to 'true' to launch monitoring.

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.

protocol

protocol: PingProbeProtocol

targets

targets: Array<string>

A list of targets (hostnames or IP addresses) 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

getJsonObj