View All Service Instances
get
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/SOA/instances
Returns information about all Oracle SOA Cloud Service instances.
Request
Path Parameters
-
identityDomainId: string
Identity domain ID for the Oracle SOA Cloud Service account.
Header Parameters
-
X-ID-TENANT-NAME: string
Identity domain ID for the Oracle SOA Cloud Service account.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : allinstances-allresponsem
Type:
objectThe response body contains information about all Oracle SOA Cloud Service instances in the identity domain.
Show Source
-
services:
object services
Groups details about all service instances by service name. Each service instance is a JSON object element.
Nested Schema : services
Type:
objectGroups details about all service instances by service name. Each service instance is a JSON object element.
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.
Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain (or Cloud account). See Send Requests.
cURL Command
curl -i -X GET -u username:userPassword1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/SOA/instances
Example of Response Header
The following example shows the response header.
HTTP/1.1 200 OK
Date: Fri, 23 Jun 2019 17:36:15 GMT
Transfer-Encoding: chunked
Content-Type: application/json
Example of Response Body
The following example shows the response body returned in JSON format. Your output will differ depending on your service instance configuration and Oracle SOA Cloud Service release.
{
"services":
{
"ExampleInstance":
{
"serviceId":811,
"serviceName":"ExampleInstance",
"serviceType":"SOA",
"domainName":"ExampleIdentityDomain",
"serviceVersion":"12cRelease213",
"releaseVersion":"12.2.1.3.170326",
"baseReleaseVersion":"12.2.1.3.170326",
"metaVersion":"17.2.5-1705080232",
"serviceDescription":"ExampleInstance",
"serviceLevel":"PAAS",
"subscription":"HOURLY",
"meteringFrequency":"HOURLY",
"edition":"EE",
"totalSSDStorage":0,
"storageContainer":"Storage-ExampleIdentityDomain\/MySOABackup",
"state":"READY",
"clone":false,
"creator":"yourusename",
"creationDate":"2019-05-16T17:06:39.405+0000",
"isManaged":false,
"keyComponentInstance":"WLS",
"adminHostName":"exampleinstance-wls-1",
"attributes":{},
"components":
{
"WLS":
{
"serviceId":811,
"componentId":1613,
"state":"READY",
"version":"12.2.1.3",
"componentType":"WLS",
"creationDate":"2019-05-16T17:06:39.000+0000",
"instanceName":"WLS",
"instanceRole":"NONE",
"isKeyComponent":true,
"attributes":{},
"vmInstances":
{
"exampleinstance-wls-1":
{
"vmId":2312,
"id":2312,
"uuid":"A8D91E3181A646C6BA0353C9F0ED435C",
"hostName":"exampleinstance-wls-1",
"label":"ExampleInstance wls 1",
"ipAddress":"1x.xxx.xx.x3",
"publicIpAddress":"1x.xxx.xxx.x3",
"usageType":"ADMIN_SERVER",
"role":"ADMIN_SERVER",
"componentType":"WLS",
"state":"READY",
"shapeId":"oc3",
"totalStorage":254976,
"creationDate":"2019-05-16T17:06:46.000+0000",
"isAdminNode":true,
"servers":
{
"ExampleI_server_1":
{
"serverId":2309,
"serverName":"ExampleI_server_1",
"serverType":"WLS",
"serverRole":"MANAGED",
"state":"READY",
"creationDate":"2019-05-16T17:06:46.000+0000",
"isPermanent":false,
"serverStateDisplayName":"Ready"
},
"ExampleI_adminserver":
{
"serverId":2310,
"serverName":"ExampleI_adminserver",
"serverType":"WLS",
"serverRole":"ADMIN",
"state":"READY",
"creationDate":"2019-05-16T17:06:46.000+0000",
"isPermanent":false,
"serverStateDisplayName":"Ready"
}
},
"vmStateDisplayName":"Ready"
}
},
"adminHostName":"exampleinstance-wls-1",
"hosts":
{
"userHosts":
{
"exampleinstance-wls-1":
{
"vmId":2312,
"id":2312,
"uuid":"A8D91E3181A646C6BA0353C9F0ED435C",
"hostName":"exampleinstance-wls-1",
"label":"ExampleInstance wls 1",
"ipAddress":"1x.xxx.xxx.x3",
"publicIpAddress":"1x.xxx.xxx.x3",
"usageType":"ADMIN_SERVER",
"role":"ADMIN_SERVER",
"componentType":"WLS",
"state":"READY",
"shapeId":"oc3",
"totalStorage":254976,
"creationDate":"2019-05-16T17:06:46.000+0000",
"isAdminNode":true,
"servers":
{
"ExampleI_server_1":
{
"serverId":2309,
"serverName":"ExampleI_server_1",
"serverType":"WLS",
"serverRole":"MANAGED",
"state":"READY",
"creationDate":"2019-05-16T17:06:46.000+0000"
},
"ExampleI_adminserver":
{
"serverId":2310,
"serverName":"ExampleI_adminserver",
"serverType":"WLS",
"serverRole":"ADMIN",
"state":"READY",
"creationDate":"2019-05-16T17:06:46.000+0000"
}
}
}
}
},
"paasServers":{},
"clusters":
{
"ExampleI_cluster":
{
"clusterId":811,
"clusterName":"ExampleI_cluster",
"clusterType":"PAAS",
"profile":"{\"clusterName\":\"ExampleI_cluster\",\"pathPrefixes\":[],\"serverTemplateName\":\"ExampleI_cluster_Template\",\"serverCount\":1,\"shape\":\"\"}",
"creationDate":"2019-05-16T17:06:39.414+0000",
"paasServers":
{
"ExampleI_server_1":
{
"serverId":2309,
"serverName":"ExampleI_server_1",
"serverType":"WLS",
"serverRole":"MANAGED",
"state":"READY",
"creationDate":"2019-05-16T17:06:46.000+0000"
}
}
}
},
"displayName":"Weblogic Component",
"componentStateDisplayName":"Ready"
}
},
"associatedServices":
{
"DEPENDS_ON":[
{
"serviceName":"MyDBCService",
"serviceType":"DBaaS"
}]
},
"activityLogs":[
{
"activityLogId":45369,
"serviceName":"ExampleInstance",
"serviceType":"SOA",
"identityDomain":"ExampleIdentityDomain",
"serviceId":811,
"jobId":170186,
"startDate":"2019-06-23T05:40:00.399+0000",
"endDate":"2019-06-23T05:48:03.497+0000",
"status":"FAILED",
"operationId":811,
"operationType":"BACKUP",
"summaryMessage":"BACKUP",
"initiatedBy":"SYSTEM",
"messages":[
{"activityDate":"2019-06-23T05:40:00.399+0000","message":"Activity Submitted"},
{"activityDate":"2019-06-23T05:40:00.448+0000","message":"Activity Started"},
{"activityDate":"2019-06-23T05:41:02.604+0000","message":"SM-BKP-5008: A connectivity issuewith the administration server VM prevented backup operation from running. Try again later."},
{"activityDate":"2019-06-23T05:43:02.659+0000","message":"SM-BKP-5106: Operation failed and will be retried."},
{"activityDate":"2019-06-23T05:44:02.855+0000","message":"SM-BKP-5008: A connectivity issue with the administration server VM prevented backup operation from running. Try again later."},
{"activityDate":"2019-06-23T05:46:02.918+0000","message":"SM-BKP-5106: Operation failed and will be retried."},
{"activityDate":"2019-06-23T05:47:03.122+0000","message":"SM-BKP-5008: A connectivity issue with the administration server VM prevented backup operation from running. Try again later."},
{"activityDate":"2019-06-23T05:48:03.482+0000","message":"Activity Ended"},
{"activityDate":"2019-06-23T05:48:03.497+0000","message":"Activity Ended"}
]
}],
"layeringMode":"None",
"serviceLevelDisplayName":"Oracle SOA Cloud Service",
"editionDisplayName":"Enterprise Edition",
"meteringFrequencyDisplayName":"Hourly",
"useStackTag":"false",
"totalSharedStorage":0,
"allAssociations":
{
"toAssociations":[
{
"associationId":605,
"displayName":"INFRA_DB",
"associationType":"DEPENDS_ON",
"associationName":"INFRA_DB",
"associationState":"READY",
"assocStatusMessage":"newly created",
"isRequired":true,
"creationDate":"2019-05-16T17:06:39.000+0000",
"domain":"ExampleIdentityDomain",
"serviceType":"DBaaS",
"serviceName":"MyDBCService",
"serviceStatus":"READY",
"serviceStateDisplayName":"Ready",
"edition":"EE",
"version":"12.1.0.2",
"level":"PAAS",
"ocpu":1,
"associationStateDisplayName":"Ready",
"assocTypeDisplayName":"Depends On",
"assocTypeDescription":"Service A depends on Resource B\/Service B."
}],
"fromAssociations":[]
},
"serviceStateDisplayName":"Ready",
"region":"ExampleIdentityDomain",
"patching":
{
"currentOperation":{"operation":"NONE"},
"updateStatus":"NORMAL_PENDING",
"totalAvailablePatches":2
}
}
}
}