REST API Runtime Analytics

INFO

Add the following command after the username and password to receive more meaningful HTTP errors:

-w"\n%{http_code}\n"

This command can be added to each call.

Start Runtime Analytics

Request Method GET
Description

Returns information on a specified connector within Datameer X including version number, class name, file information (uuid, path, description, name), typeID, and properties information.

URI Syntax
curl -u '<username>:<password>' -X GET 'http:// <Datameer-serverIP> /api/admin/runtime-analytics/start'
Example Response

No response given.

Verification

To verify action, use the View Status command.  

{
  "data": {
    "status": {
      "state": "[UP]|[STARTING]",
      "message": "",
      "embedded": true
    }
  },
  "_links": {
    "self": {
      "href": "/api/admin/runtime-analytics"
    }
  }
}

Stop Runtime Analytics

Request Method GET
Description

Returns information on a specified connector within Datameer X including version number, class name, file information (uuid, path, description, name), typeID, and properties information.

URI Syntax
curl -u '<username>:<password>' -X GET 'http://<Datameer-serverIP>/api/admin/runtime-analytics/stop'
Example Response

No response given.


Verification

To verify action, use the View Status command.  

{
  "data": {
    "status": {
      "state": "STOPPED",
      "message": "",
      "embedded": true
    }
  },
  "_links": {
    "self": {
      "href": "/api/admin/runtime-analytics"
    }
  }
}

View Status of Runtime Analytics

Request Method GET
Description

Returns information on a specified connector within Datameer X including version number, class name, file information (uuid, path, description, name), typeID, and properties information.

URI Syntax
curl -u '<username>:<password>' -X GET 'http://<Datameer-serverIP>:<port-number>/api/admin/runtime-analytics'
Example Response
{
  "data": {
    "status": {
      "state": "UP",
      "message": "",
      "embedded": true
    }
  },
  "_links": {
    "self": {
      "href": "/api/admin/runtime-analytics"
    }
  }
}