7.1.29 API to check the communication status of the job distribution delay reduction function

This API checks the communication status of the job distribution delay reduction function on the manager host. Depending on the specified parameters, one of the following operations is performed:

Start checking the communication status
Stop checking the communication status
Check the communication status

This API can be used to perform operations on execution agents only if the job distribution delay reduction function is enabled. If this function is disabled, all operations performed on execution agents by using this API result in an error.

For details about job distribution delay reduction function, see 2.5.5 Considering reduction of job distribution delay in the JP1/Automatic Job Management System 3 System Design (Configuration) Guide.

Execution privileges

The logged-in JP1 user must be mapped with an OS user who has the following administrator privileges:

In Windows: Administrators privileges
In UNIX: Superuser privileges

Request format

Request line

POST /application/component/apiVersion/objects/execAgents/actions/check/invoke httpVersion

Message Body

{
  "parameters":{
    "manager":"manager-host-name-or-IP-address",
    "action":"target-operation"
  }
}

API version

Information that uniquely identifies a resource

None

Parameter

The following table lists and describes the parameters that can be specified for parameters in the request message body.

Table 7‒29: List of parameters for the API to check the communication status of the job distribution delay reduction function
Parameter	Data type	Description of the value	Required?
`manager`	string	Specify the manager host name or IP address by using a character string in the range from 1 to 255 bytes.	Y
`action`	string	Specify a character string that indicates the target operation. To start checking the communication status, specify `start`. To stop checking the communication status, specify `stop`. To check the communication status, specify `status`.	Y

Status code

The following table lists and describes the status codes returned as a response:

Status code	Message	Description
200	OK	The communication status of the job distribution delay reduction function was checked successfully.
400	Bad Request	The argument is invalid.
401	Unauthorized	Authentication is required.
403	Forbidden	The operator does not have execution permission.
404	Not found	The operator does not have access permission for the resource, or the resource does not exist.
412	Precondition failed	The Web Console server is not available.
500	Server-side error	A processing error occurred in the Web Console server.

Response format

Response message body

{
  "results":[Execution-agent-operation-result-object]
}

Return values

If the status code is 200, the following information is returned:

Member	Data type	Description
`results`	object[]	Returns an array of the execution agent operation result objects. In the returned array, the execution result is stored in element 0. For details about the execution agent operation result object, see 7.3.6 Execution agent operation result object.

Member

Data type

Description

results

object[]

Returns an array of the execution agent operation result objects. In the returned array, the execution result is stored in element 0.

For details about the execution agent operation result object, see 7.3.6 Execution agent operation result object.

Cautionary note

Even if an error has occurred in JP1/AJS3 - Web Console, the operation on the execution agent might be successful on the manager host.

Example

The following shows an example of using the API to check the communication status of the job distribution delay reduction function.

Example request:

POST /ajs/api/v1/objects/execAgents/actions/check/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-Type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "action":"start"
  }
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-store, no-cache, max-age=0
Date: Tue, 25 Aug 2020 11:12:38 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server
 
{
    "results":
    [
        {
            "execAgent":"",
            "rtnCode":"0",
            "output":
            {
                "text":"KNAC1200-I Request for starting the communication status confirmation was issued to the agent monitoring process.",
                "serverTime":"",
                "statuses":null,
                "definitions":null
            }
        }
    ]
}

To Page Top