VoiceGateway

Read reported worker metric samples

GET
/api/v1/org/{orgId}/project/{projectId}/workers

Authorization

cookievg_session<token>

The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.

Path Parameters

orgId*string

Authorised orgId; the server must verify organisation/project ownership before any read.

Length1 <= length
projectId*string

Authorised projectId; the server must verify organisation/project ownership before any read.

Length1 <= length

Response Body

Authorised read result. Null means unreported, never zero. Source-specific coverage limits remain visible.

application/json
  1. response
source*string
workers*array<>
endpoints?array<>

Every endpoint the project lists, with its own read status, so an endpoint that has never answered is named.

sourceStatus?

How fresh a sampled read is. Present when the worker samples the layer; a layer never read successfully answers 503 source_unavailable instead.

Example Request
curl -X GET 'https://example.com/api/v1/org/string/project/string/workers'
Example Response
{  "source": "string",  "workers": [    {      "id": "string",      "nodename": "string",      "loadThreshold": 0,      "host": "string",      "samples": [        {          "t": "2019-08-24T14:15:22Z",          "load": 0,          "activeJobs": 0        }      ],      "endpointId": "string",      "sourceStatus": {        "lastReadAt": "2019-08-24T14:15:22Z",        "lastGoodReadAt": "2019-08-24T14:15:22Z",        "errorClass": "unauthenticated"      }    }  ],  "endpoints": [    {      "id": "string",      "host": "string",      "sourceStatus": {        "lastReadAt": "2019-08-24T14:15:22Z",        "lastGoodReadAt": "2019-08-24T14:15:22Z",        "errorClass": "unauthenticated"      }    }  ],  "sourceStatus": {    "lastReadAt": "2019-08-24T14:15:22Z",    "lastGoodReadAt": "2019-08-24T14:15:22Z",    "errorClass": "unauthenticated"  }}

Was this page helpful?