This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Instance Statistics

This section explains how to get statistics on instances used as workers.

Request

GET https://<hostname>/api/v1/workers/statistics

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

None.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 (OK).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

Property	Type	Description
countOfWorkers	integer	Shows how many workers are available.
runningWorkers	integer	Shows the number of workers that are running.
totalCycleTime	string	Shows the total cycling time for each of the workers.
usedWorkers	integer	Shows the number of used workers.
deployedWorkers	integer	Shows the total number of deployed workers.

Example

Request:

GET https://abc.ukwest.cloudapp.azure.com/api/v1/workers/statistics

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"countOfWorkers": 2,

"runningWorkers": 0,

"totalCycleTime": "01:41:42.9735370",

"usedWorkers": 5,

"deployedWorkers": 5

}