REST API for Oracle SOA Cloud Service

Scale a Node

post

/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/hosts/scale

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

This endpoint is not supported for Service instances provisioned in Oracle Cloud Infrastructure.

Request

Supported Media Types

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

Path Parameters

domainName: string

Name of the identity domain for the Oracle Cloud Service account.
serviceName: string

Name of the Oracle SOA Cloud Service instance.

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

Root Schema : scale-up-down-request

Type: object

Show Source

components: object components

{
    "required":[
        "components"
    ],
    "type":"object",
    "properties":{
        "components":{
            "type":"object",
            "properties":{
                "WLS":{
                    "type":"object",
                    "properties":{
                        "shape":{
                            "type":"string",
                            "description":"Desired compute shape.<p>This attribute is required. If you do not want to change the compute shape, set this value to match the current compute shape.<p>Valid <code>weblogic</code> shapes include: <ul><li>oc1m: 1 OCPU, 15 GB memory</li><li>oc2m: 2 OCPUs, 30 GB memory</li><li>oc3m: 4 OCPUs, 60 GB memory</li><li>oc4m: 8 OCPUs, 120 GB memory</li><li>oc5m: 16 OCPUs, 240 GB memory</li></ul><p>Valid <code>otd</code> shapes include: <ul><li>oc3: 1 OCPU, 7.5 GB memory</li><li>oc4: 2 OCPUs, 15 GB memory</li><li>oc5: 4 OCPUs, 30 GB memory</li><li>oc6: 8 OCPUs, 60 GB memory</li><li>oc7: 16 OCPUs, 120 GB memory</li></ul>"
                        },
                        "hosts":{
                            "type":"array",
                            "description":"An array of hosts to be controlled via the mentioned operation. The service is controlled if ALL hosts are listed, making this the same behavior as including allServiceHosts:true.",
                            "items":{
                                "type":"string",
                                "description":"A WLS host the operation applies to."
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : components

Type: object

Show Source

WLS(optional): object WLS

{
    "type":"object",
    "properties":{
        "WLS":{
            "type":"object",
            "properties":{
                "shape":{
                    "type":"string",
                    "description":"Desired compute shape.<p>This attribute is required. If you do not want to change the compute shape, set this value to match the current compute shape.<p>Valid <code>weblogic</code> shapes include: <ul><li>oc1m: 1 OCPU, 15 GB memory</li><li>oc2m: 2 OCPUs, 30 GB memory</li><li>oc3m: 4 OCPUs, 60 GB memory</li><li>oc4m: 8 OCPUs, 120 GB memory</li><li>oc5m: 16 OCPUs, 240 GB memory</li></ul><p>Valid <code>otd</code> shapes include: <ul><li>oc3: 1 OCPU, 7.5 GB memory</li><li>oc4: 2 OCPUs, 15 GB memory</li><li>oc5: 4 OCPUs, 30 GB memory</li><li>oc6: 8 OCPUs, 60 GB memory</li><li>oc7: 16 OCPUs, 120 GB memory</li></ul>"
                },
                "hosts":{
                    "type":"array",
                    "description":"An array of hosts to be controlled via the mentioned operation. The service is controlled if ALL hosts are listed, making this the same behavior as including allServiceHosts:true.",
                    "items":{
                        "type":"string",
                        "description":"A WLS host the operation applies to."
                    }
                }
            }
        }
    }
}

Nested Schema : WLS

Type: object

Show Source

hosts(optional): array hosts

An array of hosts to be controlled via the mentioned operation. The service is controlled if ALL hosts are listed, making this the same behavior as including allServiceHosts:true.
shape(optional): string
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

{
    "type":"object",
    "properties":{
        "shape":{
            "type":"string",
            "description":"Desired compute shape.<p>This attribute is required. If you do not want to change the compute shape, set this value to match the current compute shape.<p>Valid <code>weblogic</code> shapes include: <ul><li>oc1m: 1 OCPU, 15 GB memory</li><li>oc2m: 2 OCPUs, 30 GB memory</li><li>oc3m: 4 OCPUs, 60 GB memory</li><li>oc4m: 8 OCPUs, 120 GB memory</li><li>oc5m: 16 OCPUs, 240 GB memory</li></ul><p>Valid <code>otd</code> shapes include: <ul><li>oc3: 1 OCPU, 7.5 GB memory</li><li>oc4: 2 OCPUs, 15 GB memory</li><li>oc5: 4 OCPUs, 30 GB memory</li><li>oc6: 8 OCPUs, 60 GB memory</li><li>oc7: 16 OCPUs, 120 GB memory</li></ul>"
        },
        "hosts":{
            "type":"array",
            "description":"An array of hosts to be controlled via the mentioned operation. The service is controlled if ALL hosts are listed, making this the same behavior as including allServiceHosts:true.",
            "items":{
                "type":"string",
                "description":"A WLS host the operation applies to."
            }
        }
    }
}

Nested Schema : hosts

Type: array

An array of hosts to be controlled via the mentioned operation. The service is controlled if ALL hosts are listed, making this the same behavior as including allServiceHosts:true.

Show Source

Array of: string

A WLS host the operation applies to.

{
    "type":"array",
    "description":"An array of hosts to be controlled via the mentioned operation. The service is controlled if ALL hosts are listed, making this the same behavior as including allServiceHosts:true.",
    "items":{
        "type":"string",
        "description":"A WLS host the operation applies to."
    }
}

Response

Supported Media Types

application/json

202 Response

Accepted

The response body contains information about the scale-up-down operation.

Root Schema : scale-up-down-response

Type: object

The response body contains information about the scale-up-down operation.

Show Source

details: object details

The details of the scale operation.

{
    "required":[
        "details"
    ],
    "description":"The response body contains information about the scale-up-down operation.",
    "properties":{
        "details":{
            "type":"object",
            "required":[
                "jobId",
                "message"
            ],
            "description":"The details of the scale operation.",
            "properties":{
                "jobId":{
                    "type":"string",
                    "description":"Job ID for the scale operation."
                },
                "message":{
                    "type":"string",
                    "description":"System message that describes the operation. For example: <code>scaleup.job.submitted</code>"
                }
            }
        }
    }
}

Nested Schema : details

Type: object

The details of the scale operation.

Show Source

jobId: string

Job ID for the scale operation.
message: string

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

{
    "type":"object",
    "required":[
        "jobId",
        "message"
    ],
    "description":"The details of the scale operation.",
    "properties":{
        "jobId":{
            "type":"string",
            "description":"Job ID for the scale operation."
        },
        "message":{
            "type":"string",
            "description":"System message that describes the operation. For example: <code>scaleup.job.submitted</code>"
        }
    }
}

Examples

The following example shows how to scale a server to change its compute shape or add block storage in Oracle SOA Cloud Service instance by submitting a POST request on the REST resource using cURL For more information, see Use cURL.

cURL Command

curl -v -X POST -u username:Password1! -t @scaleUpPayload.json -H "Content-Type:application/vnd.com.oracle.oracloud.provisioning.Service+json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest-server_url.com/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/hosts/scale

Example of Request Header

The following shows an example of the request header.

-u '{userName}:{password}'	
Content-Type:application/vnd.com.oracle.oracloud.provisioning.Service+json
X-ID-TENANT-NAME: {domainName}
Accept: application/json

Example of Request Body

The following example shows the request in JSON format.

{
  "components": {
    "WLS": {
      "shape": "oc1m/oc2m/oc3m/oc4m",
      "hosts": ["<hostName>"]
     }
  }
}

Example of Response Body

The following shows an example of the response body returned in JSON format:

{
  "details": {
    "message": "Submitted job to scaling job in service [ServiceName] in domain [DomainName].",
    "jobId": "12997"
  }
}