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

Get Service Provisioning Status

get

/api/v1.1/instances/{identityId}/status/{operation}/job/{jobId}

Returns the instance provisioning status.

Request

Path Parameters

identityId: Type: string

Required: true

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

Required: true

Job ID of the provisioning operation.
operation: Type: string

Required: true

Name of the provisioning operation.

Response

Supported Media Types

application/json

200 Response

success

Body

Root Schema : GetInstanceInfoResponse

Type: object

Properties

created_by

Type: string

Name of the user account used to create the Oracle SOA Cloud Service instance.

creation_job_id

Type: boolean

Default Value: false

Job ID for the create job.

creation_time

Type: string

Date and time the Oracle SOA Service instance was created.

description

Type: string

Free-form text that provides additional information about the service instance.

identity_domain

Type: string

Identity domain name.

last_modified_time

Type: string

Date and time the Oracle SOA Service instance was last modified.

resource_count

Type: string

Number of resources in the Stack Service Instance.

resources

Type: string

The details of the individual resources in the SOA Service Instance.

service_id

Type: string

Globally unique identifier for an Oracle SOA Service Instance.

service_type

Type: string

The type of the service. Valid values include:

osb - Oracle Service Bus Topology.
soa - Service Oriented Architecture.
soaosb - Both OSB and SOA Topology.
b2b - Both B2B (Business to Business) and SOA Topology.
mft - MFT (Managed File Transfer) Topology.
insight - Oracle Business Insight (Business Activity Monitoring) Topology.

service_uri

Type: string

Resource URL for the Oracle SOA Service instance.

serviceName

Type: string

Name of the Oracle SOA Service Instance.

status

Type: string

Flag that specifies the status of the Oracle SOA Service instance. Valid values include: Provisioning Not Started, Running, In Progress, Terminating, and Failed.

Examples

The following example shows how to view the status of an Oracle SOA Cloud Service instance create operation by submitting a GET request on the REST resource using cURL. The REST resource URI is returned in the Location header when submitting the create service instance request, as described in Provision a New Service Instance. For more information, see Use cURL.

cURL Command

curl -i -X GET -u joe@example.com:Welcome1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://api-host/paas/service/soa/api/v1.1/instances/ExampleIdentityDomain/status/create/job/7495

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: Thu, 29 Jan 2015 21:38:18 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response, including the status messages:

{
  "service_name": "ExampleInstance",
  "version": "12cR3",
  "wlsVersion": "12.1.3.0.4",
  "status": "In Progress",
  "error_status_desc": "",
  "compliance_status": "",
  "compliance_status_desc": "",
  "auto_update": "true",
  "description": "Example, Inc product distribution",
  "identity_domain": "ExampleIdentityDomain",
  "creation_time": "Fri Jan 23 22:18:26 UTC 2015",
  "last_modified_time": "Fri Jan 23 22:18:26 UTC 2015",
  "created_by": "joe@example.com",
  "service_uri" : "https:\/\/api-host\/paas\/service\/soa\/api\/v1.1\/instances\/ExampleIdentityDomain\/ExampleInstance",
  "message": [
    "Created Compute resources for WebLogic Server...",
    "Created security resources for the service...",
    "Started all Compute resources...",
    "Established SSH connectivity to WebLogic Administration Server...",
    "WebLogic Administration Server Configuration completed...",
    "WebLogic Managed Servers Configuration completed...",
    "    Configuration check for Host [exampleinstance-wls-1] containing WebLogic Managed Server(s) [[ExampleI_server_1]] completed...",
    "Successfully provisioned WebLogic Administration Server and 1 Managed Servers...",
    "    Service Reachabilty Check (SRC) of WebLogic Administration Server completed...",
    "    Service Reachabilty Check (SRC) of WebLogic Managed Server(s) [ExampleI_server_1] completed...",
    "Established SSH connectivity to Load Balancer...",
    "Configured Load Balancer...",
    "Performing Service Reachability Check (SRC) of Load Balancer...",
    "Service Reachabilty Check (SRC) of Load Balancer completed..."  ]
}