Server Operations Web Services - Pause and Resume Cluster Node

Owned by Stonebranch (Deactivated)
Jan 30, 2024

Overview

Universal Controller supports the following RESTful-based web services for the Pause Cluster Node and Resume Cluster Node Server Operations.

  • Pause Cluster Node

  • Resume Cluster Node

Formatting specifications for the web service are provided.

Pause Cluster Node

Description

URI

http://host_name/uc/resources/serveroperation/pauseclusternode

HTTP Method

 POST

Description

Sets the instance of the Universal Controller to paused (if active).

Example URI

http://localhost:8080/uc/resources/serveroperation/pauseclusternode

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See Pause Cluster Node: Example Response.

Pause Cluster Node: Example Response

XML Response

JSON Response
 XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<serverOperationResponse>
    <operation>Pause Cluster Node</operation>
    <success>true</success>
    <output>Universal Controller node paused at 2021-05-10 10:59:28 -0400</output> 
</serverOperationResponse>
 JSON Response
{
    "operation": "Pause Cluster Node",
    "success": true,
    "output": "Universal Controller node was already paused, no action taken" 
}



Resume Cluster Node

Description

URI

http://host_name/uc/resources/serveroperation/resumeclusternode

HTTP Method

 POST

Description

Resumes the instance of the Universal Controller (if paused).

Example URI

http://localhost:8080/uc/resources/serveroperation/resumeclusternode

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See Resume Cluster Node: Example Response.

Resume Cluster Node: Example Response

XML Response

JSON Response
 XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<serverOperationResponse>
    <operation>Resume Cluster Node</operation>
    <success>true</success>
    <output>Universal Controller node was not paused, no action taken.</output> 
</serverOperationResponse>
 JSON Response
{
    "operation": "Resume Cluster Node",
    "success": true,
    "output": "Universal Controller node resumed at 2021-05-10 11:02:50 -0400" 
}