1. REST API for Oracle SOA Cloud Service on Oracle Public Cloud Machine
  2. Tasks
  3. Manage Services

View a Service Instance

get

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

Returns information about a service instance.

Request

Path Parameters
identityId
Type: string
Required: true
Name of the identity domain for the Oracle Cloud Service account.
serviceId
Type: string
Required: true
ID of the service instance.

Response

Supported Media Types
  • application/json
200 Response
success
Body
Root Schema : GetInstanceInfoResponse
Type: object

Examples

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

See also Exploring the Oracle SOA Cloud Service Instance Overview Page.

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/ExampleInstance
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: Fri, 22 Aug 2014 20:37:06 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

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

{
    "service_name" : "ExampleInstance",
    "version" : "12cR3",
    "wlsVersion" : "12.1.3.0.4",
    "status" : "Running",
    "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",
    "domain_name" : "ExampleDomain",
    "domain_mode" : "PRODUCTION",
    "cluster_name" : "ExampleCluster",
    "num_nodes" : 3,
    "level" : "PAAS",
    "subscription_type" : "HOURLY",
    "edition" : "EE",
    "shape" : "oc3m",
    "otd_provisioned" : "yes",
    "otd_shape" : "oc3",
    "otd_storage_size": 43008,
    "service_components": [
       {
            "type": "WLS",
            "version": "12.1.3.0.4"
        },
        {
            "type": "OTD_JDK",
            "version": "1.7.0_80"
        },
        {
            "type": "OTD",
            "version": "11.1.1.9.0"
        },
        {
            "type": "JDK",
            "version": "1.7.0_80"
        }
    ],
    "creation_job_id" : "1",
    "deletion_job_id" : 0,
    "lifecycle_control_job_id" : 273,
    "db_info" : "myDBService:111\/PDB1.exampleidentitydomain",
    "db_service_name" : "myDBService", 
    "num_ip_reservations" : 3,
    "wls_admin_url" : "https:\/\/192.0.2.0:7002\/console",
    "fmw_control_url" : "https:\/\/192.0.2.16:7002\/em",
    "otd_admin_url" : "https:\/\/192.0.2.23:8989",
    "sample_app_url": "https:\/\/192.1.2.3\/sample-app\/",
    "secure_content_url" : "https:\/\/192.0.2.3:8081",
    "wls_deployment_channel_port": 9001, 
    "psm_plugin_version": "15.3.3-0-1507110315"
}