Oracle Cloud Infrastructure Documentation

Creating an HTTP On-Demand Probe

Create an HTTP on-demand probe in Health Checks.

On-demand probes are available through SDK, CLI, and API.

  • This task can't be performed using the Console.

  • Use the oci health-checks http-probe create-on-demand command and required parameters to create an HTTP on-demand probe:

    oci health-checks http-probe create-on-demand --compartment-id <compartment_OCID> --targets <json_file_or_string>

    For a complete list of parameters and values for CLI commands, see the CLI for Health Checks.

  • Run the CreateOnDemandHttpProbe operation to create an HTTP on-demand probe.

    Example

    The following example request creates an HTTP on-demand probe to check the health of www.example.com using GET requests over HTTP protocol.

    POST /20180501/httpProbeResults
{
  "compartmentId": "ocid1.compartment.oc1..<unique_ID>",
  "method": "GET",
  "protocol": "HTTP",
  "targets": ["www.example.com"],
  "timeoutInSeconds": 30
}

    Following is an example 200 response for successful creation of the previously defined HTTP on-demand probe. The resultsUrl field indicates the URL for retrieving results.

    {  
   "id":"ocid1.pingprobe.OC2..<unique_ID>",
   "resultsUrl":"https://healthchecks.us-ashburn-1.oraclecloud.com/20180501/pingProbeResults/ocid1.pingprobe.OC2..<unique_ID>",
   "compartmentId":"ocid1.compartment.oc1..<unique_ID>",
   "protocol":"HTTP",
   "targets":["www.example.com"],
   "timeoutInSeconds":30,
   "vantagePointNames":["ibm-sjc","aws-dub","dgo-nyc"]
}