Health Checks Functions

Package: DBMS_CLOUD_OCI_HC_HEALTH_CHECKS

CHANGE_HTTP_MONITOR_COMPARTMENT Function

Moves a monitor into a different compartment. When provided, `If-Match` is checked against ETag values of the resource.

Syntax

FUNCTION change_http_monitor_compartment (
  monitor_id varchar2,
  change_http_monitor_compartment_details dbms_cloud_oci_healthchecks_change_http_monitor_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_change_http_monitor_compartment_response_t;

Parameters

Parameter	Description
`monitor_id`	(required) The OCID of a monitor.
`change_http_monitor_compartment_details`	(required) The details needed to move the monitor.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_PING_MONITOR_COMPARTMENT Function

Moves a monitor into a different compartment. When provided, `If-Match` is checked against ETag values of the resource.

Syntax

FUNCTION change_ping_monitor_compartment (
  monitor_id varchar2,
  change_ping_monitor_compartment_details dbms_cloud_oci_healthchecks_change_ping_monitor_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_change_ping_monitor_compartment_response_t;

Parameters

Parameter	Description
`monitor_id`	(required) The OCID of a monitor.
`change_ping_monitor_compartment_details`	(required) The details needed to move the monitor.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_HTTP_MONITOR Function

Creates an HTTP monitor. Vantage points will be automatically selected if not specified, and probes will be initiated from each vantage point to each of the targets at the frequency specified by `intervalInSeconds`.

Syntax

FUNCTION create_http_monitor (
  create_http_monitor_details dbms_cloud_oci_healthchecks_create_http_monitor_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_create_http_monitor_response_t;

Parameters

Parameter	Description
`create_http_monitor_details`	(required) The configuration details for creating an HTTP monitor.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_ON_DEMAND_HTTP_PROBE Function

Creates an on-demand HTTP probe. The location response header contains the URL for fetching the probe results. *Note:* On-demand probe configurations are not saved.

Syntax

FUNCTION create_on_demand_http_probe (
  create_on_demand_http_probe_details dbms_cloud_oci_healthchecks_create_on_demand_http_probe_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_create_on_demand_http_probe_response_t;

Parameters

Parameter	Description
`create_on_demand_http_probe_details`	(required) The configuration of the HTTP probe.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_ON_DEMAND_PING_PROBE Function

Creates an on-demand ping probe. The location response header contains the URL for fetching probe results. *Note:* The on-demand probe configuration is not saved.

Syntax

FUNCTION create_on_demand_ping_probe (
  create_on_demand_ping_probe_details dbms_cloud_oci_healthchecks_create_on_demand_ping_probe_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_create_on_demand_ping_probe_response_t;

Parameters

Parameter	Description
`create_on_demand_ping_probe_details`	(required) Configuration details for creating an on-demand ping probe.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_PING_MONITOR Function

Creates a ping monitor. Vantage points will be automatically selected if not specified, and probes will be initiated from each vantage point to each of the targets at the frequency specified by `intervalInSeconds`.

Syntax

FUNCTION create_ping_monitor (
  create_ping_monitor_details dbms_cloud_oci_healthchecks_create_ping_monitor_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_create_ping_monitor_response_t;

Parameters

Parameter	Description
`create_ping_monitor_details`	(required) The configuration details for creating a ping monitor.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. Note: Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_HTTP_MONITOR Function

Deletes the HTTP monitor and its configuration. All future probes of this monitor are stopped. Results associated with the monitor are not deleted.

Syntax

FUNCTION delete_http_monitor (
  monitor_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_delete_http_monitor_response_t;

Parameters

Parameter	Description
`monitor_id`	(required) The OCID of a monitor.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_PING_MONITOR Function

Deletes the ping monitor and its configuration. All future probes of this monitor are stopped. Results associated with the monitor are not deleted.

Syntax

FUNCTION delete_ping_monitor (
  monitor_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_delete_ping_monitor_response_t;

Parameters

Parameter	Description
`monitor_id`	(required) The OCID of a monitor.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_HTTP_MONITOR Function

Gets the configuration for the specified monitor.

Syntax

FUNCTION get_http_monitor (
  monitor_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_get_http_monitor_response_t;

Parameters

Parameter	Description
`monitor_id`	(required) The OCID of a monitor.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_none_match`	(optional) The `If-None-Match` header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is `*`, or having a selected representation with an entity-tag that does not match any of those listed in the field-value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PING_MONITOR Function

Gets the configuration for the specified ping monitor.

Syntax

FUNCTION get_ping_monitor (
  monitor_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_get_ping_monitor_response_t;

Parameters

Parameter	Description
`monitor_id`	(required) The OCID of a monitor.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_none_match`	(optional) The `If-None-Match` header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is `*`, or having a selected representation with an entity-tag that does not match any of those listed in the field-value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_HEALTH_CHECKS_VANTAGE_POINTS Function

Gets information about all vantage points available to the user.

Syntax

FUNCTION list_health_checks_vantage_points (
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_list_health_checks_vantage_points_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`sort_by`	(optional) The field to sort by when listing vantage points. Allowed values are: 'name', 'displayName'
`sort_order`	(optional) Controls the sort order of results. Allowed values are: 'ASC', 'DESC'
`name`	(optional) Filters results that exactly match the `name` field.
`display_name`	(optional) Filters results that exactly match the `displayName` field.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_HTTP_MONITORS Function

Gets a list of HTTP monitors.

Syntax

FUNCTION list_http_monitors (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  home_region varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_list_http_monitors_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) Filters results by compartment.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`sort_by`	(optional) The field to sort by when listing monitors. Allowed values are: 'id', 'displayName', 'timeCreated'
`sort_order`	(optional) Controls the sort order of results. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) Filters results that exactly match the `displayName` field.
`home_region`	(optional) Filters results that match the `homeRegion`.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_HTTP_PROBE_RESULTS Function

Gets the HTTP probe results for the specified probe or monitor, where the `probeConfigurationId` is the OCID of either a monitor or an on-demand probe.

Syntax

FUNCTION list_http_probe_results (
  probe_configuration_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  start_time_greater_than_or_equal_to number DEFAULT NULL,
  start_time_less_than_or_equal_to number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  target varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_list_http_probe_results_response_t;

Parameters

Parameter	Description
`probe_configuration_id`	(required) The OCID of a monitor or on-demand probe.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`start_time_greater_than_or_equal_to`	(optional) Returns results with a `startTime` equal to or greater than the specified value.
`start_time_less_than_or_equal_to`	(optional) Returns results with a `startTime` equal to or less than the specified value.
`sort_order`	(optional) Controls the sort order of results. Allowed values are: 'ASC', 'DESC'
`target`	(optional) Filters results that match the `target`.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PING_MONITORS Function

Gets a list of configured ping monitors. Results are paginated based on `page` and `limit`. The `opc-next-page` header provides a URL for fetching the next page.

Syntax

FUNCTION list_ping_monitors (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  home_region varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_list_ping_monitors_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) Filters results by compartment.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`sort_by`	(optional) The field to sort by when listing monitors. Allowed values are: 'id', 'displayName', 'timeCreated'
`sort_order`	(optional) Controls the sort order of results. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) Filters results that exactly match the `displayName` field.
`home_region`	(optional) Filters results that match the `homeRegion`.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PING_PROBE_RESULTS Function

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`.

Syntax

FUNCTION list_ping_probe_results (
  probe_configuration_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  start_time_greater_than_or_equal_to number DEFAULT NULL,
  start_time_less_than_or_equal_to number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  target varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_list_ping_probe_results_response_t;

Parameters

Parameter	Description
`probe_configuration_id`	(required) The OCID of a monitor or on-demand probe.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(optional) The maximum number of items to return in a paginated \"List\" call.
`page`	(optional) The value of the `opc-next-page` response header from the previous \"List\" call.
`start_time_greater_than_or_equal_to`	(optional) Returns results with a `startTime` equal to or greater than the specified value.
`start_time_less_than_or_equal_to`	(optional) Returns results with a `startTime` equal to or less than the specified value.
`sort_order`	(optional) Controls the sort order of results. Allowed values are: 'ASC', 'DESC'
`target`	(optional) Filters results that match the `target`.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_HTTP_MONITOR Function

Updates the configuration of the specified HTTP monitor. Only the fields specified in the request body will be updated; all other configuration properties will remain unchanged.

Syntax

FUNCTION update_http_monitor (
  monitor_id varchar2,
  update_http_monitor_details dbms_cloud_oci_healthchecks_update_http_monitor_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_update_http_monitor_response_t;

Parameters

Parameter	Description
`monitor_id`	(required) The OCID of a monitor.
`update_http_monitor_details`	(required) The configuration details to update for the HTTP monitor.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_PING_MONITOR Function

Updates the configuration of the specified ping monitor. Only the fields specified in the request body will be updated; all other configuration properties will remain unchanged.

Syntax

FUNCTION update_ping_monitor (
  monitor_id varchar2,
  update_ping_monitor_details dbms_cloud_oci_healthchecks_update_ping_monitor_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_hc_health_checks_update_ping_monitor_response_t;

Parameters

Parameter	Description
`monitor_id`	(required) The OCID of a monitor.
`update_ping_monitor_details`	(required) Details for updating a Ping monitor.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://healthchecks.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CHANGE_HTTP_MONITOR_COMPARTMENT Function 🔗

CHANGE_PING_MONITOR_COMPARTMENT Function 🔗

CREATE_HTTP_MONITOR Function 🔗

CREATE_ON_DEMAND_HTTP_PROBE Function 🔗

CREATE_ON_DEMAND_PING_PROBE Function 🔗

CREATE_PING_MONITOR Function 🔗

DELETE_HTTP_MONITOR Function 🔗

DELETE_PING_MONITOR Function 🔗

GET_HTTP_MONITOR Function 🔗

GET_PING_MONITOR Function 🔗

LIST_HEALTH_CHECKS_VANTAGE_POINTS Function 🔗

LIST_HTTP_MONITORS Function 🔗

LIST_HTTP_PROBE_RESULTS Function 🔗

LIST_PING_MONITORS Function 🔗

LIST_PING_PROBE_RESULTS Function 🔗

UPDATE_HTTP_MONITOR Function 🔗

UPDATE_PING_MONITOR Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_HTTP_MONITOR_COMPARTMENT Function

CHANGE_PING_MONITOR_COMPARTMENT Function

CREATE_HTTP_MONITOR Function

CREATE_ON_DEMAND_HTTP_PROBE Function

CREATE_ON_DEMAND_PING_PROBE Function

CREATE_PING_MONITOR Function

DELETE_HTTP_MONITOR Function

DELETE_PING_MONITOR Function

GET_HTTP_MONITOR Function

GET_PING_MONITOR Function

LIST_HEALTH_CHECKS_VANTAGE_POINTS Function

LIST_HTTP_MONITORS Function

LIST_HTTP_PROBE_RESULTS Function

LIST_PING_MONITORS Function

LIST_PING_PROBE_RESULTS Function

UPDATE_HTTP_MONITOR Function

UPDATE_PING_MONITOR Function