1. REST API for Oracle SOA Cloud Service
  2. Tasks
  3. Service Instances

Start a Service Instance or Compute Node

post

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

Starts a service instance or one of its compute nodes. When starting a single compute node, only managed servers can be targeted.

Note the following about stopping and restarting:

  • Automatically assigned public IP addresses and, if applicable, reserved public IP addresses on service instances and nodes do not change when the instance or node is restarted or started from a stopped state.
  • On Oracle Cloud Infrastructure: A private IP address persists when a node or service instance is stopped. The same IP address is assigned when the node or instance is started or restarted.
  • On Oracle Cloud Infrastructure Classic and Oracle Cloud at Customer: A private IP address is released when a node or instance is stopped. The same private IP address may or may not be assigned upon starting or restarting.

On Oracle Cloud Infrastructure Classic only: For a service instance that is attached to an IP network, you can set a static private IP address or remove the static private IP configuration when you restart a node or start a node that was stopped. The static private IP address persists in subsequent restarts of the node or service instance.

Do not use the OCI Compute APIs to start an Oracle SOA Cloud Service instance. This is not supported. Use the Oracle SOA Cloud Service API to start your instance if you want to use the API for SOA Cloud Service instance lifecycle management.

For complete information about what happens when an instance is stopped and started, see Stop and Start an Oracle SOA Cloud Service Instance and Individual VMs in Administering Oracle SOA Cloud Service.

Request

Supported Media Types
Path Parameters
Body ()
The request body defines the details of the start request.
Root Schema : start-instance
Type: object
Request payload for starting an Oracle SOA Cloud Service instance
Show Source
Nested Schema : components
Type: object
Show Source
Nested Schema : WLS
Type: object
Show Source
  • 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.
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
Back to Top

Response

Supported Media Types

202 Response

Accepted.
Headers
  • A REST URI you can use to check the progress and completion of the start operation.
Back to Top

Examples

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

cURL Commands

curl -i -X POST -u username:Password1! -H "X-ID-TENANT-NAME:{identityDomainId}" -d @start.json -H "Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json" https://rest-server_url.com/paas/api/v1.1/instancemgmt/{identityDomainId}/services/SOA/instances/{serviceName}/hosts/start
curl -i -X POST -u username:Password1! -H "X-ID-TENANT-NAME:{identityDomainId}" -d @restart.json -H "Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json" https://rest-server_url.com/paas/api/v1.1/instancemgmt/{identityDomainId}/services/SOA/instances/{serviceName}/hosts/restart

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 to start an instance in JSON format.

{
  "allServiceHosts": false,
  "components": {
    "WLS": {
      "hosts": [
        "myInstance1-wls-1"
      ]
    }
  }
}

The following example shows the request to start all instances in JSON format.

{
  "allServiceHosts": "true"
}
The following is a request body example for setting a private static IP when starting a stopped WLS host or restarting a single WLS host. 
{
   "components": {
      "WLS": {
        "hosts" : ["exampleinstance-wls-3"],
        "privateStaticIps": [
          "10.20.30.13"
        ]
      }
    }
}

The following is a request body example for setting a private static IP when restarting a load balancer (OTD).

{
  "components": {
    "OTD": {
      "hosts": [
        "exampleinstance-lb-1"
      ],
      "privateStaticIps": [
        "10.20.30.3"
      ]
    }
  }
}
The following is a request body example for removing the static IP configuration from a WLS host. 
{
   "components": {
      "WLS": {
        "hosts" : ["exampleinstance-wls-3"],
        "privateStaticIps": [
          "reset"
        ]
      }
    }
}

Example of Response Body

The following example shows the response returned in JSON format:

{
  "details": {
    "message": "Submitted job to [start] VMs in service [myInstance1] in domain [soacs].",
    "jobId": "9418"
  }
}
Back to Top