Jump to

• Request
• Response
• Examples

Scale Out a Cluster

post

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

Adds a new Managed Server to the specified cluster, essentially scaling out the instance by one node.

If you are scaling out a service instance that uses IP reservations, make sure you use only reserved IPs that are created in the same region. See IP Reservations REST Endpoints for information about how to find unused IP reservations and, if needed, create new IP reservations.

Before scaling out a service instance that uses an Exadata database deployment in an account where regions are not supported, you must obtain IP reservations for the Managed Servers you are going to add; you will not be able to scale out the cluster without IP reservations.

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.

Body ()

The request body defines the details of the scale request on a node.

Root Schema : scale-Out-request

Type: object

Request payload for scaling out a node in an Oracle SOA Cloud Service instance

Show Source

• components: object components

{
    "required":[
        "components"
    ],
    "type":"object",
    "description":"Request payload for scaling out a node in an Oracle SOA Cloud Service instance",
    "properties":{
        "components":{
            "type":"object",
            "properties":{
                "WLS":{
                    "type":"object"
                }
            }
        }
    }
}

Nested Schema : components

Type: object

Show Source

• WLS(optional): object WLS

{
    "type":"object",
    "properties":{
        "WLS":{
            "type":"object"
        }
    }
}

Nested Schema : WLS

Type: object

Back to Top

Response

Supported Media Types

• application/json
• text/plain

202 Response

Accepted

Body ()

Root Schema : scale-out-response

Type: object

The response body contains information about the scale-out operation.

Show Source

• details: object details
  The details of the scale-out operation.

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

Nested Schema : details

Type: object

The details of the scale-out operation.

Show Source

• jobId: string
  Job ID for the scale-out operation.
• message: string
  System message that describes the operation. For example: Submitted job to scale-out service...

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

Back to Top

Examples

The following example shows how to how to scale out an 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 -i -X POST -u username:Password1! -d @scaleout.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/{identityDomainId}/services/SOA/instances/{serviceName}/servers

Example of Request Header

The following example shows the request header.

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

Example of Request Body

The following example shows the request in JSON format.

{
  "components": {
    "WLS": {}
  }
}

The following example shows the request body where an IP reservation name is specified when scaling out the WLS component.

{
   "components": {
      "WLS": {
         "ipReservations": ["IPResv2Node"],
         "clusters": [
         {
            "clusterName": "SOAOSBB2_cluster",
            "type": "APPLICATION_CLUSTER",
            "serverCount": 1}]
      }
   }
}

Example of Response Body

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

{
  "details": {
    "message": "Submitted job to scale out service [sampleService] in domain [sampleDomain].",
    "jobId": "5130"
  }
}

Back to Top