ControlResourceV2 Resource

POST /api/v2/manager/control/service/{service}/fail

Fail the service.

Request Parameters
name type description
service path the service name
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/east/fail
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/failover

Do a failover in the given data service.

Request Parameters
name type description
service path the service name
Response Body
media type data type description
application/json TaskPayload (JSON) a task

Example

Request
POST /api/v2/manager/control/service/west/failover
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "payloadType" : "TaskPayload",
  "payloadVersion" : "1",
  "payload" : {
    "taskId" : "d7c03af4-17f1-46da-981b-d3f31f657ab9",
    "state" : "in_progress"
  }
}

POST /api/v2/manager/control/service/{service}/heartbeat

Issue a heartbeat in the given service.

Request Parameters
name type description
service path the service name
Response Body
media type data type description
application/json TaskPayload (JSON) a task

Example

Request
POST /api/v2/manager/control/service/west/heartbeat
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "payloadType" : "TaskPayload",
  "payloadVersion" : "1",
  "payload" : {
    "taskId" : "e04ff89a-1529-4fb0-a2e3-977b101cca91",
    "state" : "in_progress"
  }
}

POST /api/v2/manager/control/service/{service}/offline

Puts a data service offline.

Request Parameters
name type description
service path the service name
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/east/offline
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/online

Puts a data service online.

Request Parameters
name type description
service path the service name
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/west/online
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/promote

Promote a data service to primary.

Request Parameters
name type description
service path the service name
Response Body
media type data type description
application/json TaskPayload (JSON) a task

Example

Request
POST /api/v2/manager/control/service/east/promote
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "payloadType" : "TaskPayload",
  "payloadVersion" : "1",
  "payload" : {
    "taskId" : "ee79b359-8b48-4e0c-b3b2-ef91882ce62c",
    "state" : "in_progress"
  }
}

POST /api/v2/manager/control/service/{service}/recover

Recover a data service.

Request Parameters
name type description
service path the service name
Response Body
media type data type description
application/json TaskPayload (JSON) a task

Example

Request
POST /api/v2/manager/control/service/west/recover
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "payloadType" : "TaskPayload",
  "payloadVersion" : "1",
  "payload" : {
    "taskId" : "95732b68-b1ba-4140-abe8-c6f509d0311d",
    "state" : "in_progress"
  }
}

POST /api/v2/manager/control/service/{service}/shun

Shun a data service.

Request Parameters
name type description
service path the service name
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/east/shun
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/switch

Switch the primary node in a service.

Request Parameters
name type description
service path the service name
Response Body
media type data type description
application/json TaskPayload (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/west/switch
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "payloadType" : "TaskPayload",
  "payloadVersion" : "1",
  "payload" : {
    "taskId" : "f5236a49-8deb-43cc-98b0-b27665d9ddc4",
    "state" : "in_progress"
  }
}

POST /api/v2/manager/control/service/{service}/welcome

Welcome a data service.

Request Parameters
name type description
service path the service name
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/west/welcome
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/backup

Backup the datasource in the given data service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json TaskPayload (JSON) a task

Example

Request
POST /api/v2/manager/control/service/west/datasource/db2/backup
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "payloadType" : "TaskPayload",
  "payloadVersion" : "1",
  "payload" : {
    "taskId" : "cb2d38f6-715b-44e5-ba8d-35aa95b7fd43",
    "state" : "in_progress"
  }
}

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/clearArchive

Clear the archive flag of the datasource in the given data service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/west/datasource/db2/clearArchive
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/clearStandby

Clear the standby flag of the datasource in the given data service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/west/datasource/db2/clearStandby
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/delete

Delete the composite datasource in the given service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Codes
code condition
404 if the specified data source or service doesn't exist
500 if an error occurred
Response Body
media type data type description
application/json object (JSON) StringPayload

Example

Request
POST /api/v2/manager/control/service/{service}/datasource/{datasource}/delete
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/drain

Drain connections on the given datasource with optional timeout parameter. Timeout is -1 (infinite) by default. 0 timeout means no wait, equivalent to shun

Request Parameters
name type description default
datasource path name of the datasource  
service path to which the data source belongs  
timeoutSecs query -1
Response Codes
code condition
200 if the data source was correctly set draining connections
400 if the specified timeout was not parseable
500 if another error occurs while draining connections
Response Body
media type data type description
application/json object (JSON)

Example

Request
POST /api/v2/manager/control/service/west/datasource/db2/drain?timeoutSecs=30
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/fail

Fail the datasource of the given data service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/west/datasource/db1/fail
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/master

Make primary the datasource of the given data service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Codes
code condition
200 if the the data source was properly set to primary
500 if an error occurred
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/west/datasource/db2/master
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/offline

Puts the datasource of the given data service offline.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/west/datasource/db2/offline
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/online

Puts the datasource of the given data service online.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/west/datasource/db2/online
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/promote

Promote the datasource in a service to primary.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json TaskPayload (JSON) a task

Example

Request
POST /api/v2/manager/control/service/west/datasource/db2/promote
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "payloadType" : "TaskPayload",
  "payloadVersion" : "1",
  "payload" : {
    "taskId" : "986d4a7d-f1e1-4c7a-85db-43a0c7311394",
    "state" : "in_progress"
  }
}

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/recover

Recover the datasource of the given data service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json TaskPayload (JSON) a task

Example

Request
POST /api/v2/manager/control/service/{service}/datasource/{datasource}/recover
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "payloadType" : "TaskPayload",
  "payloadVersion" : "1",
  "payload" : {
    "taskId" : "c93715a0-9580-49f4-be30-1afaf2491210",
    "state" : "in_progress"
  }
}

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/relay

Make relay the datasource of the given data service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Codes
code condition
200 if the the data source was properly set to relay
500 if an error occurred
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/west/datasource/db2/relay
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/restore

Restore the datasource in the given data service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json TaskPayload (JSON) a task

Example

Request
POST /api/v2/manager/control/service/west/datasource/db2/restore
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "payloadType" : "TaskPayload",
  "payloadVersion" : "1",
  "payload" : {
    "taskId" : "f7c39f80-9983-4407-92d5-f13efb58201e",
    "state" : "in_progress"
  }
}

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/setArchive

Set a datasource as archive in the given data service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/west/datasource/db2/setArchive
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/setStandby

Put the datasource in the given data service to standby.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/west/datasource/db2/setStandby
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/shun

Shun the datasource of the given data service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/west/datasource/db2/shun
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/slave

Make replica the datasource of the given data service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Codes
code condition
200 if the the data source was properly set to replica
500 if an error occurred
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/west/datasource/db2/slave
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/welcome

Welcome the datasource of the given data service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json object (JSON) Http OK if the operation was successful, internal server error otherwise

Example

Request
POST /api/v2/manager/control/service/west/datasource/db2/welcome
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/replicator/master

Make the replicator a master in the given service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json TaskPayload (JSON) a task

Example

Request
POST api/v2/manager/control/service/west/datasource/db2/replicator/master
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "payloadType" : "TaskPayload",
  "payloadVersion" : "1",
  "payload" : {
    "taskId" : "f5ef7ffd-0fc7-47da-9c0d-7c534e90fef6",
    "state" : "in_progress"
  }
}

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/replicator/offline

Put the replicator offline in the given service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json TaskPayload (JSON) a task

Example

Request
POST api/v2/manager/control/service/west/datasource/db2/replicator/offline
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
"payloadType"

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/replicator/online

Put the replicator online in the given service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json TaskPayload (JSON) a task

Example

Request
POST api/v2/manager/control/service/west/datasource/db2/replicator/online
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "payloadType" : "TaskPayload",
  "payloadVersion" : "1",
  "payload" : {
    "taskId" : "f5ef7ffd-0fc7-47da-9c0d-7c534e90fef6",
    "state" : "in_progress"
  }
}

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/replicator/relay

Make the replicator a relay in the given service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json TaskPayload (JSON) a task

Example

Request
POST api/v2/manager/control/service/west/datasource/db4/replicator/relay
Content-Type: application/json
Accept: application/json

                
{
  "payloadType" : "replicator",
  "dataService" : "west",
  "dataSource" : "db1"
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "payloadType" : "TaskPayload",
  "payloadVersion" : "1",
  "payload" : {
    "taskId" : "f5ef7ffd-0fc7-47da-9c0d-7c534e90fef6",
    "state" : "in_progress"
  }
}

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/replicator/slave

Make the replicator a slave in the given service.

Request Parameters
name type description
datasource path the datasource name
service path the service name
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json TaskPayload (JSON) a task

Example

Request
POST api/v2/manager/control/service/west/datasource/db2/replicator/slave
Content-Type: application/json
Accept: application/json

                
{
  "payloadType" : "replicator",
  "dataSource" : "db1"
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "payloadType" : "TaskPayload",
  "payloadVersion" : "1",
  "payload" : {
    "taskId" : "f5ef7ffd-0fc7-47da-9c0d-7c534e90fef6",
    "state" : "in_progress"
  }
}

POST /api/v2/manager/control/service/{service}/datasource/{datasource}/{component}/{command}

Execute the command on the component for the datasource in the given data service.

Request Parameters
name type description
command path the command to execute on the component: start, stop, restart, status, tail
component path the component: manager, replicator, connector
datasource path the datasource name
service path the service name
Response Body
media type data type description
application/json ControlCommandPayload (JSON) status of the service

Example

Request
POST api/v2/manager/control/service/west/datasource/db2/replicator/status
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "payloadType" : "ControlCommandPayload",
  "payloadVersion" : "1",
  "payload" : {
    "status" : "running",
    "pid" : 33347
  }
}