Start a Service Instance or Compute Node
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/APICS/instances/{serviceId}/hosts/start
Starts a service instance or one of its compute nodes.
Note: When starting a single compute node, only managed servers can be targeted. If you target an administration server you revieve a 400: Bad Request response.
Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.
Request
- application/vnd.com.oracle.oracloud.provisioning.Service+json
-
identityDomainId: string
Name of the identity domain for the API Platform Cloud Service account.
-
serviceId: string
Name of the API Platform Cloud Service instance.
Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.
-
Authorization: string
Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
object
-
allServiceHosts:
boolean
Boolean indicating whether request appllies to all hosts in the service instance. When
true
, this controls all hosts in the service and the 'hosts' array can be empty. -
components:
object components
object
-
hosts:
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.
array
-
[0]:
string
A WLS host the operation applies to.
Response
202 Response
-
Location: string
A REST URI you can use to check the progress and completion of the start operation, as described in View the Job Status of an Operation.
Examples
The following example shows how to start an Oracle API Platform Cloud Service instance by submitting a POST request on the REST resource using cURL. For more information about cURL, see cURL Examples.
curl -i -X POST -u apicsadmin:password -H "Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json" -d @startStop.json http://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances/apics/hosts/start
Example of Request Body
The following shows an example of the request body in JSON format. This payload starts all service hosts.
{ "allServiceHosts": true, "components": { "WLS": { "hosts":[] } } }
Example of Request Body
The following shows an example of the request body in JSON format. This payload starts only a single service host.
{ "allServiceHosts": false, "components": { "WLS": { "hosts":["api-wls-1"] } } }
Example of Request Body
The following shows an example of the request body in JSON format. This payload starts only a load balancer host.
{ "allServiceHosts":false, "components":{ "OTD":{ "hosts":["service0206-lb-1"] } } }
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 202 Accepted Date: Wed, 23 Nov 2016 10:44:42 GMT Transfer-Encoding: chunked Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json X-ORACLE-DMS-ECID: 7077e58cc81a37d2:-4cd90f8:15878a7e3f0:-8000-0000000000005f33 X-Frame-Options: DENY Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD Access-Control-Allow-Headers: Content-Type, api_key, Authorization Access-Control-Allow-Origin: *
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "details": { "message": "Submitted job to [start] VMs in service [apics] in domain [apics]." } }