Summary
Get the current and future states of the task and job workers
Description
Get the current and future states of the task and job workers
Route
GET /workflow_engine/workers/status
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| This method has no parameters |
Copied to Clipboard
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
Statuses of the job and task worker |
Copied to Clipboard
{
"jobWorker": {
"running": false,
"clusterValue": "enabled",
"localValue": "not defined",
"startupValue": true
},
"taskWorker": {
"running": false,
"clusterValue": "not defined",
"localValue": "not defined",
"startupValue": false
}
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"jobWorker": {
"type": "object",
"properties": {
"running": {
"type": "boolean",
"description": "Whether the worker is currently running"
},
"clusterValue": {
"type": "string",
"enum": [
"enabled",
"disabled",
"not defined"
],
"description": "Whether the service_config was set to enable this worker"
},
"localValue": {
"type": "string",
"enum": [
"enabled",
"disabled",
"not defined"
],
"description": "Whether the properties.json was set to enable this worker"
},
"startupValue": {
"type": "boolean",
"description": "Whether the clusterValue and localValue combined allow the worker to start"
}
}
},
"taskWorker": {
"type": "object",
"properties": {
"running": {
"type": "boolean",
"description": "Whether the worker is currently running"
},
"clusterValue": {
"type": "string",
"enum": [
"enabled",
"disabled",
"not defined"
],
"description": "Whether the service_config was set to enable this worker"
},
"localValue": {
"type": "string",
"enum": [
"enabled",
"disabled",
"not defined"
],
"description": "Whether the properties.json was set to enable this worker"
},
"startupValue": {
"type": "boolean",
"description": "Whether the clusterValue and localValue combined allow the worker to start"
}
}
}
}
}
