Restart a Service Instance Node
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/APICS/instances/{serviceId}/hosts/restart
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 - Classic account.
-
serviceId: string
Name of the API Platform Cloud Service - Classic 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(optional):
boolean
Boolean indicating whether request appllies to all hosts in the service instance. For restart operations, this value must be set to
false
. -
components(optional):
object components
object
-
hosts(optional):
array hosts
Array consisting of WLS VM hosts in the service instance the operation applies to. This should include the name of the host(s) you want to restart as a string.
array
-
Array of:
string
A WLS host the operation applies to. Include each host you want to restart.
Response
202 Response
-
Location: string
A REST URI you can use to check the progress and completion of the restart operation, as described in View the Job Status of an Operation.
Examples
The following example shows how to restart a VM in an Oracle API Platform Cloud Service - Classic 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 @payload.json https://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances/apics/hosts/restart
Example of Request Payload
The following shows an example of the request payload to restart a service VM in JSON format.
{ "allServiceHosts": false, "components": { "WLS": { "hosts":["apics-wls-1"] } } }
Example of Request Payload
The following shows an example of the request payload to restart the load balancer in JSON format.
{ "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:54:41 GMT Transfer-Encoding: chunked Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json X-ORACLE-DMS-ECID: 7077e58cc81a37d2:-4cd90f8:15878a7e3f0:-8000-0000000000005f82 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 [restart] VMs in service [apics] in domain [apics]." } }