Onepanel.OnezoneClusterApi

All URIs are relative to https://localhost/api/v3/onepanel

Method	HTTP request	Description
addZoneDatabases	POST /zone/databases	Add zone databases
addZoneManagers	POST /zone/managers	Add zone cluster managers
addZoneWorkers	POST /zone/workers	Add zone cluster workers
configureZone	POST /zone/configuration	Configure zone deployment
getZoneClusterIps	GET /zone/cluster_ips	Get zone cluster nodes IPs
getZoneConfiguration	GET /zone/configuration	Get zone cluster configuration
getZoneDatabaseStatus	GET /zone/databases/{host}	Get zone database status
getZoneDatabasesStatus	GET /zone/databases	Get zone databases status
getZoneManagerStatus	GET /zone/managers/{host}	Get zone cluster manager status
getZoneManagersStatus	GET /zone/managers	Get zone cluster managers status
getZoneNagiosReport	GET /zone/nagios	Get zone nagios report
getZoneWorkerStatus	GET /zone/workers/{host}	Get zone cluster worker status
getZoneWorkersStatus	GET /zone/workers	Get zone cluster workers status
modifyZoneClusterIps	PATCH /zone/cluster_ips	Set external IPs of nodes in application config
startStopZoneDatabases	PATCH /zone/databases	Start/stop zone databases
startStopZoneDatabasesHost	PATCH /zone/databases/{host}	Start/stop zone database
startStopZoneManager	PATCH /zone/managers/{host}	Start/stop zone cluster manager
startStopZoneManagers	PATCH /zone/managers	Start/stop zone cluster managers
startStopZoneWorker	PATCH /zone/workers/{host}	Start/stop zone cluster worker
startStopZoneWorkers	PATCH /zone/workers	Start/stop zone cluster workers

addZoneDatabases

TaskId addZoneDatabases(serviceHosts)

Add zone databases

Deploys a database service on provided hosts.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var serviceHosts = new Onepanel.ServiceDatabases(); // ServiceDatabases | The service hosts configuration where databases should be deployed. 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.addZoneDatabases(serviceHosts, callback);

Parameters

Name	Type	Description	Notes
serviceHosts	ServiceDatabases	The service hosts configuration where databases should be deployed.

Return type

TaskId

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: application/json
Accept: Not defined

addZoneManagers

TaskId addZoneManagers(managerHosts)

Add zone cluster managers

Deploys a cluster manager service on provided hosts.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var managerHosts = new Onepanel.ManagerHosts(); // ManagerHosts | The hosts specification where cluster managers should be deployed. 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.addZoneManagers(managerHosts, callback);

Parameters

Name	Type	Description	Notes
managerHosts	ManagerHosts	The hosts specification where cluster managers should be deployed.

Return type

TaskId

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: application/json
Accept: Not defined

addZoneWorkers

TaskId addZoneWorkers(serviceHosts)

Add zone cluster workers

Deploys a cluster worker service on provided hosts.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var serviceHosts = new Onepanel.ServiceHosts(); // ServiceHosts | The hosts specification where the workers should be deployed.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.addZoneWorkers(serviceHosts, callback);

Parameters

Name	Type	Description	Notes
serviceHosts	ServiceHosts	The hosts specification where the workers should be deployed.

Return type

TaskId

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: application/json
Accept: Not defined

configureZone

TaskId configureZone(zoneConfiguration)

Configure zone deployment

Configures and starts zone services, such as database, cluster manager and cluster worker. This request can be executed by unauthorized users as long as there are no admin users in the system.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var zoneConfiguration = new Onepanel.ZoneConfiguration(); // ZoneConfiguration | The zone configuration description.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.configureZone(zoneConfiguration, callback);

Parameters

Name	Type	Description	Notes
zoneConfiguration	ZoneConfiguration	The zone configuration description.

Return type

TaskId

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: application/json, application/x-yaml
Accept: Not defined

getZoneClusterIps

ClusterIps getZoneClusterIps()

Get zone cluster nodes IPs

Returns IPs of nodes in zone cluster.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getZoneClusterIps(callback);

Parameters

This endpoint does not need any parameter.

Return type

ClusterIps

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

getZoneConfiguration

ZoneConfigurationDetails getZoneConfiguration()

Get zone cluster configuration

Returns the zone cluster configuration.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getZoneConfiguration(callback);

Parameters

This endpoint does not need any parameter.

Return type

ZoneConfigurationDetails

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

getZoneDatabaseStatus

ServiceStatusHost getZoneDatabaseStatus(host)

Get zone database status

Returns status of database service on the selected host.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var host = "host_example"; // String | The name of a host for which database service status should be returned. 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getZoneDatabaseStatus(host, callback);

Parameters

Name	Type	Description	Notes
host	String	The name of a host for which database service status should be returned.

Return type

ServiceStatusHost

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

getZoneDatabasesStatus

ServiceStatus getZoneDatabasesStatus()

Get zone databases status

Returns status of database service on each host where it has been deployed.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getZoneDatabasesStatus(callback);

Parameters

This endpoint does not need any parameter.

Return type

ServiceStatus

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

getZoneManagerStatus

ServiceStatusHost getZoneManagerStatus(host)

Get zone cluster manager status

Returns status of cluster manager service on the selected host.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var host = "host_example"; // String | The name of a host for which cluster manager service status should be returned. 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getZoneManagerStatus(host, callback);

Parameters

Name	Type	Description	Notes
host	String	The name of a host for which cluster manager service status should be returned.

Return type

ServiceStatusHost

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

getZoneManagersStatus

ServiceStatus getZoneManagersStatus()

Get zone cluster managers status

Returns status of cluster manager service on each host where it has been eployed.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getZoneManagersStatus(callback);

Parameters

This endpoint does not need any parameter.

Return type

ServiceStatus

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

getZoneNagiosReport

getZoneNagiosReport()

Get zone nagios report

Returns the zone nagios report.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getZoneNagiosReport(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: text/xml

getZoneWorkerStatus

ServiceStatusHost getZoneWorkerStatus(host)

Get zone cluster worker status

Returns status of cluster worker service on the selected host.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var host = "host_example"; // String | The name of a host for which cluster worker service status should be returned. 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getZoneWorkerStatus(host, callback);

Parameters

Name	Type	Description	Notes
host	String	The name of a host for which cluster worker service status should be returned.

Return type

ServiceStatusHost

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

getZoneWorkersStatus

ServiceStatus getZoneWorkersStatus()

Get zone cluster workers status

Returns status of cluster worker service on each host where it has been deployed.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getZoneWorkersStatus(callback);

Parameters

This endpoint does not need any parameter.

Return type

ServiceStatus

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

modifyZoneClusterIps

modifyZoneClusterIps(clusterIps)

Set external IPs of nodes in application config

Informs cluster nodes about external IPs which can be used to access them by other zones.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var clusterIps = new Onepanel.ModifyClusterIps(); // ModifyClusterIps | The zone configuration description.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.modifyZoneClusterIps(clusterIps, callback);

Parameters

Name	Type	Description	Notes
clusterIps	ModifyClusterIps	The zone configuration description.

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: application/json, application/x-yaml
Accept: Not defined

startStopZoneDatabases

startStopZoneDatabases(opts)

Start/stop zone databases

Starts or stops database service on all hosts in the local deployment.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var opts = { 
  'started': true // Boolean | Defines the intended state of the database service. The service will be started or stopped in order to match the requested state. 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.startStopZoneDatabases(opts, callback);

Parameters

Name	Type	Description	Notes
started	Boolean	Defines the intended state of the database service. The service will be started or stopped in order to match the requested state.	[optional] [default to true]

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

startStopZoneDatabasesHost

startStopZoneDatabasesHost(host, opts)

Start/stop zone database

Starts or stops database service on the selected hosts in the local deployment.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var host = "host_example"; // String | The name of a host for which database service status should be changed. 

var opts = { 
  'started': true // Boolean | Defines the intended state of the database service. The service will be started or stopped in order to match the requested state. 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.startStopZoneDatabasesHost(host, opts, callback);

Parameters

Name	Type	Description	Notes
host	String	The name of a host for which database service status should be changed.
started	Boolean	Defines the intended state of the database service. The service will be started or stopped in order to match the requested state.	[optional] [default to true]

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

startStopZoneManager

startStopZoneManager(host, opts)

Start/stop zone cluster manager

Starts or stops cluster manager service on the selected hosts in the local deployment.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var host = "host_example"; // String | The name of a host for which cluster manager service status should be changed. 

var opts = { 
  'started': true // Boolean | Defines the intended state of the cluster manager service. The service will be started or stopped in order to match the requested state. 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.startStopZoneManager(host, opts, callback);

Parameters

Name	Type	Description	Notes
host	String	The name of a host for which cluster manager service status should be changed.
started	Boolean	Defines the intended state of the cluster manager service. The service will be started or stopped in order to match the requested state.	[optional] [default to true]

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

startStopZoneManagers

startStopZoneManagers(opts)

Start/stop zone cluster managers

Starts or stops cluster manager service on all hosts in the local deployment.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var opts = { 
  'started': true // Boolean | Defines the intended state of the cluster manager service. The service will be started or stopped in order to match the requested state. 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.startStopZoneManagers(opts, callback);

Parameters

Name	Type	Description	Notes
started	Boolean	Defines the intended state of the cluster manager service. The service will be started or stopped in order to match the requested state.	[optional] [default to true]

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

startStopZoneWorker

startStopZoneWorker(host, opts)

Start/stop zone cluster worker

Starts or stops cluster worker service on the selected hosts in the local deployment.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var host = "host_example"; // String | The name of a host for which cluster worker service status should be changed. 

var opts = { 
  'started': true // Boolean | Defines the intended state of the cluster worker service. The service will be started or stopped in order to match the requested state. 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.startStopZoneWorker(host, opts, callback);

Parameters

Name	Type	Description	Notes
host	String	The name of a host for which cluster worker service status should be changed.
started	Boolean	Defines the intended state of the cluster worker service. The service will be started or stopped in order to match the requested state.	[optional] [default to true]

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

startStopZoneWorkers

startStopZoneWorkers(opts)

Start/stop zone cluster workers

Starts or stops cluster worker service on all hosts in the local deployment.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

// Configure API key authorization: api_key1
var api_key1 = defaultClient.authentications['api_key1'];
api_key1.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key1.apiKeyPrefix = 'Token';

// Configure API key authorization: api_key2
var api_key2 = defaultClient.authentications['api_key2'];
api_key2.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key2.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.OnezoneClusterApi();

var opts = { 
  'started': true // Boolean | Defines the intended state of the cluster worker service. The service will be started or stopped in order to match the requested state. 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.startStopZoneWorkers(opts, callback);

Parameters

Name	Type	Description	Notes
started	Boolean	Defines the intended state of the cluster worker service. The service will be started or stopped in order to match the requested state.	[optional] [default to true]

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

Files

OnezoneClusterApi.md

Latest commit

History

OnezoneClusterApi.md

File metadata and controls

Onepanel.OnezoneClusterApi

addZoneDatabases

Example

Parameters

Return type

Authorization

HTTP request headers

addZoneManagers

Example

Parameters

Return type

Authorization

HTTP request headers

addZoneWorkers

Example

Parameters

Return type

Authorization

HTTP request headers

configureZone

Example

Parameters

Return type

Authorization

HTTP request headers

getZoneClusterIps

Example

Parameters

Return type

Authorization

HTTP request headers

getZoneConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

getZoneDatabaseStatus

Example

Parameters

Return type

Authorization

HTTP request headers

getZoneDatabasesStatus

Example

Parameters

Return type

Authorization

HTTP request headers

getZoneManagerStatus

Example

Parameters

Return type

Authorization

HTTP request headers

getZoneManagersStatus

Example

Parameters

Return type

Authorization

HTTP request headers

getZoneNagiosReport

Example

Parameters

Return type

Authorization

HTTP request headers

getZoneWorkerStatus

Example

Parameters

Return type

Authorization

HTTP request headers

getZoneWorkersStatus