1. REST API for Oracle Java Cloud Service
  2. Tasks
  3. Service Instances

View Health Data for a Service Instance

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/healthcheck

Returns healthcheck monitoring data and metrics for the specified Oracle Java Cloud Service instance.

In the event you encounter a status 500 error when attempting to retrieve data for your service instance, append the ?format=v4 query parameter and try again.

Request

Path Parameters
Query Parameters
  • Append ?format=v4 to the end of the resource path to return basic health data in situations where errors in the monitoring would have caused a status 500 to be returned.

    Note: The structure of the output when using the query parameter is not the same as the output without the parameter, but the healthcheck and metrics information is the same.

Header Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : monitor-responsem
Type: object
The response body includes health monitoring information.
Show Source
Nested Schema : components
Type: object
Groups health details about the WLS component and the OTD component (if provisioned).
Show Source
Nested Schema : dataQuality
Type: object
Groups quality messages.
Show Source
Nested Schema : OTD
Type: object
Details about the OTD component.
Show Source
Nested Schema : WLS
Type: object
Details about the WLS component.
Show Source
Nested Schema : vmInstances
Type: object
Groups details about OTD VM instances by host name. Each VM instance is a JSON object element.
Show Source
  • vm-otd
    Details about a specific VM instance.

    Note that the label of this object (vm-otd) is actually the host name, for example, exampleinstance-lb-1 or exampleinstance-lb-2.

Nested Schema : vm-otd
Type: object
Details about a specific VM instance.

Note that the label of this object (vm-otd) is actually the host name, for example, exampleinstance-lb-1 or exampleinstance-lb-2.

Show Source
Nested Schema : healthData
Type: object
Health monitoring runtime details of a VM.
Show Source
Nested Schema : servers
Type: object
Details of server on a VM (OTD component).
Show Source
Nested Schema : VMCpuUtil
Type: object
VM CPU Usage
Show Source
Nested Schema : VMmemory
Type: object
VM free memory
Show Source
Nested Schema : server-name
Type: object
Details about a specific server instance.

Note that the label of this object (server-name) is actually the server name. For example: ExampleInstance-lb-1

Show Source
Nested Schema : healthData
Type: object
Health monitoring runtime details of a server.
Show Source
Nested Schema : error-request-count
Type: object
Error request count
Show Source
Nested Schema : request-count
Type: object
Request count
Show Source
Nested Schema : rtLast5MinAvg
Type: object
Avg resp time 5 min
Show Source
Nested Schema : upsince
Type: object
Server up since
Show Source
Nested Schema : vmInstances
Type: object
Groups details about WLS VM instances by host name. Each VM instance is a JSON object element.
Show Source
  • vm-wls
    Details about a specific VM instance.

    Note that the label of this object (vm-wls) is actually the host name, for example, exampleinstance-wls-1, exampleinstance-wls-2, and so on.

Nested Schema : vm-wls
Type: object
Details about a specific VM instance.

Note that the label of this object (vm-wls) is actually the host name, for example, exampleinstance-wls-1, exampleinstance-wls-2, and so on.

Show Source
Nested Schema : healthData
Type: object
Health monitoring runtime details of a VM.
Show Source
Nested Schema : servers
Type: object
Groups one or more servers on a VM (WLS component).
Show Source
  • server-name
    Details about a specific server instance.

    Note that the label of this object (server-name) is actually the server name. For example: ExampleI_adminserver or ExampleI_server_1

Nested Schema : VMCpuUtil
Type: object
VM CPU Usage
Show Source
Nested Schema : VMmemory
Type: object
VM free memory
Show Source
Nested Schema : server-name
Type: object
Details about a specific server instance.

Note that the label of this object (server-name) is actually the server name. For example: ExampleI_adminserver or ExampleI_server_1

Show Source
Nested Schema : healthData
Type: object
Health monitoring runtime details of a server.
Show Source
Nested Schema : heapfree
Type: object
Free memory
Show Source
Nested Schema : heapmax
Type: object
Max memory
Show Source
Nested Schema : upsince
Type: object
Server up since
Show Source
Back to Top

Examples

The following example shows how to retrieve health data for an Oracle Java Cloud Service instance by submitting a GET request on the REST resource using cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.

cURL Command

curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/healthcheck

Or, 

curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/healthcheck?format=v4

Example of Response Header

The following shows an example of the response header.

HTTP/1.0 200 Connection established

HTTP/2 200
server: Oracle-Application-Server-11g
strict-transport-security: max-age=31536000;includeSubDomains
content-language: en
access-control-allow-headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
access-control-allow-methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
x-oracle-dms-ecid: 005Q45AAuAB3z015Rvl3id0007SK0002DM
x-oracle-dms-ecid: 005Q45AAuAB3z015Rvl3id0007SK0002DM
access-control-allow-origin: *
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Sun, 25 Mar 2018 19:02:51 GMT
content-length: 2485

Example of Response Body

The following shows an example of the response returned.

{
   "timestamp":"2018-09-13T15:58:12.862+00:00",
   "collectionTime":"2018-09-13T15:58:19.076+00:00",
   "serviceId":660660,
   "status":"UP",
   "domainName":"idcs-1ab1b980488e1a",
   "components":{
      "OTD":{
         "timestamp":"2018-09-13T15:58:12.820+00:00",
         "collectionTime":"2018-09-13T15:58:19.077+00:00",
         "serviceId":660660,
         "status":"UP",
         "vmInstances":{
            "exampleinstance-lb-1":{
               "servers":{
                  "ExampleI-lb-1":{
                     "timestamp":"2018-09-13T15:58:12.820+00:00",
                     "collectionTime":"2018-09-13T15:58:19.079+00:00",
                     "status":"UP",
                     "serverId":229365,
                     "serverName":"ExamleI-lb-1",
                     "healthData":{
                        "request-count":{
                           "unit":"count",
                           "value":"0",
                           "displayName":"Request count"
                        },
                        "rtLast5MinAvg":{
                           "unit":"ms",
                           "value":"0",
                           "displayName":"Avg resp time 5 min"
                        },
                        "error-request-count":{
                           "unit":"count",
                           "value":"0",
                           "displayName":"Error request count"
                        },
                        "upsince":{
                           "unit":"ms",
                           "value":"2018-09-13T00:18:21.000+00:00",
                           "displayName":"Server Up since"
                        }
                     },
                     "serverType":"OTD_SERVER",
                     "statusMessage":"Running"
                  }
               },
               "hostName":"exampleinstance-lb-1",
               "label":"ExampleInstance lb 1",
               "vmId":413957
            }
         },
         "componentId":284049,
         "componentType":"OTD",
         "statusMessage":"Running"
      },
      "WLS":{
         "timestamp":"2018-09-13T15:58:09.536+00:00",
         "collectionTime":"2018-09-13T15:58:19.066+00:00",
         "serviceId":660660,
         "status":"UP",
         "vmInstances":{
            "exampleinstance-wls-1":{
               "servers":{
                  "ExampleI_server_1":{
                     "timestamp":"2018-09-13T15:58:09.409+00:00",
                     "collectionTime":"2018-09-13T15:58:19.083+00:00",
                     "status":"UP",
                     "serverId":215556,
                     "serverName":"ExampleI_server_1",
                     "healthData":{
                        "upsince":{
                           "unit":"ms",
                           "value":"2018-09-08T21:03:43.000+00:00",
                           "displayName":"Server up since"
                        },
                        "heapmax":{
                           "unit":"MB",
                           "value":"1820.5",
                           "displayName":"Max memory"
                        },
                        "heapfree":{
                           "unit":"MB",
                           "value":"1328.96",
                           "displayName":"Free memory"
                        }
                     },
                     "serverType":"MS",
                     "statusMessage":"Running"
                  },
                  "ExampleI_adminserver":{
                     "timestamp":"2018-09-13T15:58:07.996+00:00",
                     "collectionTime":"2018-09-13T15:58:19.084+00:00",
                     "status":"UP",
                     "serverId":215555,
                     "serverName":"ExampleI_adminserver",
                     "healthData":{
                        "upsince":{
                           "unit":"ms",
                           "value":"2018-09-08T21:02:40.000+00:00",
                           "displayName":"Server up since"
                        },
                        "heapmax":{
                           "unit":"MB",
                           "value":"1365.5",
                           "displayName":"Max memory"
                        },
                        "heapfree":{
                           "unit":"MB",
                           "value":"832.95",
                           "displayName":"Free memory"
                        }
                     },
                     "serverType":"ADMIN",
                     "statusMessage":"Running"
                  }
               },
               "hostName":"exampleinstance-wls-1",
               "label":"ExampleInstance wls 1",
               "vmId":398758
            },
            "exampleinstance-wls-3":{
               "servers":{
                  "ExampleI_server_3":{
                     "timestamp":"2018-09-13T15:58:09.512+00:00",
                     "collectionTime":"2018-09-13T15:58:19.082+00:00",
                     "status":"UP",
                     "serverId":231479,
                     "serverName":"ExampleI_server_3",
                     "healthData":{
                        "upsince":{
                           "unit":"ms",
                           "value":"2018-09-12T19:39:20.000+00:00",
                           "displayName":"Server up since"
                        },
                        "heapmax":{
                           "unit":"MB",
                           "value":"1820.5",
                           "displayName":"Max memory"
                        },
                        "heapfree":{
                           "unit":"MB",
                           "value":"1219.73",
                           "displayName":"Free memory"
                        }
                     },
                     "serverType":"MS",
                     "statusMessage":"Running"
                  }
               },
               "hostName":"exampleinstance-wls-3",
               "label":"ExampleInstance wls 3",
               "vmId":416588
            }
         },
         "componentId":284050,
         "componentType":"WLS",
         "statusMessage":"Running"
      }
   },
   "dataQuality":{
      "message":"Health data complete"
   },
   "serviceType":"JaaS",
   "serviceName":"ExampleInstance",
   "statusMessage":"Running"
}
Back to Top