1. REST API for Managing Applications
  2. Tasks
  3. Health Monitoring

Monitor an Application

get

/paas/api/v1.1/healthcheck/{identityDomainId}/services/apaas/instances/{appName}

Returns health monitoring data, including memory and memory usage, for an application.

Request

Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
The response body includes health monitoring information.
Root Schema : viewHealthCheck-response
Type: object
The response body includes health monitoring information.
Show Source
Nested Schema : service_components
Type: array
Groups the health summary for the Application Container Cloud application.
Show Source
Nested Schema : summary
Type: array
Groups the health summary for the Application Container Cloud application.
Show Source
Nested Schema : viewHealthCheckServiceComponent
Type: object
Groups the health summary for the Application Container Cloud application.
Show Source
Nested Schema : summary
Type: array
Groups the health summary for the Application Container Cloud application service components
Show Source
Nested Schema : vms
Type: array
Groups the health summary for the Application Container Cloud application vms
Show Source
Nested Schema : viewHealthCheck-summary
Type: object
Groups the health summary for the Application Container Cloud application.
Show Source
Nested Schema : viewHealthCheckServiceComponentVM
Type: object
Groups the health summary for the Application Container Cloud application.
Show Source
Nested Schema : health_data
Type: array
Groups the runtime metrics for the Application Container Cloud application vms
Show Source
Nested Schema : servers
Type: array
This will be always empty
Show Source
Nested Schema : summary
Type: array
Groups the health summary for the Application Container Cloud application service components
Show Source
Nested Schema : viewHealthCheckServiceComponentVMHealthData
Type: object
Shows the health data.
Show Source
Back to Top

Examples

The following example shows how to retrieve monitoring data for an Oracle Application Cloud Service application by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, including how to determine your region, see Send Requests. 

curl -X GET -u joe@example.com:Welcome1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" \
https://apaas.us.oraclecloud.com/paas/api/v1.1/healthcheck/ExampleIdentityDomain/services/apaas/instances/ExampleAppName

To display monitoring data in the user interface, see Viewing Service Metrics for an Application.

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Thu, 05 Jan 2017 01:49:04 GMT
Server: Oracle-Application-Server-11g
Set-Cookie: OAMAuthnCookie_apaas.europe.oraclecloud.com:443=cajk35...; httponly; secure; path=/
Content-Length: 575
Content-Language: en
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
X-ORACLE-DMS-ECID: 005HKwRDxy53z015Rvl3id0005WI00005u
X-ORACLE-DMS-ECID: 005HKwRDxy53z015Rvl3id0005WI00005u
Access-Control-Allow-Origin: *
Vary: Accept-Encoding,User-Agent
X-Frame-Options: DENY
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{  
   "summary":{
      "status":"UP",
      "status_time":"2016-06-20T17:24:51.911+00:00"
   },
   "identity_domain":"ExampleIdentityDomain",
   "service_components":[{
      "summary":{
         "status":"UP",
         "status_time":"2016-06-20T17:24:51.912+00:00",
         "sub_status":"calculated"
      },
      "component":"METRIC",
      "vms":[{
         "summary":{
            "status":"UP",
            "status_time":"2016-06-20T14:38:28.028+00:00"
         },
         "vm":"web.1",
         "servers":[],"health_data":[{
            "unit":"MB",
            "name":"memory","value":"250.4"
         },
         {
            "unit":"%",
            "name":"memoryUsed","value":"24.45"
         }]
      }]
   }],
   "service_name":"ExampleAppName"
}
Back to Top