REST API for Managing Application Caches

Create a Cache

post

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

Creates a cache instance.

Request

Supported Media Types

application/vnd.com.oracle.oracloud.provisioning.Service+json

Path Parameters

identityDomainId: Type: string

Required: true

Name of the identity domain for the Oracle Application Container Cloud Service account

Body Parameter

Required payload

Root Schema : create-request

Request body specifies service details.

Properties

serviceParameters: Type: object service-parameters

Additional Properties Allowed:

Nested Schema : service-parameters

Type: object

Properties

deploymentType: Type: string

'Basic' or 'Recommended'
serviceDescription: Type: string

Free-form description field
serviceLevel: Type: string

Service level, currently 'PAAS'
serviceName: Type: string

Unique name for the service
serviceVersion: Type: string

Version, currently '1.0'
size: Type: integer

Size of the cache in GB
subscription: Type: string

Subscription, currently 'HOURLY'

Response

Supported Media Types

application/json

202 Response

Accepted

Body

Root Schema : details-jobid

Type: object

Properties

details: Type: object details

Additional Properties Allowed:

Nested Schema : details

Type: object

Properties

jobId: Type: integer

ID of the ACCS infrastructure job that is performing the operation
message: Type: string

Acknowledgment message for a request

429 Response

Too Many Requests. Returned if the quota of instances has been exceeded.

500 Response

Server Error. Returned if a server error has occurred.

Examples

The following example shows how to create a cache by submitting a POST 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 POST -u joe@example.com:joePassword \
 -H "X-ID-TENANT-NAME:ExampleIdentityDomain" \
 -H "Content-Type:application/vnd.com.oracle.oracloud.provisioning.Service+json" \
 -d @create-cache.json \
  https://apaas.us.oraclecloud.com/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/caching/instances

Example of Request Body

The following example shows the contents of the request body in JSON format. This is the contents of the create-cache.json file listed in the cURL command.

{
   "serviceParameters":{
      "deploymentType":"Basic",
      "serviceDescription":"Cache creation example",
      "serviceLevel":"PAAS",
      "serviceName":"MyCache",
      "serviceVersion":"1.0",
      "size":"1",
      "subscription":"HOURLY"
   }
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 202 Accepted
Date: Wed, 12 Apr 2017 16:01:26 GMT
Transfer-Encoding: chunked
Location: https://apaas.us.oraclecloud.com/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/17465
Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json
Access-Control-Allow-Headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
Service-URI: https://apaas.us.oraclecloud.com/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/caching/instances/MyCache
Retry-After: 60
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
X-ORACLE-DMS-ECID: e6b609ac-e548-4bee-8d87-fd2b4c6a51bf-0000f315
Access-Control-Allow-Origin: *
X-Frame-Options: DENY

Example of Response Body

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

{
   "details":{
      "message":"Submitted job to create service [MyCache] in domain [ExampleIdentityDomain].",
      "jobId":"17465"
   }
}