7.1.36 API to exclude or add execution agents, or to change their priority levels

This API excludes or adds execution agents for an execution agent group that is registered on the manager host. The API also changes the priority levels of such execution agents.

Execution privileges

The logged-in JP1 user must have the following JP1 permission:

JP1_JPQ_Admin privileges

Request format

Request line

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

Request message body

{
  "parameters":{
    "manager":"manager-host-name-or-IP-address",
    "execAgentGroup":"execution-agent-group-name",
    "action":"target-operation",
    "execAgent":"execution-agent-name",
    "priority":priority
  }
}

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‒36: List of parameters for the API to exclude or add execution agents, or to change their priority levels
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
`execAgentGroup`	string	Specify the name of the execution agent group. Specify a character string in the range from 1 to 255 bytes.	Y
`action`	string	Specify a character string to indicate the target operation. To exclude an execution agent, specify `remove`. To add an execution agent, specify `add`. To change the priority level of an execution agent, specify `changePriority`.	Y
`execAgent`	string	Specify the name of the execution agent that is to be excluded or added or whose priority level is to be changed, by using a character string in the range from 1 to 255 bytes. Each execution agent group name must be a character string in the range from 1 to 255 bytes.	Y
`priority`	int	Specify the priority by using a numeric value in the range from `1` to `16`. Do not specify this parameter if you specify `remove` for the `action` parameter or if you do not want to specify the priority.	--

Status code

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

Status code	Message	Description
200	OK	An execution agent was excluded or added successfully, or the priority level of the execution agent was changed 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 operation result is stored in element 0. Also, if the command terminates abnormally on the manager host, a non-zero value is stored as the result code of the target processing and `KNAK3696-E` is stored as a message in the returned array. 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 operation result is stored in element 0.

Also, if the command terminates abnormally on the manager host, a non-zero value is stored as the result code of the target processing and KNAK3696-E is stored as a message in the returned array.

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 add an execution agent to the specified execution agent group.

Example request:

POST /ajs/api/v1/objects/execAgents/actions/chengeLinkAgent/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-Type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "execAgentGroup":"AGTG01",
    "action":"add",
    "execAgent":"AGT03",
    "priority":1
  }
}

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:51:42 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server
 
{
    "results":
    [
        {
            "execAgent":"AGTG01",
            "rtnCode":"0",
            "output":null
        }
    ]
}

To Page Top