REST API for Managing Application Caches

Stop a Cache

post

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

Stops 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
serviceName: Type: string

Required: true

Name of the cache instance

Body Parameter

The request body defines the details of the start request.

Root Schema : start-stop-payload

The allServiceHosts parameter must be set to 'true'.

Properties

allServiceHosts: Type: boolean

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

404 Response

Not Found. Returned if the cache instance does not exist.

Body

Root Schema : details-issues

Properties

details: Type: object details

Additional Properties Allowed:

Nested Schema : details

Type: object

Properties

issues: Type: array issues

Additional Properties Allowed:
message: Type: string

Acknowledgment message of a request

Nested Schema : issues

Type: array

Items

Type: string

Examples

The following example shows how to stop 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 '{"allServiceHosts":"true"}' \
  https://apaas.us.oraclecloud.com/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/caching/instances/MyCache/hosts/stop

Example of Request Body

The following example shows the contents of the request body in JSON format. This is included in the cURL command.

{"allServiceHosts":"true"}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 202 Accepted
Date: Wed, 12 Apr 2017 17:51:26 GMT
Transfer-Encoding: chunked
Location: https://apaas.us.oraclecloud.com/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/17472
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/MyCache
Retry-After: 60
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
X-ORACLE-DMS-ECID: e6b609ac-e548-4bee-8d87-fd2b4c6a51bf-0000f5d7
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 [stop] VMs in service [MyCache] in domain [ExampleIdentityDomain].",
      "jobId":"17472"
   }
}