HealthChecksClient

class oci.healthchecks.HealthChecksClient(config, **kwargs)

API for the Health Checks service. Use this API to manage endpoint probes and monitors. For more information, see [Overview of the Health Checks Service](/iaas/Content/HealthChecks/Concepts/healthchecks.htm).

__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) -- Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) -- (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) -- (optional) The connection and read timeouts for the client. The default is that the client never times out. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) --

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) --

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

change_http_monitor_compartment(monitor_id, change_http_monitor_compartment_details, **kwargs)

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

Parameters:
  • monitor_id (str) -- (required) The OCID of a monitor.
  • change_http_monitor_compartment_details (ChangeHttpMonitorCompartmentDetails) -- (required) The details needed to move the monitor.
  • if_match (str) -- (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 (str) -- (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 (str) --

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

  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

change_ping_monitor_compartment(monitor_id, change_ping_monitor_compartment_details, **kwargs)

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

Parameters:
  • monitor_id (str) -- (required) The OCID of a monitor.
  • change_ping_monitor_compartment_details (ChangePingMonitorCompartmentDetails) -- (required) The details needed to move the monitor.
  • if_match (str) -- (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 (str) -- (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 (str) --

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

  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

create_http_monitor(create_http_monitor_details, **kwargs)

Creates an HTTP monitor. 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.

Parameters:
  • create_http_monitor_details (CreateHttpMonitorDetails) -- (required) The configuration details for creating an HTTP monitor.
  • opc_request_id (str) -- (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 (str) --

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

  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type HttpMonitor

Return type:

Response

create_on_demand_http_probe(create_on_demand_http_probe_details, **kwargs)

Creates an on-demand HTTP probe. 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.

Parameters:
  • create_on_demand_http_probe_details (CreateOnDemandHttpProbeDetails) -- (required) The configuration of the HTTP probe.
  • opc_request_id (str) -- (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type HttpProbe

Return type:

Response

create_on_demand_ping_probe(create_on_demand_ping_probe_details, **kwargs)

Creates an on-demand Ping probe. 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.

Parameters:
  • create_on_demand_ping_probe_details (CreateOnDemandPingProbeDetails) -- (required) Configuration details for creating an on-demand ping probe.
  • opc_request_id (str) -- (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PingProbe

Return type:

Response

create_ping_monitor(create_ping_monitor_details, **kwargs)

Creates a Ping monitor. 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.

Parameters:
  • create_ping_monitor_details (CreatePingMonitorDetails) -- (required) The configuration details for creating a ping monitor.
  • opc_request_id (str) -- (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 (str) --

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

  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PingMonitor

Return type:

Response

delete_http_monitor(monitor_id, **kwargs)

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

Parameters:
  • monitor_id (str) -- (required) The OCID of a monitor.
  • opc_request_id (str) -- (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 (str) -- (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.
  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_ping_monitor(monitor_id, **kwargs)

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

Parameters:
  • monitor_id (str) -- (required) The OCID of a monitor.
  • opc_request_id (str) -- (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 (str) -- (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.
  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

get_http_monitor(monitor_id, **kwargs)

Gets the HTTP monitor configuration. Gets the configuration for the specified monitor.

Parameters:
  • monitor_id (str) -- (required) The OCID of a monitor.
  • opc_request_id (str) -- (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 (str) -- (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.
  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type HttpMonitor

Return type:

Response

get_ping_monitor(monitor_id, **kwargs)

Returns the Ping monitor configuration. Gets the configuration for the specified ping monitor.

Parameters:
  • monitor_id (str) -- (required) The OCID of a monitor.
  • opc_request_id (str) -- (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 (str) -- (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.
  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PingMonitor

Return type:

Response

list_health_checks_vantage_points(**kwargs)

Returns information about available vantage points.

Gets information about all vantage points available to the user.

Parameters:
  • opc_request_id (str) -- (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • limit (int) -- (optional) The maximum number of items to return in a paginated "List" call.
  • page (str) -- (optional) The value of the opc-next-page response header from the previous "List" call.
  • sort_by (str) --

    (optional) The field to sort by when listing vantage points.

    Allowed values are: "name", "displayName"

  • sort_order (str) --

    (optional) Controls the sort order of results.

    Allowed values are: "ASC", "DESC"

  • name (str) -- (optional) Filters results that exactly match the name field.
  • display_name (str) -- (optional) Filters results that exactly match the displayName field.
  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of HealthChecksVantagePointSummary

Return type:

Response

list_http_monitors(compartment_id, **kwargs)

Gets HTTP monitors. Gets a list of HTTP monitors.

Parameters:
  • compartment_id (str) -- (required) Filters results by compartment.
  • opc_request_id (str) -- (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • limit (int) -- (optional) The maximum number of items to return in a paginated "List" call.
  • page (str) -- (optional) The value of the opc-next-page response header from the previous "List" call.
  • sort_by (str) --

    (optional) The field to sort by when listing monitors.

    Allowed values are: "id", "displayName", "timeCreated"

  • sort_order (str) --

    (optional) Controls the sort order of results.

    Allowed values are: "ASC", "DESC"

  • display_name (str) -- (optional) Filters results that exactly match the displayName field.
  • home_region (str) -- (optional) Filters results that match the homeRegion.
  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of HttpMonitorSummary

Return type:

Response

list_http_probe_results(probe_configuration_id, **kwargs)

Gets the HTTP probe results for the specified monitor or on-demand probe. 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.

Parameters:
  • probe_configuration_id (str) -- (required) The OCID of a monitor or on-demand probe.
  • opc_request_id (str) -- (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • limit (int) -- (optional) The maximum number of items to return in a paginated "List" call.
  • page (str) -- (optional) The value of the opc-next-page response header from the previous "List" call.
  • start_time_greater_than_or_equal_to (float) -- (optional) Returns results with a startTime equal to or greater than the specified value.
  • start_time_less_than_or_equal_to (float) -- (optional) Returns results with a startTime equal to or less than the specified value.
  • sort_order (str) --

    (optional) Controls the sort order of results.

    Allowed values are: "ASC", "DESC"

  • target (str) -- (optional) Filters results that match the target.
  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of HttpProbeResultSummary

Return type:

Response

list_ping_monitors(compartment_id, **kwargs)

Returns Ping monitors. 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.

Parameters:
  • compartment_id (str) -- (required) Filters results by compartment.
  • opc_request_id (str) -- (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • limit (int) -- (optional) The maximum number of items to return in a paginated "List" call.
  • page (str) -- (optional) The value of the opc-next-page response header from the previous "List" call.
  • sort_by (str) --

    (optional) The field to sort by when listing monitors.

    Allowed values are: "id", "displayName", "timeCreated"

  • sort_order (str) --

    (optional) Controls the sort order of results.

    Allowed values are: "ASC", "DESC"

  • display_name (str) -- (optional) Filters results that exactly match the displayName field.
  • home_region (str) -- (optional) Filters results that match the homeRegion.
  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PingMonitorSummary

Return type:

Response

list_ping_probe_results(probe_configuration_id, **kwargs)

Returns the Ping probe results for the specified monitor or on-demand probe. 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.

Parameters:
  • probe_configuration_id (str) -- (required) The OCID of a monitor or on-demand probe.
  • opc_request_id (str) -- (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • limit (int) -- (optional) The maximum number of items to return in a paginated "List" call.
  • page (str) -- (optional) The value of the opc-next-page response header from the previous "List" call.
  • start_time_greater_than_or_equal_to (float) -- (optional) Returns results with a startTime equal to or greater than the specified value.
  • start_time_less_than_or_equal_to (float) -- (optional) Returns results with a startTime equal to or less than the specified value.
  • sort_order (str) --

    (optional) Controls the sort order of results.

    Allowed values are: "ASC", "DESC"

  • target (str) -- (optional) Filters results that match the target.
  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PingProbeResultSummary

Return type:

Response

update_http_monitor(monitor_id, update_http_monitor_details, **kwargs)

Updates the HTTP monitor configuration. 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.

Parameters:
  • monitor_id (str) -- (required) The OCID of a monitor.
  • update_http_monitor_details (UpdateHttpMonitorDetails) -- (required) The configuration details to update for the HTTP monitor.
  • opc_request_id (str) -- (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 (str) -- (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.
  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type HttpMonitor

Return type:

Response

update_ping_monitor(monitor_id, update_ping_monitor_details, **kwargs)

Updates the Ping monitor configuration. 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.

Parameters:
  • monitor_id (str) -- (required) The OCID of a monitor.
  • update_ping_monitor_details (UpdatePingMonitorDetails) -- (required) Details for updating a Ping monitor.
  • opc_request_id (str) -- (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 (str) -- (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.
  • retry_strategy (obj) --

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PingMonitor

Return type:

Response