1. REST API for Managing Application Caches
  2. Tasks
  3. Cache Information

View Cache Details

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/caching/instances/{serviceName}

Returns detailed information about a cache instance.

Request

Path Parameters
identityDomainId
Type: string
Required: true
Name of the identity domain for the Oracle Application Container Cloud Service account
serviceName
Type: string
Required: true
Name of the cache instance

Response

Supported Media Types
  • application/json
200 Response
OK
Body
Root Schema : service-instance-details
Type: object
Nested Schema : activityLogs
Type: array
Nested Schema : attributes
Type: object
Nested Schema : capacities
Type: object
Nested Schema : components
Type: object
Nested Schema : patching
Type: object
Nested Schema : items
Type: object
Nested Schema : messages
Type: array
Nested Schema : items
Type: object
Nested Schema : deploymentType
Type: object
Nested Schema : INTERNAL_CACHE_URL
Type: object
Nested Schema : size
Type: object
Nested Schema : allocated
Type: object
Nested Schema : blocked
Type: object
Nested Schema : remaining
Type: object
Nested Schema : Cache
Type: object
Nested Schema : attributes
Type: object
Nested Schema : hosts
Type: object
Nested Schema : containers
Type: object
Nested Schema : cache-name
Nested Schema : attributes
Type: object
Nested Schema : currentOperation
Type: object
404 Response
Not Found. Returned if the cache instance does not exist.

Examples

The following example shows how to retrieve information about a cache by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, including how to determine your region, see Send Requests. 

curl -i -X GET -u joe@example.com:joePassword \
 -H "X-ID-TENANT-NAME:ExampleIdentityDomain" \
  https://apaas.us.oraclecloud.com/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/caching/instances/MyCache

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Wed, 12 Apr 2017 16:29:07 GMT
Transfer-Encoding: chunked
Content-Type: application/json
X-ORACLE-DMS-ECID: e6b609ac-e548-4bee-8d87-fd2b4c6a51bf-0000f3ce
X-Frame-Options: DENY
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
Access-Control-Allow-Headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
Access-Control-Allow-Origin: *

Example of Response Body

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

{
   "serviceId":7,
   "serviceName":"MyCache",
   "serviceType":"caching",
   "domainName":"ExampleIdentityDomain",
   "serviceVersion":"1.0",
   "releaseVersion":"1.1",
   "baseReleaseVersion":"1.1",
   "metaVersion":"17.2.5-1704061909",
   "serviceDescription":"Cache creation example",
   "serviceLevel":"PAAS",
   "subscription":"HOURLY",
   "meteringFrequency":"HOURLY",
   "edition":"GE",
   "totalSSDStorage":0,
   "state":"READY",
   "clone":false,
   "creator":"joe",
   "creationDate":"2017-04-12T16:01:27.790+0000",
   "isManaged":false,
   "capacities":{
      "allocated":{"size":1},
      "blocked":{},
      "remaining":{"size":1}
   },
   "attributes":{
      "deploymentType":{
         "displayName":"Deployment Type",
         "type":"STRING",
         "value":"Basic",
         "displayValue":"Basic",
         "isKeyBinding":false
      },
      "INTERNAL_CACHE_URL":{
         "displayName":"Cache Host",
         "type":"STRING",
         "value":"MyCache-acc",
         "displayValue":"MyCache-acc",
         "isKeyBinding":true
      },
      "size":{
         "displayName":"Cache Capacity [GB]",
         "type":"INTEGER",
         "value":"1",
         "displayValue":"1",
         "isKeyBinding":false
      }
   },
   "components":{
      "Cache":{
         "serviceId":7,
         "componentId":7,
         "state":"READY",
         "version":"1.0",
         "componentType":"Cache",
         "creationDate":"2017-04-12T16:01:27.000+0000",
         "instanceName":"Cache",
         "instanceRole":"NONE",
         "isKeyComponent":false,
         "attributes":{},
         "hosts":{
            "containers":{
               "mycache-cach-1":{
                  "id":7,
                  "containerName":"mycache-cach-1",
                  "containerPort":8080,
                  "containerSize":"2G",
                  "attributes":{}
               }
            }
         },
         "paasServers":{},
         "clusters":{},
         "displayName":"Application Cache",
         "componentStateDisplayName":"Ready"
      }
   },
   "activityLogs":[{
      "activityLogId":6015,
      "serviceName":"MyCache",
      "serviceType":"caching",
      "identityDomain":"ExampleIdentityDomain",
      "serviceId":7,
      "jobId":17465,
      "startDate":"2017-04-12T16:01:28.238+0000",
      "endDate":"2017-04-12T16:10:27.919+0000",
      "status":"SUCCEED",
      "operationId":7,
      "operationType":"CREATE_SERVICE",
      "summaryMessage":"CREATE_SERVICE",
      "authDomain":"ExampleIdentityDomain",
      "authUser":"joe",
      "initiatedBy":"USER",
      "messages":[
         {
            "activityDate":"2017-04-12T16:01:28.238+0000",
            "message":"Activity Submitted"
         },
         {
            "activityDate":"2017-04-12T16:01:28.317+0000",
            "message":"Activity Started"
         },
         {
            "activityDate":"2017-04-12T16:01:28.334+0000",
            "message":"Started operation to create service [MyCache] in identity domain [ExampleIdentityDomain]."
         },
         {
            "activityDate":"2017-04-12T16:01:47.814+0000",
            "message":"Initialized application creation..."
         },
         {
            "activityDate":"2017-04-12T16:08:23.823+0000",
            "message":"Acquired resources for instance(2G) mycache-cach-1..."
         },
         {
            "activityDate":"2017-04-12T16:09:44.644+0000",
            "message":"Deployed application(v1) for instance(2G) mycache-cach-1..."
         },
         {
            "activityDate":"2017-04-12T16:10:06.448+0000",
            "message":"Successfully created application..."
         },
         {
            "activityDate":"2017-04-12T16:10:27.910+0000",
            "message":"Activity Ended"
         },
         {
            "activityDate":"2017-04-12T16:10:27.919+0000",
            "message":"Activity Ended"
         }
      ]
   }],
   "layeringMode":"None",
   "serviceLevelDisplayName":"Service with tooling support",
   "editionDisplayName":"Grid Edition",
   "meteringFrequencyDisplayName":"Hourly",
   "INTERNAL_CACHE_URL":"MyCache-acc",
   "deploymentType":"Basic",
   "size":"1",
   "totalSharedStorage":0,
   "serviceStateDisplayName":"Ready",
   "computeSiteName":"ucf2_ucf2",
   "patching":{
      "currentOperation":{
         "operation":"NONE"
      },
      "totalAvailablePatches":0
   }
}