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

View Server Operation Status by ID

get

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

Returns details of the scaling operation specified by the ID.

Request

Path Parameters

id: Type: string

Required: true

ID of the scaling operation.

Response

Supported Media Types

application/json
text/plain

200 Response

Body

Root Schema : ViewStatusOfServerOperationByJobIDStatus

Properties

actLog: Type: array actLog

Groups the activities defined in the log.

Nested Schema : actLog

Type: array

Groups the activities defined in the log.

Items

Type: object actLog

Nested Schema : actLog

Properties

activityLogId: Type: string

ID of the activity log.
endDate: Type: string

Date and time the operation ended.
hostName: Type: string

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

ID of the operation.
identityId: Type: string

Name of the identity domain for the Oracle SOA Cloud Service account.
jobId: Type: string

Job ID for the operation.
Note: This value may be set to No Job Submitted temporarily, just prior to being submitted for processing.
messages: Type: string

Groups the activity messages.
operation: Type: string

Groups information about the operation.
serverName: Type: string

Name of the server or load balancer.
serverType: Type: string

Type of server, such as WLS or OTD.
serviceId: Type: string

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

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

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

Final status of the operation. Example status messages include: NEW, RUNNING, SUCCEED, and FAILED.

Examples

The following example shows how to view information about the server operation for an Oracle SOA Cloud Service instance using the job ID 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/21

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: Mon, 02 Feb 2015 22:22:34 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following shows an example of a response body that captures the activity log for a stop service instance request.

{
    "actLog":
    {
        "activityLogId":112,
        "serviceId":101,
        "operation":
        {
            "operationId":56,
            "operationType":"CREATE_SERVICE"
        },
        "status":"SUCCEED",
        "startDate":"Apr 9, 2015 12:47:19 PM",
        "endDate":"Apr 9, 2015 1:07:37 PM",
        "identityDomain":"ExampleIdentityDomain",
        "serviceName":"ExampleInstance",
        "hostName":null,
        "serverName":null,
        "serverType":null,
        "jobId":269,
        "messages":[
        {
            "activityMessageId":199,
            "activityDate":"Apr 9, 2015 12:47:19 PM",
            "stepName":"NEW",
            "message":"Submitted Job, Status\u003dWaitingOnResource"        
        },
        {
            "activityMessageId":200,
            "activityDate":"Apr 9, 2015 12:47:19 PM",
            "stepName":"RUNNING",
            "message":"setComputeNamespace"
        },
        {
            "activityMessageId":201,
            "activityDate":"Apr 9, 2015 1:07:37 PM",
            "stepName":"RUNNING",
            "message":"setServiceState""
        }
        ]},
        "messages":[{},{},{},{}
        ]
    }
}

The following shows an example of a response body that captures the activity log for a scale out operation.

{
    "actLog":
    {
        "activityLogId":17,
        "serviceId":202,
        "operation":
        {
            "operationId":202,
            "operationType":"SCALE_OUT"
        },
        "status":"SUCCEED",
        "startDate":"Apr 9, 2015 8:35:44 PM",
        "endDate":"Apr 9, 2015 9:05:25 PM",
        "identityDomain":"ExampleIdentityDomain",
        "serviceName":"ExampleInstance",
        "hostName":"exampleinstance-wls-4",
        "serverName":"ExampleI_server_4",
        "serverType":null,
        "jobId":4010,
        "messages":[
        {
            "activityMessageId":1532,
            "activityDate":"Apr 9, 2015 8:35:44 PM",
            "stepName":"NEW",
            "message":"Submitted Job, Status\u003dInProgress"
        },
        {
            "activityMessageId":1533,
            "activityDate":"Apr 9,2015 8:35:44 PM",
            "stepName":"RUNNING",
            "message":"initializing"},
        {
            "activityMessageId":1534,
            "activityDate":"Apr 9, 2015 8:35:44 PM",
            "stepName":"RUNNING",
            "message":"Scaling job for service [ExampleInstance] in cluster [ExampleI_cluster] with factor [1] is prepared."
        },
        {
            "activityMessageId":1535,
            "activityDate":"Apr 9, 2015 8:35:46 PM",
            "stepName":"RUNNING",
            "message":"SOACS-SCALING-161: Completed submitting config lock script on service [ExampleInstance]"
        },        
        {
            "activityMessageId":1536,
            "activityDate":"Apr 9, 2015 8:36:50 PM",
            "stepName":"RUNNING",
            "message":"SOACS-SCALING-173: Checking for config lock is completed for service [ExampleInstance]"
        },
        {
            "activityMessageId":1537,
            "activityDate":"Apr 9, 2015 8:36:50 PM",
            "stepName":"RUNNING",
            "message":"SOACS-SCALING-119: Completed creating the backup child job for service [ExampleInstance]"
        },
        {
            "activityMessageId":1538,
            "activityDate":"Apr 9, 2015 8:37:56 PM",
            "stepName":"RUNNING",
            "message":"SOACS-SCALING-122: Completed creating the backup for service [ExampleInstance]"
        },
        {
            "activityMessageId":1540,
            "activityDate":"Apr 9, 2015 8:38:03 PM",
            "stepName":"RUNNING",
            "message":"New Managed Server name is [ExampleI_server_4]"
        },
        {
            "activityMessageId":1539,
            "activityDate":"Apr 9, 2015 8:38:03 PM",
            "stepName":"RUNNING",
            "message":"Created the required storage and compute configurations for WebLogic Server managed server [ExampleI_server_4]..."
        },
        {
            "activityMessageId":1541,
            "activityDate":"Apr 9, 2015 8:38:03 PM",
            "stepName":"RUNNING",
            "message":"SOACS-SCALING-129: Completed submitting child job for checking VM provisioning and health"
        },
        {
            "activityMessageId":1542,
            "activityDate":"Apr 9, 2015 9:00:35 PM",
            "stepName":"RUNNING",
            "message":"Started the required compute resources for WebLogic Server managed server [ExampleI_server_4]..."
        },
        {
            "activityMessageId":1543,
            "activityDate":"Apr 9, 2015 9:00:35 PM",
            "stepName":"RUNNING",
            "message":"Orchestration is in ready state, new VM is up for server [ExampleI_server_4]"
        },
        {
            "activityMessageId":1544,
            "activityDate":"Apr 9, 2015 9:00:35 PM",
            "stepName":"RUNNING",
            "message":"Completed submitting child job for checking managed server configuration "
        },
        {
            "activityMessageId":1545,
            "activityDate":"Apr 9, 2015 9:05:13 PM",
            "stepName":"RUNNING",
            "message":"Configured WebLogic Server managed server [ExampleI_server_4]..."
        },
        {
            "activityMessageId":1547,
            "activityDate":"Apr 9, 2015 9:05:25 PM",
            "stepName":"RUNNING",
            "message":"Scale out for service [ExampleInstance] succeeded"
        },
        {
            "activityMessageId":1546,
            "activityDate":"Apr 9, 2015 9:05:25 PM",
            "stepName":"RUNNING",
            "message":"Started WebLogic Server managed server [ExampleI_server_4]..."
        },
        {
            "activityMessageId":1548,
            "activityDate":"Apr 9, 2015 9:05:25 PM",
            "stepName":"RUNNING",
            "message":"Completed submitting OTD script for remote execution on service [ExampleInstance]"
        },
        {
            "activityMessageId":1549,
            "activityDate":"Apr 9, 2015 9:05:25 PM",
            "stepName":"SUCCEED",
            "message":"SOACS-SCALING-095: Service [ExampleInstance] is not provisioned with OTD, hence notifying OTD with server [ExampleI_server_4] is bypassed"
        },
        {
            "activityMessageId":1550,
            "activityDate":"Apr 9, 2015 9:05:25 PM",
            "stepName":"RUNNING",
            "message":"Service [ExampleInstance] is not provisioned with OTD, hence notifying OTD with server [ExampleI_server_4] is bypassed"
        },
        {
            "activityMessageId":1551,
            "activityDate":"Apr 9, 2015 9:05:25 PM",
            "stepName":"SUCCEED",
            "message":"addServerToOTDVerify"
        }
    ]},"messages":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}
]}