healthchecks.oracle.com/v1beta1
Back to API Reference
APIVersion: healthchecks.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages
No customer-visible package currently exposes healthchecks.oracle.com/v1beta1.
Resources
HttpMonitor
Manage OCI Health Checks HTTP monitors.
Plural: httpmonitorsScope: NamespacedAPIVersion: healthchecks.oracle.com/v1beta1Sample: Sample (config/samples/healthchecks_v1beta1_httpmonitor.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
HttpMonitorSpec defines the desired state of HttpMonitor.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID of the compartment. |
string |
Yes |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
A user-friendly and mutable name suitable for display in a user interface. |
string |
Yes |
- |
- |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
headers |
A dictionary of HTTP request headers. Note: Monitors and probes do not support the use of the Authorization HTTP header. |
map[string, string] |
No |
- |
- |
intervalInSeconds |
The monitor interval in seconds. Valid values: 10, 30, and 60. |
integer |
Yes |
- |
- |
isEnabled |
Enables or disables the monitor. Set to 'true' to launch monitoring. |
boolean |
No |
- |
- |
method |
- |
string |
No |
- |
- |
path |
The optional URL path to probe, including query parameters. |
string |
No |
- |
- |
port |
The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. |
integer |
No |
- |
- |
protocol |
- |
string |
Yes |
- |
- |
targets |
A list of targets (hostnames or IP addresses) of the probe. |
list[string] |
Yes |
- |
- |
timeoutInSeconds |
The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors. |
integer |
No |
- |
- |
vantagePointNames |
A list of names of vantage points from which to execute the probe. |
list[string] |
No |
- |
- |
Status
HttpMonitorStatus defines the observed state of HttpMonitor.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID of the compartment. |
string |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
A user-friendly and mutable name suitable for display in a user interface. |
string |
No |
- |
- |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
headers |
A dictionary of HTTP request headers. Note: Monitors and probes do not support the use of the Authorization HTTP header. |
map[string, string] |
No |
- |
- |
homeRegion |
The region where updates must be made and where results must be fetched from. |
string |
No |
- |
- |
id |
The OCID of the resource. |
string |
No |
- |
- |
intervalInSeconds |
The monitor interval in seconds. Valid values: 10, 30, and 60. |
integer |
No |
- |
- |
isEnabled |
Enables or disables the monitor. Set to 'true' to launch monitoring. |
boolean |
No |
- |
- |
method |
- |
string |
No |
- |
- |
path |
The optional URL path to probe, including query parameters. |
string |
No |
- |
- |
port |
The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. |
integer |
No |
- |
- |
protocol |
- |
string |
No |
- |
- |
resultsUrl |
A URL for fetching the probe results. |
string |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
targets |
A list of targets (hostnames or IP addresses) of the probe. |
list[string] |
No |
- |
- |
timeCreated |
The RFC 3339-formatted creation date and time of the probe. |
string |
No |
- |
- |
timeoutInSeconds |
The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors. |
integer |
No |
- |
- |
vantagePointNames |
A list of names of vantage points from which to execute the probe. |
list[string] |
No |
- |
- |
Status.status
Back to HttpMonitor status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to HttpMonitor status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to HttpMonitor status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to HttpMonitor status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |
PingMonitor
Manage OCI Health Checks ping monitors.
Plural: pingmonitorsScope: NamespacedAPIVersion: healthchecks.oracle.com/v1beta1Sample: Sample (config/samples/healthchecks_v1beta1_pingmonitor.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
PingMonitorSpec defines the desired state of PingMonitor.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID of the compartment. |
string |
Yes |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
A user-friendly and mutable name suitable for display in a user interface. |
string |
Yes |
- |
- |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
intervalInSeconds |
The monitor interval in seconds. Valid values: 10, 30, and 60. |
integer |
Yes |
- |
- |
isEnabled |
Enables or disables the monitor. Set to 'true' to launch monitoring. |
boolean |
No |
- |
- |
port |
The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. |
integer |
No |
- |
- |
protocol |
- |
string |
Yes |
- |
- |
targets |
A list of targets (hostnames or IP addresses) of the probe. |
list[string] |
Yes |
- |
- |
timeoutInSeconds |
The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors. |
integer |
No |
- |
- |
vantagePointNames |
A list of names of vantage points from which to execute the probe. |
list[string] |
No |
- |
- |
Status
PingMonitorStatus defines the observed state of PingMonitor.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID of the compartment. |
string |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
A user-friendly and mutable name suitable for display in a user interface. |
string |
No |
- |
- |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
homeRegion |
The region where updates must be made and where results must be fetched from. |
string |
No |
- |
- |
id |
The OCID of the resource. |
string |
No |
- |
- |
intervalInSeconds |
The monitor interval in seconds. Valid values: 10, 30, and 60. |
integer |
No |
- |
- |
isEnabled |
Enables or disables the monitor. Set to 'true' to launch monitoring. |
boolean |
No |
- |
- |
port |
The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. |
integer |
No |
- |
- |
protocol |
- |
string |
No |
- |
- |
resultsUrl |
A URL for fetching the probe results. |
string |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
targets |
A list of targets (hostnames or IP addresses) of the probe. |
list[string] |
No |
- |
- |
timeCreated |
The RFC 3339-formatted creation date and time of the probe. |
string |
No |
- |
- |
timeoutInSeconds |
The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors. |
integer |
No |
- |
- |
vantagePointNames |
A list of names of vantage points from which to execute the probe. |
list[string] |
No |
- |
- |
Status.status
Back to PingMonitor status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to PingMonitor status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to PingMonitor status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to PingMonitor status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |