Change operation settings for an Agent instance

This is an API function to change operation settings for an Agent instance. This API function corresponds to the operation when you select the [Change Operation Settings] by using the [Action] button that is displayed by selecting the [Agent] on the operation screen of Manager.

= Remarks =

The following set of API functions is actually the same. (/api/v1/agents/agentId)

Change status of an Agent instance
Change operation settings for an Agent instance
Change unit
Change profile
Change a module version

In this manual, to write each API function separately for individual purposes, the request parameters are changed according to the purposes.

Format
Request body (JSON format)
Request parameter (JSON format)
Request parameter (Path format)

Item name	Request parameter	Type	Value
Auto Resend Retry Count	autoResendingRetryCount	Integer	Specify the number of times that Agent retries a transfer when a communication error causes a failure during a file transfer to HULFT. 0 to 255 (times)
Auto Resend Retry Interval	autoResendingRetryInterval	Integer	Specify the amount of time to wait before Agent retries a transfer when a communication error causes a failure during a file transfer to HULFT. 0 to 9999 (seconds)
Communication Time Limit	communicationTimeLimitEnabled	Boolean	Specify whether the time when Agent communicates with Manager is restricted. •　true: Communication hour is restricted •　false: Communication hour is not restricted
Connection Retry Count	connectionRetryCount	Integer	Specify the number of times to retry a connection when Agent fails to connect to HULFT. 0 to 9999 (times)
Connection Retry Interval	connectionRetryInterval	Integer	Specify the amount of time to wait before Agent retries a connection when Agent fails to connect to HULFT. 0 to 9999 (seconds)
End Time (Communication Time Limit)	endCommunicationTimeHour	Integer	Specify the time of day when Agent ends the communication with Manager if you limit the time when Agent can communicate with Manager. Specify the value with "Start Time". 0 to 23 (O'clock)
Log Output Mode	historyMode	Integer	Specify whether Agent always outputs Send Logs or whether Agent outputs Send Logs only when an error occurs. 0 \| 1 　•　0: output send logs only when an error occurs •　1: output send logs always
Job Timeout (Time)	jobTimeout	Integer	Specify the amount of time to wait before generating an error when the result of a job for a file transfer or file distribution is not returned. 10 to 86400 (seconds)
Job Timeout (Valid or invalid)	jobTimeoutEnabled	Boolean	Specify whether Agent generates an error or not when the result of a job for a file transfer or file distribution is not returned. If you set it invalid, Agent keeps waiting for a result without timing out. •　true: valid •　false: invalid
Agent Name	name	String	Maximum 64 characters
Polling Interval	pollingInterval	String	Specify the interval at which Agent polls Manager. "1s" to "59d" Specify numeral (1 to 59) with a unit (second: s, minute: m, hour: h, or day: d).
Receive Queue Polling Interval	receivingQueuePollingInterval	String	Specify the interval at which Agent polls the Receive Task Queue. "1s" to "59d" Specify numeral (1 to 59) with a unit (second: s, minute: m, hour: h, or day: d).
Size of Receive Task Queue	receivingTaskQueueSize	Integer	Specify the maximum number of Receive Tasks that can be registered in the Receive Task Queue for the file distribution function. If the number of tasks exceeds the maximum, the new task will not be added to the queue. 1 to 9999　(items)
Request Timeout	requestTimeout	Integer	Specify the time until a timeout occurs when Agent does not receive a response from Manager during any communications between Agent and Manager. If a timeout occurs, Agent regards the state as a communication error and disconnects the communication. 10 to 259200 (seconds)
Send Log Pool Size	sendLogPoolSize	String	Specify the amount of Send Logs that are kept in Agent. "1m" to "1024m" Specify numeral (1 to 1024) with a unit (m: megabyte).
Send Process Multiplex Level	sendProcessMultiplexLevel	Integer	Specify the maximum number of send processes that Agent can start at the same time. If the number of transfer files in an instance of Agent exceeds the maximum number of send processes, Agent puts off transferring the extra files until the next trigger fire after the time of the monitoring interval that is specified on the Transfer Settings screen elapsed. 1 to 99
Socket Buffer Size (Byte count)	socketBufferSize	Integer	Specify the socket buffer size that is applied to socket communication to HULFT by Agent. 4096 to 2147483647 (bytes)
Socket Buffer Size (Type)	socketBufferSizeMode	String	Specify the type of socket buffer that is used for socket communication to HULFT by Agent. When you select User Specified, specify the byte count for socket buffer size. "DEFAULT" \| "SPECIFIED" •　DEFAULT: default •　SPECIFIED: user specified
Socket Read Timeout	socketTimeout	Integer	Specify the time until a timeout occurs when Agent does not receive a response from HULFT during a socket communication between Agent and HULFT. If a timeout occurs, Agent regards the state as a communication error and disconnects the communication. 10 to 259200 (seconds)
Start Time (Communication Time Limit)	startCommunicationTimeHour	Integer	Specify the time of day when Agent can start to communicate with Manager if you limit the time when Agent can communicate with Manager. Specify the value with "End Time". 0 to 23 (O'clock)
Trace Log Pool Size	traceLogPoolSize	String	Specify the amount of Trace Logs that are kept in Agent. "1m" to "1024m" Specify numeral (1 to 1024) with a unit (m: megabyte).