Skip to content

~crosstalk.api.worker.running

tristanls edited this page Dec 2, 2012 · 1 revision

List currently running workers.

Since Version 0.1.0
Scope
accepts: public responds as: ~crosstalk

Parameters

All parameters are optional, unless otherwise indicated.

crosstalkToken 5uua22922ausllwibb1amms7a761n23n4nasAJFDUA17711 required Crosstalk authorization token

Response fields

Response

workers [ { WORKER }, { WORKER }, ... ] List of running workers
workers/WORKER {"worker":"myworker@1.2.3","workerInstance":"crosstalk-drone-..."} Each worker in workers list has worker name+version and worker instance specified

Error

errorCode 400 Error code compatible with HTTP status codes
message A more informative error message Error message

Examples

Request:

crosstalk.emit( 
  '~crosstalk.api.worker.running',
  {
    crosstalkToken : "5uua22922ausllwibb1amms7a761n23n4nasAJFDUA17711",
  },
  '~crosstalk',
  function ( error, response ) { /* ... */ }
);

Response:

{ 
  workers : [
    { worker : "myWorker@1.2.1", workerInstance : "crosstalk-drone-worker-e5c41eb9-8ab8-4a80-b862-465f60a7f372" },
    { worker : "myWorker@1.0.0", workerInstance : "crosstalk-drone-worker-e5c878b9-8ab8-4a80-b862-465f60a7f372" },
    { worker : "someWorker@1.0.2", workerInstance : "crosstalk-drone-worker-eda41eb9-8ab8-4a80-b862-465f60a7f372" }
  ]
}

Error:

{ 
  errorCode : 400, 
  message : "Bad Request" 
}