Start Configuration Test for a Cluster
/v2/scheduler/startClusterUnitTest
Request
- application/json
-
jde-AIS-Auth: string
Token
-
jde-AIS-Auth-Device: string
Device Name
-
jde-AIS-MonitorOnStart: boolean
Monitor on Start
-
jde-AIS-MonitorRequest: string
Monitor RequestAllowed Values:
[ "monitorRequest", "monitorRequestIO" ]
object
-
deviceName:
string
An identifier for the device making the service call. If not provided, the requesting IP address is used.
-
environment:
string
Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
-
jasserver:
string
The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used.
-
jobEndpointRequested:
string
Endpoint or service name to use for scheduling.
-
jobServicePath:
array jobServicePath
The service path for the job to be scheduled.
-
password:
string
The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
-
psToken:
string
Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server.
-
role:
string
The role to use for login. If not specified, the default role configured for the AIS Server will be used.
-
scheduleCronString:
string
The cron string that provides r the schedule of the requested endpoint.
-
scheduleIntervalMinutes:
integer(int32)
The interval in minutes for the desired endpoint to be scheduled.
-
schedulerHosts:
array schedulerHosts
A list of scheduler hosts.
-
schedulerServices:
array schedulerServices
A list of scheduler services.
-
token:
string
The AIS token, which is required if other authentication methods are not being used.
-
username:
string
JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used.
array
array
-
Array of:
object SchedulerRequest
The input to the scheduler services.
array
-
Array of:
object SchedulerService
The input to the scheduler services where a list is requested.
object
-
environment:
string
-
role:
string
-
serviceEndpoint(required):
string
Endpoint or service name to use for scheduling.
-
username:
string
Response
- application/json
200 Response
400 Response
403 Response
415 Response
444 Response
object
-
errorText:
string
-
exception:
string
The class of the exception if an exception was thrown.
-
exceptionId:
string
ExceptionId, only if an exception record was written to the F980060
-
message:
string
Details about the error.
-
status:
string
Allowed Values:
[ "ERROR", "WARNING" ]
Status determined by exception handling -
timeStamp:
string
The timestamp indicating the time the error message was returned.
-
type:
string
Optional type of error
-
userDefinedErrorText:
string
Optional error text added to an orchestration step.
500 Response
object
-
errorText:
string
-
exception:
string
The class of the exception if an exception was thrown.
-
exceptionId:
string
ExceptionId, only if an exception record was written to the F980060
-
message:
string
Details about the error.
-
status:
string
Allowed Values:
[ "ERROR", "WARNING" ]
Status determined by exception handling -
timeStamp:
string
The timestamp indicating the time the error message was returned.
-
type:
string
Optional type of error
-
userDefinedErrorText:
string
Optional error text added to an orchestration step.
Examples
Example Request
The following shows an example of a scheduler startClusterUnitTest request which starts jobs, one for each host requested, and runs them in sequence. If more than one host is requested, the hosts are started and stopped, testing that all of the hosts are correctly configured and that each host executes jobs successfully. Multiple hosts are only supported when scheduler resilience is configured on all hosts. Single host configurations can also be tested.
The token passed in this example was received from a separate token request. You can also use other supported authentication methods.
IMPORTANT: If using a token for authentication, you must get the token using the v2 tokenrequest service and use that token for all calls to scheduler services.
curl -X POST -H "Content-Type:application/json" http://ais_server_host/jderest/v2/scheduler/startClusterUnitTest -d { "token": "044QF2SLgaM6vZX081eq8KsVi6XcJiiFL5un5ACH+eBGUg=MDE5MDEyMTY4NzY4NjcwMjI2NzExNzcyNDEwLjE1OS45OS43MzE0NzkxNDU4NDM4ODU=", "schedulerHosts": [ { "protocol": "ais_server_protocol", "host": ???ais_server_host_1", "port": " ais_server_port" }, { "protocol": "ais_server_protocol", "host": "ais_server_host_2", "port": " ais_server_port" } ] }
Example Response
The following example shows the contents of the response body.
{ "schedulersStartStatus": { "successCount": 2, "failCount": 0, "successHosts": [ { "protocol": "ais_server_protocol", "host": "ais_server_host_1", "port": " ais_server_port" "httpStatus": 200, "serviceReturnPayload": { "schedulerStarted": "ais_server_protocol://ais_server_host_1:ais_server_port" } }, "protocol": "ais_server_protocol", "host": "ais_server_host_2", "port": " ais_server_port" "httpStatus": 200, "serviceReturnPayload": { "schedulerStarted": "ais_server_protocol://ais_server_host_2:ais_server_port" } } ], "failHosts": [] } }