1. REST API for Managing Oracle Integration Classic (User-Managed)
  2. Tasks
  3. Service Instances

View a Service Instance

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}

Returns information about an Oracle Integration Classic instance.

Request

Path Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
The response body contains information about the specified Oracle Integration Classic instance.
Root Schema : instance-response
Type: object
The response body contains information about the specified Oracle Integration Classic instance.
Show Source
Nested Schema : activityLogs
Type: array
Activity logs for the service instance.
Show Source
Nested Schema : attributes
Type: object
Show Source
Nested Schema : service_components
Type: array
Groups service component details.
Show Source
Nested Schema : items
Type: object
Activity logs.
Show Source
Nested Schema : messages
Type: array
Messages related to the activity.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : BACKUP_DESTINATION
Type: object
Show Source
Nested Schema : FMW_ROOT
Type: object
Show Source
Nested Schema : icsEdition
Type: object
Show Source
Nested Schema : icsFeatureSet
Type: object
Show Source
Nested Schema : instanceHomePageUrl
Type: object
Show Source
Nested Schema : jdkVersion
Type: object
Show Source
Nested Schema : WLS_ROOT
Type: object
Show Source
Nested Schema : service_components
Type: object
Show Source
Back to Top

Examples

The following example shows how to view details of a Integration Cloud service Instance by submitting a GET request on the REST resource using cURL .

cURL Command

https://example.com/paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}

Example of Response Body

{
    "serviceId": "0",
    "serviceUuid": "C6C585C5E2484F5EA286457D499DEFF4",
    "serviceLogicalUuid": "75D6DD37EFD14468BA109170F47681BC",
    "serviceName": "host44",
    "serviceType": "ICS",
    "domainName": "idcs",
    "serviceVersion": "1.0",
    "releaseVersion": "17.4.1.170913.0535-489",
    "baseReleaseVersion": "12.2.1.2.170711",
    "metaVersion": "17.4.1-1709131927",
    "serviceLevel": "PAAS",
    "subscription": "HOURLY",
    "meteringFrequency": "HOURLY",
    "edition": "EE",
    "totalSSDStorage": 0,
    "storageContainer": "Storage-hapapate/JaaSBackup",
    "state": "TERMINATING",
    "serviceStateDisplayName": "Terminating Service ...",
    "clone": false,
    "creator": "test_user",
    "creationDate": "2017-09-15T14:41:02.646+0000",
    "isBYOL": false,
    "isManaged": false,
    "iaasProvider": "NIMBULA",
    "attributes": {
        "SAMPLE_ROOT": {
            "displayName": "Open Sample Application",
            "type": "STRING",
            "value": " ",
            "displayValue": " ",
            "isKeyBinding": false
        },
        "icsFeatureSet": {
            "displayName": "Feature Set",
            "type": "STRING",
            "value": "ics_pcs",
            "displayValue": "Integration and Process",
            "isKeyBinding": false
        },
        "jdkVersion": {
            "displayName": "JDK",
            "type": "STRING",
            "value": " ",
            "displayValue": " ",
            "isKeyBinding": false
        },
        "icsEdition": {
            "displayName": "Integration Cloud Edition",
            "type": "STRING",
            "value": "EE",
            "displayValue": "Enterprise Edition",
            "isKeyBinding": false
        },
        "instanceHomePageUrl": {
            "displayName": "Open Integration Cloud Home Page",
            "type": "URL",
            "value": "https://host44-example.com:443/ic/home",
            "displayValue": "https://host44-example.com:443/ic/home",
            "isKeyBinding": false
        },
        "serviceId": {
            "displayName": "Service Identifier",
            "type": "INTEGER",
            "value": "0",
            "displayValue": "0",
            "isKeyBinding": false
        },
        "BACKUP_DESTINATION": {
            "displayName": "Backup Destination",
            "type": "STRING",
            "value": "BOTH",
            "displayValue": "BOTH",
            "isKeyBinding": false
        }
    },
    "tags": {
        "items": [],
        "totalResults": 0,
        "hasMore": false
    },
    "components": {
        "WLS": {
            "serviceId": 31492,
            "componentId": 30968,
            "state": "INITIALIZING",
            "componentStateDisplayName": "Starting ...",
            "version": "12.2.1.2",
            "componentType": "WLS",
            "creationDate": "2017-09-15T14:41:02.000+0000",
            "instanceName": "WLS",
            "instanceRole": "NONE",
            "isKeyComponent": true,
            "attributes": {},
            "vmInstances": {
                "host44-wls-1": {
                    "vmId": 37858,
                    "id": 37858,
                    "uuid": "62FC14D85C25453CB4C2F1CDDEC142E6",
                    "hostName": "host44-wls-1",
                    "label": "host44 wls 1",
                    "ipAddress": "10.252.156.136",
                    "publicIpAddress": "10.252.156.136",
                    "usageType": "ADMIN_SERVER",
                    "role": "ADMIN_SERVER",
                    "componentType": "WLS",
                    "state": "INITIALIZING",
                    "vmStateDisplayName": "Starting ...",
                    "shapeId": "oc1m",
                    "totalStorage": 136192,
                    "creationDate": "2017-09-15T17:28:56.000+0000",
                    "isAdminNode": true
                },
                "host44-wls-2": {
                    "vmId": 37859,
                    "id": 37859,
                    "uuid": "947DCE5ECC1C40E5A60412806318F5EB",
                    "hostName": "host44-wls-2",
                    "label": "host44 wls 2",
                    "ipAddress": "10.252.156.22",
                    "publicIpAddress": "10.252.156.22",
                    "usageType": "MANAGED_SERVER",
                    "role": "MANAGED_SERVER",
                    "componentType": "WLS",
                    "state": "INITIALIZING",
                    "vmStateDisplayName": "Starting ...",
                    "shapeId": "oc1m",
                    "totalStorage": 115712,
                    "creationDate": "2017-09-15T17:28:57.000+0000",
                    "isAdminNode": false
                }
            },
            "adminHostName": "host44-wls-1",
            "hosts": {
                "userHosts": {
                    "host44-wls-1": {
                        "vmId": 37858,
                        "id": 37858,
                        "uuid": "62FC14D85C25453CB4C2F1CDDEC142E6",
                        "hostName": "host44-wls-1",
                        "label": "host44 wls 1",
                        "ipAddress": "10.252.156.136",
                        "publicIpAddress": "10.252.156.136",
                        "usageType": "ADMIN_SERVER",
                        "role": "ADMIN_SERVER",
                        "componentType": "WLS",
                        "state": "INITIALIZING",
                        "vmStateDisplayName": "Starting ...",
                        "shapeId": "oc1m",
                        "totalStorage": 136192,
                        "creationDate": "2017-09-15T17:28:56.000+0000",
                        "isAdminNode": true,
                        "servers": {
                            "ic_adminserver": {
                                "serverId": 20593,
                                "serverName": "ic_adminserver",
                                "serverType": "WLS",
                                "serverRole": "ADMIN",
                                "state": "READY",
                                "serverStateDisplayName": "Ready",
                                "creationDate": "2017-09-15T17:28:56.000+0000"
                            },
                            "ic_server_1": {
                                "serverId": 20592,
                                "serverName": "ic_server_1",
                                "serverType": "WLS",
                                "serverRole": "MANAGED",
                                "state": "READY",
                                "serverStateDisplayName": "Ready",
                                "creationDate": "2017-09-15T17:28:56.000+0000"
                            }
                        }
                    },
                    "host44-wls-2": {
                        "vmId": 37859,
                        "id": 37859,
                        "uuid": "947DCE5ECC1C40E5A60412806318F5EB",
                        "hostName": "host44-wls-2",
                        "label": "host44 wls 2",
                        "ipAddress": "10.252.156.22",
                        "publicIpAddress": "10.252.156.22",
                        "usageType": "MANAGED_SERVER",
                        "role": "MANAGED_SERVER",
                        "componentType": "WLS",
                        "state": "INITIALIZING",
                        "vmStateDisplayName": "Starting ...",
                        "shapeId": "oc1m",
                        "totalStorage": 115712,
                        "creationDate": "2017-09-15T17:28:57.000+0000",
                        "isAdminNode": false,
                        "servers": {
                            "ic_server_2": {
                                "serverId": 20594,
                                "serverName": "ic_server_2",
                                "serverType": "WLS",
                                "serverRole": "MANAGED",
                                "state": "READY",
                                "serverStateDisplayName": "Ready",
                                "creationDate": "2017-09-15T17:28:57.000+0000"
                            }
                        }
                    }
                }
            },
            "paasServers": {},
            "clusters": {
                "ic_cluster": {
                    "clusterId": 31492,
                    "clusterName": "ic_cluster",
                    "clusterType": "PAAS",
                    "profile": "{\"external\":true, \"type\":\"APPLICATION_CLUSTER\", \"clusterType\":\"APPLICATION_CLUSTER\",\"default\": true}",
                    "creationDate": "2017-09-15T14:41:02.910+0000",
                    "paasServers": {
                        "ic_server_2": {
                            "serverId": 20594,
                            "serverName": "ic_server_2",
                            "serverType": "WLS",
                            "serverRole": "MANAGED",
                            "state": "READY",
                            "serverStateDisplayName": "Ready",
                            "creationDate": "2017-09-15T17:28:57.000+0000"
                        },
                        "ic_server_1": {
                            "serverId": 20592,
                            "serverName": "ic_server_1",
                            "serverType": "WLS",
                            "serverRole": "MANAGED",
                            "state": "READY",
                            "serverStateDisplayName": "Ready",
                            "creationDate": "2017-09-15T17:28:56.000+0000"
                        }
                    }
                }
            },
            "displayName": "Weblogic"
        }
    },
    "activityLogs": [
        {
            "activityLogId": 3028695,
            "serviceName": "host44",
            "serviceType": "ics",
            "identityDomain": "idcs",
            "serviceId": 31492,
            "jobId": 2060462,
            "startDate": "2017-09-15T14:41:02.909+0000",
            "status": "RUNNING",
            "operationId": 31492,
            "operationType": "CREATE_SERVICE",
            "summaryMessage": "CREATE_SERVICE",
            "authDomain": "idcs",
            "authUser": "test-user",
            "initiatedBy": "USER",
            "messages": [
                {
                    "activityDate": "2017-09-15T14:41:02.909+0000",
                    "message": "Activity Submitted"
                },
                {
                    "activityDate": "2017-09-15T14:41:05.839+0000",
                    "message": "Activity Started"
                },
                {
                    "activityDate": "2017-09-15T14:41:06.019+0000",
                    "message": "Started pre-check for load balancer configuration for service [host44]."
                },
                {
                    "activityDate": "2017-09-15T14:51:56.925+0000",
                    "message": "Established SSH connectivity to WebLogic Administration Server... Used private side of a public key for [oracle]"
                },
                {
                    "activityDate": "2017-09-15T14:53:06.442+0000",
                    "message": "Established SSH connectivity to Host(s) [ic_server_2] from Administration Server..."
                },
                {
                    "activityDate": "2017-09-15T15:06:36.082+0000",
                    "message": "WebLogic Administration Server Configuration completed..."
                },
                {
                    "activityDate": "2017-09-15T15:06:36.239+0000",
                    "message": "Configuration check for Host [host44-wls-1] containing WebLogic Managed Server(s) [[ic_server_1]] completed..."
                },
                {
                    "activityDate": "2017-09-15T15:08:42.268+0000",
                    "message": "Started load balancer configuration for service [host44]."
                },
                {
                    "activityDate": "2017-09-15T15:46:51.753+0000",
                    "message": "Timed out after waiting 30 minutes to complete load balancer configuration. LBaaS Error: Request Id [CREATE_ORIGIN_SERVER_POOL_c1892b0c-d7e7-4e9d-bb84-c5c5206a21a3] of [31492-1505488122425:ospool-1505488133721] failed. Please contact Oracle Cloud Support"
                },
                {
                    "activityDate": "2017-09-15T15:46:52.069+0000",
                    "message": "Service provisioning attempt 1 (out of 2) has failed."
                },
                {
                    "activityDate": "2017-09-15T15:46:57.381+0000",
                    "message": "Cleaning up resources before retrying to provision the Service..."
                },
                {
                    "activityDate": "2017-09-15T15:46:57.509+0000",
                    "message": "Pre-check for IDCS Service Footprint creation started for service [host44]."
                },
                {
                    "activityDate": "2017-09-15T15:46:57.511+0000",
                    "message": "Started pre-check for load balancer configuration for service [host44]."
                },
                {
                    "activityDate": "2017-09-15T15:46:57.637+0000",
                    "message": "Pre-check for IDCS Service Footprint creation completed for service [host44]."
                },
                {
                    "activityDate": "2017-09-15T15:46:58.184+0000",
                    "message": "Completed pre-check for load balancer configuration for service [host44]."
                },
                {
                    "activityDate": "2017-09-15T15:46:58.380+0000",
                    "message": "Started load balancer configuration update for service [host44]."
                },
                {
                    "activityDate": "2017-09-15T16:28:25.968+0000",
                    "message": "Timed out after waiting 29 minutes to complete load balancer configuration. LBaaS Error: Request Id [DELETE_VLBR_debfcd7e-9f8a-44f5-9c43-fd87737233a3] of [31492-1505488122425] failed. Please contact Oracle Cloud Support"
                },
                {
                    "activityDate": "2017-09-15T16:28:26.032+0000",
                    "message": "Registered load balancer resources for clean up."
                },
                {
                    "activityDate": "2017-09-15T16:28:31.734+0000",
                    "message": "Service record (WebLogic) removal complete..."
                },
                {
                    "activityDate": "2017-09-15T17:28:44.163+0000",
                    "message": "Activity Started"
                },
                {
                    "activityDate": "2017-09-15T17:28:58.217+0000",
                    "message": "Created Compute resources for WebLogic Server..."
                },
                {
                    "activityDate": "2017-09-15T17:29:00.224+0000",
                    "message": "Created security resources for the service..."
                },
                {
                    "activityDate": "2017-09-15T17:55:20.730+0000",
                    "message": "Configuration check for Host [host44-wls-2] containing WebLogic Managed Server(s) [[ic_server_2]] completed..."
                },
                {
                    "activityDate": "2017-09-15T17:55:20.919+0000",
                    "message": "WebLogic Managed Servers Configuration completed..."
                },
                {
                    "activityDate": "2017-09-15T17:56:09.567+0000",
                    "message": "Service Reachabilty Check (SRC) of WebLogic Administration Server completed..."
                },
                {
                    "activityDate": "2017-09-15T17:56:23.589+0000",
                    "message": "Service Reachabilty Check (SRC) of WebLogic Managed Server(s) [ic_server_1, ic_server_2] completed..."
                },
                {
                    "activityDate": "2017-09-15T17:56:23.735+0000",
                    "message": "Successfully provisioned WebLogic Administration Server and 2 Managed Servers..."
                },
                {
                    "activityDate": "2017-09-15T17:56:24.097+0000",
                    "message": "Started load balancer configuration for service [host44]."
                },
                {
                    "activityDate": "2017-09-15T17:56:39.495+0000",
                    "message": "Unable to complete load balancer configuration. Earlier attempt to clean up load balance resources is not complete. Please try again or use a different service name."
                },
                {
                    "activityDate": "2017-09-15T17:56:39.776+0000",
                    "message": "Service provisioning attempt 2 (out of 2) has failed."
                },
                {
                    "activityDate": "2017-09-15T17:56:40.732+0000",
                    "message": "Unable to provision the service.  Hence rolling back..."
                },
                {
                    "activityDate": "2017-09-15T17:56:40.873+0000",
                    "message": "Started pre-check for load balancer configuration for service [host44]."
                },
                {
                    "activityDate": "2017-09-15T17:58:17.809+0000",
                    "message": "Warning, failed to shutdown Weblogic domain ..."
                },
                {
                    "activityDate": "2017-09-15T18:08:15.517+0000",
                    "message": "Started deletion of load balancer configuration for service [host44]."
                },
                {
                    "activityDate": "2017-09-15T18:08:17.643+0000",
                    "message": "Unable to complete load balancer configuration. LBaaS Error: Cannot process request. Please contact Oracle Cloud Support"
                }
            ]
        }
    ],
    "idcs": {
        "customer": {
            "appID": "e8641c2ee70d45629e44f6323d385271",
            "appDisplayName": "75D6DD37EFD14468BA109170F47681BC",
            "appName": "75D6DD37EFD14468BA109170F47681BC_APPID",
            "appURL": "https://idcs.identity.example.com:443/ui/v1/adminconsole/?root=apps=e8641c2ee70d45629e44f6323d385271"
        }
    },
    "layeringMode": "Single",
    "serviceLevelDisplayName": "Oracle Java Cloud Service",
    "editionDisplayName": "Enterprise Edition",
    "meteringFrequencyDisplayName": "Hourly",
    "SAMPLE_ROOT": " ",
    "iscsStorageFolder": "17.4.1.1709131927",
    "identityTenancy": "StandardJCS",
    "instanceFriendlyPublicUrl": "https://host44-example.com:443",
    "PSM_IDENTITY_FOOTPRINT_CUSTOMER": "e8641c2ee70d45629e44f6323d385271",
    "instancePermanentPublicUrl": "https://example.com:443",
    "vbcsHomePageUrl": "https://host44-example.com:443/ic/builder",
    "cloudStorageContainer": "Storage-hapapate/JaaSBackup",
    "enableProxy": "false",
    "proxyHost": "opc-dev-proxy.usdv1.oraclecloud.com",
    "icsFeatureSet": "ics_pcs",
    "icsManagedServerCountInitial": "2",
    "icsEdition": "EE",
    "pubcdtTopology": "ics_pcs",
    "PSM_IDENTITY_FOOTPRINT_PROVIDER": "69a9ae3ff6f741d7b14e1b60f0e219f1",
    "pdbServiceName": "null",
    "BACKUP_DESTINATION": "BOTH",
    "instanceHomePageUrl": "https://host44-example.com:443/ic/home",
    "jdkVersion": " ",
    "enableAdminConsoles": "false",
    "dbaUserName": "SYS",
    "cloudStorageUser": "Storageadmin",
    "jaasSupportHome": "null",
    "proxyPort": "80",
    "pubcdtServiceName": "integration_suite",
    "totalSharedStorage": 0,
    "allAssociations": {
        "toAssociations": [
            {
                "associationId": 23141,
                "displayName": "INFRA_DB",
                "associationType": "DEPENDS_ON",
                "associationName": "INFRA_DB",
                "associationState": "READY",
                "assocStatusMessage": "newly created",
                "isRequired": true,
                "creationDate": "2017-09-15T14:41:02.000+0000",
                "domain": "idcs",
                "serviceType": "DBaaS",
                "serviceName": "OICDBaaS",
                "serviceStatus": "READY",
                "serviceStateDisplayName": "Ready",
                "edition": "EE",
                "version": "12.1.0.2",
                "level": "PAAS",
                "ocpu": 2,
                "associationStateDisplayName": "Ready",
                "assocTypeDisplayName": "Depends On",
                "assocTypeDescription": "Service A depends on Resource B/Service B."
            }
        ],
        "fromAssociations": []
    },
    "computeSiteName": "oice2wsite",
    "patching": {
        "currentOperation": {
            "operation": "NONE"
        },
        "updateStatus": "NORMAL_PENDING",
        "totalAvailablePatches": 2
    },
    "loadBalancer": {
        "PUBLIC": {
            "urls": [],
            "permanentUrls": [],
            "loadBalancerAdminUrl": "https://example.com/vlbrs/uscom-central-1/31492-1505498184264"
        }
    }
}
Back to Top