REST API for Oracle SOA Cloud Service on Oracle Public Cloud Machine

View All Server Operations

get

/api/v1.1/instances/{identityId}/{serviceId}/servers/history

Returns a list of all scaling operations performed on this service.

Request

Query Parameters

filter: Type: string

Filters operations by the specified text.
orderby: Type: string

Orders operations by the specified field.

Response

Supported Media Types

application/json
text/plain

200 Response

Body

Root Schema : ViewAllServerOperationsResponse

Properties

affectedServer: Type: string

Name of the Managed Server or load balancer impacted by the operation.
endDate: Type: string

Date and time the operation completed. If the operation is still in progress or if it failed, this field is omitted.
hostName: Type: string

Host name of the Managed Server or load balancer.
id: Type: string

ID of the operation. You can use the operation ID to check its status.
inProgress: Type: boolean

Flag that specifies whether the scaling operation is in progress.
jobId: Type: string

Job ID for the scaling operation. You can use the job ID to check its status.
Note:This value may be set to No Job Submitted temporarily, just prior to being submitted for processing.
operationType: Type: string

Type of operation. For example: SCALE_IN, SCALE_OUT, START_VM, STOP_VM, START_SERVICE, STOP_SERVICE, and so on.
serviceId: Type: string

ID of the Oracle SOA Cloud Service instance.
startDate: Type: string

Date and time the operation started.
status: Type: string

Status of the operation. Example status messages include: Preparing for scaling, Scaling completed, Verifying the scaled WebLogic Server, Scaling operation failed, SUCCEED, and FAILED.

Examples

The following example shows how to view information about all scaling operations for 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 -X GET -u joe@example.com:Welcome1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://api-host/paas/service/soa/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance/servers/history

Note:: This example uses the URL prefix for the United States ( soacs). For information about the URL prefixes for other regions of the world, see Send Requests.

Example of Response Header

The following shows an example of the response header:

HTTP/1.1 200 OK
Date: Tue, 02 Sep 2014 12:49:59 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following shows an example of the response body. You can use an id in the View Server Operation Status by ID operation. You can use a jobId in the View Server Operation Status by Job ID operation.

[{
   "serviceId":"1",
   "jobId":159,
   "operationType": "STOP_SERVICE",
   "inProgress":false,
   "id":102,
   "status":"SUCCEED",
   "startDate":"Apr 7, 2015 5:28:21 AM",
   "endDate":"Apr 7, 2015 5:40:01 AM"
},
{
   "serviceId":"2",
   "jobId":162,
   "operationType":"SCALE_OUT",
   "inProgress":false,
   "id":112,
   "affectedServer":"ExampleI_server_3",
   "hostName":"exampleinstance-wls-3",   
   "status":"SUCCEED",
   "startDate":"Apr 9, 2015 6:30:21 AM",
   "endDate":"Apr 9, 2015 6:35:10 AM"
},
{
   "serviceId":"3",
   "jobId":171,
   "operationType":"START_VM",
   "inProgress":false,
   "id":115,
   "affectedServer":"ExampleI-lb-1",
   "hostName":"exampleinstance-lb-1",   
   "status":"SUCCEED",
   "startDate":"Apr 9, 2015 6:36:15 AM",
   "endDate":"Apr 9, 2015 6:39:33 AM"
}]