REST API for Oracle SOA Cloud Service

Monitor a Service Instance

get

/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/healthcheck

Returns health monitoring data for the specified Oracle SOA Cloud Service instance.

Request

Path Parameters

domainName: string

Name of the identity domain for the Oracle Cloud Service account.
serviceName: string

Name of the Oracle SOA Cloud Service instance.

Response

Supported Media Types

application/json

200 Response

OK.

Request payload for starting an SOA Cloud Service instance

Root Schema : healthcheck-response

Type: object

Request payload for starting an SOA Cloud Service instance

Show Source

components: object components
domainName: string

Name of the identity domain for the Oracle Cloud Service account.
serviceId: string

The ID number of the healthcheck.
serviceName: string

Name of the Oracle SOA Cloud Service instance.
status: string

Flag that specifies the status of the Oracle SOA Cloud Service instance. Valid values include: Running, In Progress, Terminating, and Up.
timestamp: string

Date and time of the status of Oracle SOA Cloud Service instance.

{
    "required":[
        "serviceName",
        "domainName",
        "status",
        "serviceId",
        "timestamp",
        "components"
    ],
    "type":"object",
    "description":"Request payload for starting an SOA Cloud Service instance",
    "properties":{
        "components":{
            "type":"object",
            "properties":{
                "WLS":{
                    "type":"object"
                }
            }
        },
        "timestamp":{
            "type":"string",
            "description":"Date and time of the status of Oracle SOA Cloud Service instance."
        },
        "serviceId":{
            "type":"string",
            "description":"The ID number of the healthcheck."
        },
        "status":{
            "type":"string",
            "description":"Flag that specifies the status of the Oracle SOA Cloud Service instance. Valid values include: <code>Running</code>, <code>In Progress</code>, <code>Terminating</code>, and <code>Up</code>."
        },
        "domainName":{
            "type":"string",
            "description":"Name of the identity domain for the Oracle Cloud Service account."
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the Oracle SOA Cloud Service instance."
        }
    }
}

Nested Schema : components

Type: object

Show Source

WLS(optional): object WLS

{
    "type":"object",
    "properties":{
        "WLS":{
            "type":"object"
        }
    }
}

Nested Schema : WLS

Type: object

404 Response

Not Found

500 Response

Internal Server Error

Examples

The following example shows how to monitor an Oracle SOA Cloud Service instance by submitting a GET request on the REST resource using cURL For more information, see Use cURL.

cURL Command

curl -i -X GET -u username:Password1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest-server_url.com/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/healthcheck

Example of Request Header

The following shows an example of the request header.

-u '{userName}:{password}'	
X-ID-TENANT-NAME: {domainName}
Accept: application/json

Example of Response Body

The following shows an example of the response document returned in JSON format:

{
  "timestamp": "2017-03-16T06:24:24.473+00:00",
  "collectionTime": "2018-08-02T08:37:18.721+00:00",
  "serviceId": 3,
  "status": "UP",
  "domainName": "soacs",
  "components": {
    "WLS": {
      "timestamp": "2017-03-16T06:24:18.000+00:00",
      "serviceId": 3,
      "status": "UP",
      "vmInstances": {
        "MyInstance-wls-2": {
          "timestamp": "2017-03-16T06:24:16.814+00:00",
          "status": "UP",
          "servers": {
            "MyServer_2": {
              "timestamp": "2017-03-16T06:24:18.000+00:00",
              "status": "UP",
              "serverId": 10,
              "serverName": "MyServer_2",
              "healthData": {
                "upsince": {
                  "unit": "ms",
                  "value": "2017-03-15T11:52:01.000+00:00",
                  "displayName": "Server time from when it was up."
                },
                "heapmax": {
                  "unit": "MB",
                  "value": "7282",
                  "displayName": "Max memory"
                },
                "heapfree": {
                  "unit": "MB",
                  "value": "5825.6",
                  "displayName": "Free memory"
                }
              },
              "serverType": "WLS"
            }
          },
          "hostName": "MyInstance-wls-2",
          "label": "MyInstance wls 2",
          "vmId": 10,
          "computeStatus": "ready"
        },
        "MyInstance-wls-1": {
          "timestamp": "2017-03-16T06:24:16.814+00:00",
          "status": "UP",
          "servers": {
            "MySever_adminserver": {
              "timestamp": "2017-03-16T06:24:18.000+00:00",
              "status": "UP",
              "serverId": 4,
              "serverName": "MyServer_adminserver",
              "healthData": {
                "upsince": {
                  "unit": "ms",
                  "value": "2017-03-14T12:05:35.000+00:00",
                  "displayName": "Server time from when it was up."
                },
                "heapmax": {
                  "unit": "MB",
                  "value": "1820.5",
                  "displayName": "Max memory"
                },
                "heapfree": {
                  "unit": "MB",
                  "value": "946.66",
                  "displayName": "Free memory"
                }
              },
              "serverType": "WLS",
              "statusMessage": "Not processing requests"
            },
            "MyServer_1": {
              "timestamp": "2017-03-16T06:24:18.000+00:00",
              "status": "UP",
              "serverId": 3,
              "serverName": "MyServer_1",
              "healthData": {
                "upsince": {
                  "unit": "ms",
                  "value": "2017-03-14T12:09:09.000+00:00",
                  "displayName": "Server time from when it was up."
                },
                "heapmax": {
                  "unit": "MB",
                  "value": "7282",
                  "displayName": "Max memory"
                },
                "heapfree": {
                  "unit": "MB",
                  "value": "5388.68",
                  "displayName": "Free memory"
                }
              },
              "serverType": "WLS"
            }
          },
          "hostName": "MyInstance-wls-1",
          "label": "MyInstance wls 1",
          "vmId": 3,
          "computeStatus": "ready"
        }
      },
      "componentId": 4,
      "componentType": "WLS",
      "statusMessage": "Number of servers processing request:2"
    }
  },
  "dataQuality": {
    "message": "Health data complete"
  },
  "serviceType": "SOA",
  "serviceName": "MyInstance",
  "statusMessage": "Running"
}