REST API for Oracle SOA Cloud Service on Oracle Public Cloud Machine

Scale a Node

put

/api/v1.1/instances/{identityId}/{serviceId}/{serverName}

Scales the specified Administration Server or Managed Server node to change its compute shape or add block storage.

You can scale only the Administration Server node and Managed Server nodes in a WebLogic Server cluster. Oracle SOA Cloud Service does not support scaling for other nodes in a service instance, such as the load balancer node or capacity unit nodes in the Coherence data tier.

You can add block storage to a new volume or one of the following existing volumes:

Backup storage volume (Administration Server node only)
Domain home storage volume
Oracle Fusion Middleware home storage volume

You cannot remove block storage from a storage volume.

Note: Scaling is not supported by Oracle SOA Cloud Service - Virtual Image instances.

Request

Supported Media Types

application/json

Path Parameters

identityId: Type: string

Required: true

Identity domain ID for the Oracle SOA Cloud Service account.
serverName: Type: string

Required: true

Name of the node (Administration Server or Managed Server) for which you want to increase block storage capacity.
serviceId: Type: string

Required: true

Name of the Oracle SOA Cloud Service instance.

Body Parameter

The request body defines the details of the create instance request. Bold indicates a required value.

Root Schema : scale-up-request

Properties

additionalStorage

Type: string

Amount of gigabytes (GBs) that you want to increase block storage. You can specify the storage volume using the scalingVolume attribute. If no storage volume is specified, a new storage volume is created.

scalingVolume

Type: string

Storage volume to which you want to add block storage. This attribute is valid only if you specify the additionalStorage attribute in your request. If not specified, a new storage volume is created.

Valid values include:

backup - Adds block storage to the backup storage volume. This is valid when scaling the Administration Server node only.
domains - Adds block storage to the domain home storage volume.
middleware - Adds block storage to the Oracle Fusion Middleware home storage volume.

shape

Type: string

Required: true

Desired compute shape.

This attribute is required. If you do not want to change the compute shape, set this value to match the current compute shape.

Valid weblogic shapes include:

oc1m: 1 OCPU, 15 GB memory
oc2m: 2 OCPUs, 30 GB memory
oc3m: 4 OCPUs, 60 GB memory
oc4m: 8 OCPUs, 120 GB memory
oc5m: 16 OCPUs, 240 GB memory

Valid otd shapes include:

oc3: 1 OCPU, 7.5 GB memory
oc4: 2 OCPUs, 15 GB memory
oc5: 4 OCPUs, 30 GB memory
oc6: 8 OCPUs, 60 GB memory
oc7: 16 OCPUs, 120 GB memory

See About Machine Images and Shapes in Using Oracle Compute Cloud Service (for PaaS) for more information about shapes.

Response

Supported Media Types

application/json

202 Response

Accepted

Body

The response body contains information about the scale operation.

Root Schema : scale-up-response

The response body contains information about the scale operation.

Properties

details: Type: array details

Groups the details of the scale operation.
status: Type: string

Status of the operation. When first initiated, the status is set to New. The status may transition to one of the following values: Completed and Cannot Complete.

Nested Schema : details

Type: array

Groups the details of the scale operation.

Items

Type: object scale-details

Nested Schema : scale-details

Properties

jobId: Type: string

Job ID for the scale operation.
message: Type: string

System message that describes the operation. For example: scaleup.job.submitted

Examples

The following example shows how to scale up an Administration Server by one node by submitting a PUT request on the REST resource using cURL. For more information, see Use cURL.

cURL Command

curl -i -X PUT -u joe@example.com:Welcome1! -d @scale.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://api-host/paas/service/soa/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance/ExampleI_server_1

Note:: This example uses the URL prefix for the United States ( soacs). For information about the URL prefixes for other regions of the world, see Send Requests.

Example of Response Header

The following shows an example of the response header.

The Location header returns a REST URI that can be used to access the status of the scale operation, as described in View Server Operation Status by Job ID.

HTTP/1.1 202 Accepted
Date: Thu, 29 Jan 2015 21:20:52 GMT
Transfer-Encoding: chunked
Location: https://api-host/paas/service/soa/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance/servers/history/job/17
Content-Type: application/json

Example of Request Body

The following shows an example of the request body in JSON format.

{
   "additionalStorage": "1",
   "scalingVolume" : "backup",
   "shape": "oc4m"
}

Example of Response Body

The following shows an example of the response document returned in JSON format.

{
   "status": "New",
   "details": {
      "message": "scaleup.job.submitted",
      "jobId": "17"
   }
}