Jump to

• Request
• Response
• Examples

Scale In a Cluster

put

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

Removes a specified Managed Server, essentially scaling in the instance by one node.

When you are scaling in a service instance that uses IP reservations, the IP reservation associated with the removed node is released but not deleted.

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-In-request

Type: object

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

Show Source

• components(optional): object components

{
    "type":"object",
    "description":"Request payload for scaling in a node in an Oracle SOA Cloud Service instance",
    "properties":{
        "components":{
            "type":"object",
            "properties":{
                "WLS":{
                    "type":"object",
                    "properties":{
                        "hosts":{
                            "type":"array",
                            "description":"The host name for scaling in a node in an Oracle SOA Cloud Service instance.",
                            "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":{
                "hosts":{
                    "type":"array",
                    "description":"The host name for scaling in a node in an Oracle SOA Cloud Service instance.",
                    "items":{
                        "type":"string",
                        "description":"A WLS host the operation applies to."
                    }
                }
            }
        }
    }
}

Nested Schema : WLS

Type: object

Show Source

• hosts(optional): array hosts
  The host name for scaling in a node in an Oracle SOA Cloud Service instance.

{
    "type":"object",
    "properties":{
        "hosts":{
            "type":"array",
            "description":"The host name for scaling in a node in an Oracle SOA Cloud Service instance.",
            "items":{
                "type":"string",
                "description":"A WLS host the operation applies to."
            }
        }
    }
}

Nested Schema : hosts

Type: array

The host name for scaling in a node in an Oracle SOA Cloud Service instance.

Show Source

• Array of: string
  A WLS host the operation applies to.

{
    "type":"array",
    "description":"The host name for scaling in a node in an Oracle SOA Cloud Service instance.",
    "items":{
        "type":"string",
        "description":"A WLS host the operation applies to."
    }
}

Back to Top

Response

Supported Media Types

• application/json
• text/plain

202 Response

Accepted

Body ()

Root Schema : scale-in-response

Type: object

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

Show Source

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

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

Nested Schema : details

Type: object

The details of the scale-in operation.

Show Source

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

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

Back to Top

Examples

The following example shows how to scale in by one node an Oracle SOA Cloud Service instance by submitting a PUT request on the REST resource using cURL. For more information, see Use cURL.

cURL Command

curl -i -X PUT -u username:Password1! -d @scalein.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": {
      "hosts": [
        "den01cvysoaosb1213texy-wls-2"]
    }
  }
}

Example of Response Body

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

{
  "details": {
    "message": "Submitted job to scale in service [sampleServiceName] in domain [sampleDomain].",
    "jobId": "5070"
  }
}

Back to Top