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

Get Provisioned Instances

get

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

Retrieves all provisioned instances.

Request

Path Parameters

identityId: Type: string

Required: true

Name of the identity domain for the Oracle Cloud Service account.

Query Parameters

status

Type: string

Required: true

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

Allowed Values


[
    "Provisioning Not Started",
    "Running",
    "In Progress",
    "Terminating",
    "Failed"
]

Response

Supported Media Types

application/json
text/html

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 information about all Oracle SOA Cloud Service instances by submitting a GET request on the REST resource using cURL. 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

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 14:28:33 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following shows an example of the response body in JSON format. In this example, there are two service instances, My12cServer that is running 12c and My11gServer that is running 11g. Verbose output is not enabled.

{
"uri":"https:\/\/api-host/\/paas\/service\/soa\/api\/v1.1\/instances\/yourIdentityDomain",
"service_type":"soacs",
"implementation_version":"1.0",
"services" : [
    {
        "service_name":"My12cServer",
        "version":"12cR3",
        "wlsVersion":"12.1.3.0.4",
        "status":"Running",
        "error_status_desc": "",
        "compliance_status": "",
        "compliance_status_desc": "",
        "auto_update": "true",
        "description":"WebLogicEnterprise",
        "identity_domain":"ExampleIdentityDomain",
        "creation_time":"Wed Jul 23 15:36:57 GMT 2014",
        "last_modified_time":"Thu Jul 24 09:15:57 GMT 2014",
        "created_by":"joe@example.com",
        "service_uri":"https:\/\/api-host/\/paas\/service\/soa\/api\/v1.1\/instances\/yourIdentityDomain\/My12cServer"    
    },
    {
        "service_name":"My11gServer",
        "version":"11g",
        "wlsVersion":"10.3.6.0.9",
        "status":"Running",
        "description":"",
        "identity_domain":"ExampleIdentityDomain",
        "creation_time":"Tue Jul 22 18:11:41 GMT 2014",
        "last_modified_time":"Wed Jul 23 00:35:11 GMT 2014",
        "created_by":"joe@example.com",
        "service_uri":"https:\/\/api-host/\/paas\/service\/soa\/api\/v1.1\/instances\/yourIdentityDomain\/My11gServer"    
     }
]}

The following shows an example of the response body in JSON format with verbose output enabled.

{
"uri":"https:\/\/api-host/\/paas/\service\/soa\/api\/v1.1\/instances\/yourIdentityDomain?outputLevel=verbose",
"service_type":"soacs",
"implementation_version":"1.0",
"services" : [
    {
        "service_name":"My12cServer",
        "version":"12cR3",
        "wlsVersion":"12.1.3.0.4",
        "status":"Running",
        "error_status_desc": "",
        "compliance_status": "",
        "compliance_status_desc": "",
        "auto_update": "true",
        "description":"WebLogicEnterprise",
        "identity_domain":"ExampleIdentityDomain",
        "creation_time":"Wed Jul 23 15:36:57 GMT 2014",
        "last_modified_time":"Thu Jul 24 09:15:57 GMT 2014",
        "created_by":"joe@example.com",
        "service_uri":"https:\/\/api-host/\/paas\/service\/soa\/api\/v1.1\/instances\/yourIdentityDomain\/My12cServer",
        "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": "JDK",
                "version": "1.7.0_76"
            },
            {
                "type": "OTD_JDK",
                "version": "1.7.0_76"
            },
            {
                "type": "OTD",
                "version": "11.1.1.7.0"
            },
            {
                "type": "WLS",
                "version": "12.1.3.0.4"
            }
        ],
        "creation_job_id" : "1",
        "deletion_job_id" : "0",
        "lifecycle_control_job_id": 273,
        "db_info" : "myDB:1521\/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",
        "content_url" : "https:\/\/192.0.4.5:8080",
        "wls_deployment_channel_port": 9001,
        "psm_plugin_version": "15.3.3-0-1507110315"   
    },
    {
        "service_name":"My11gServer",
        "version":"11g",
        "wlsVersion":"10.3.6.0.9",
        "status":"Running",
        "description":"",
        "identity_domain":"ExampleIdentityDomain",
        "creation_time":"Tue Jul 22 18:11:41 GMT 2014",
        "last_modified_time":"Wed Jul 23 00:35:11 GMT 2014",
        "created_by":"joe@example.com",
        "service_uri":"https:\/\/api-host/\/paas\/service\/soa\/api\/v1.1\/instances\/yourIdentityDomain\/My11gServer" ,        
        "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": "JDK",
                "version": "1.7.0_76"
            },
            {
                "type": "OTD_JDK",
                "version": "1.7.0_76"
            },
            {
                "type": "OTD",
                "version": "11.1.1.7.0"
            },
            {
                "type": "WLS",
                "version": "12.1.3.0.4"
            }
        ],
        "creation_job_id" : "1",
        "deletion_job_id" : "0",
        "lifecycle_control_job_id": 236,
        "db_info" : "myDB:1521\/PDB1.exampleidentitydomain",
        "db_service_name" : "myDBService", 
        "num_ip_reservations" : 3,
        "wls_admin_url" : "https:\/\/192.1.2.0:7002\/console",
        "fmw_control_url" : "https:\/\/192.1.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.1.2.3:8081",
        "content_url" : "https:\/\/192.1.4.5:8080",
        "wls_deployment_channel_port": 9001,
        "psm_plugin_version": "15.3.3-0-1507110315"  
   }
]}