エージェント動作設定変更

エージェントの動作設定を変更するためのAPIです。Manager画面で［エージェント］を選択したときに表示される画面の［操作］ボタンで、［動作設定変更］を選択したときの操作に相当します。

= 備考 =

次のAPIは同一です (/api/v1/agents/agentId)。

  • エージェントステータス変更API
  • エージェント動作設定変更API
  • ユニット変更API
  • プロファイル変更API
  • モジュールバージョン変更API

このマニュアルでは、目的に応じたリクエストパラメータに変更して、個別に記載しています。
書式
curl -X PUT --header 'Content-Type: application/json'
            --header 'X-API-KEY:APIキー'
            -d 'JSON形式のリクエストボディ'
            'http://ホスト名:ポート番号/api/v1/agents/agentId'
リクエストボディ（JSON形式）
{
  "autoResendingRetryCount": 0,
  "autoResendingRetryInterval": 0,
  "communicationTimeLimitEnabled": true,
  "connectionRetryCount": 0,
  "connectionRetryInterval": 0,
  "endCommunicationTimeHour": 0,
  "historyMode": 0,
  "jobTimeout": 0,
  "jobTimeoutEnabled": true,
  "name": "string",
  "pollingInterval": "string",
  "receivingQueuePollingInterval": "string",
  "receivingTaskQueueSize": 0,
  "requestTimeout": 0,
  "sendLogPoolSize": "string",
  "sendProcessMultiplexLevel": 0,
  "socketBufferSize": 0,
  "socketBufferSizeMode": "string",
  "socketTimeout": 0,
  "startCommunicationTimeHour": 0,
  "traceLogPoolSize": "string"
}
リクエストパラメータ（JSON形式）
項目名 リクエストパラメータ 型 値 省略値
自動再配信リトライ回数 autoResendingRetryCount 数値

通信エラーでHULFTへのファイル転送に失敗したとき、Agentが再配信を試みる回数です。

0 ～ 255 (単位は回)

  
自動再配信リトライ間隔 autoResendingRetryInterval 数値

通信エラーでHULFTへのファイル転送に失敗したとき、Agentが再配信を試みるまでの待ち時間です。

0 ～ 9999 (単位は秒)

  
通信時間制限 communicationTimeLimitEnabled 論理型

AgentがManagerと通信する時間帯を制限するかどうかを指定します。

•　true：通信時間帯を制限する

•　false：通信時間帯を制限しない

  
コネクションリトライ回数 connectionRetryCount 数値

AgentがHULFTとの接続に失敗した場合に、再接続を試みる回数です。

0 ～ 9999 (単位は回)

  
コネクションリトライ間隔 connectionRetryInterval 数値

AgentがHULFTとの接続に失敗した場合に、再接続を試みるまでの待ち時間です。

0 ～ 9999 (単位は秒)

  
終了時刻（通信時間制限） endCommunicationTimeHour 数値

AgentがManagerと通信する時間帯を制限する場合、通信できる時間帯が終わる時刻を指定します。開始時刻と一緒に指定します。

0～23 (単位は時)

  
履歴出力モード historyMode 数値

配信履歴を常時出力するか、エラーが発生したときにだけ出力するかを選択します。

0 | 1

•　0：異常時のみ履歴出力する

•　1：常時履歴出力する

  

ジョブタイムアウト

（時間）

 jobTimeout 数値

ファイル転送およびファイル配付の際に実行するジョブの実行結果が返ってこなかったとき、エラーにするまでの待ち時間です。

10 ～ 86400 (単位は秒)

  

ジョブタイムアウト

（有効/無効）

 jobTimeoutEnabled

論理型

ファイル転送およびファイル配付の際に実行するジョブの実行結果が返ってこなかったとき、エラーにするかどうかを指定します。

無効にした場合は、実行結果を待ち続けます。

•　true：有効

•　false：無効

  
エージェント名 name 文字列 1文字以上、64文字以下  
ポーリング間隔 pollingInterval 文字列

AgentがManagerをポーリングする間隔を指定します。

"1s" ～ "59d"

数値（1～59）と単位を入力する。

(単位は秒：s、分：m、時間：h、日：d)

  
受信キューポーリング間隔 receivingQueuePollingInterval 文字列

Agentが受信タスクキューをポーリングする間隔です。

"1s" ～ "59d"

数値（1～59）と単位を入力する。

(単位は秒：s、分：m、時間：h、日：d)

  
受信タスクキューサイズ receivingTaskQueueSize 数値

受信タスクキューに登録できるファイル配付機能の受信タスクの最大数です。

受信タスクが最大数を超える場合、新しいタスクはキューに追加されません。

1 ～ 9999　(単位は個)

  
リクエストタイムアウト requestTimeout 数値

AgentからManagerへのすべての通信で、Managerからの応答がなかった場合に、Agentがタイムアウトするまでの時間を指定します。

タイムアウトした場合、Agentは通信異常と判断して通信を切断します。

10 ～ 259200 (単位は秒)

  
配信履歴保管サイズ sendLogPoolSize 文字列

Agentに保管する配信履歴の量を指定します。

"1m"～"1024m"

数値（1 ～ 1024）と単位を入力する。

(単位はメガバイト：m)

  
配信多重度 sendProcessMultiplexLevel 数値

Agentが同時に起動できる配信プロセスの最大数を指定します。

Agent内の転送ファイルの数が配信プロセスの最大数を超えた場合、Agentは超えた分の転送ファイルを、プロファイル転送設定画面で指定された［監視間隔］が経過したあとの、次回のトリガー発火タイミングに持ち越します。

1 ～ 99

  

ソケットバッファサイズ

（バイト数）

 socketBufferSize 数値

AgentがHULFTとのソケット通信で使用するソケットバッファサイズを指定します。

4096～2147483647 (単位はバイト)

  

ソケットバッファサイズ

（タイプ）

 socketBufferSizeMode 文字列

AgentがHULFTとのソケット通信で使用するソケットバッファのタイプを指定します。

［ユーザー指定］を選択した場合は、バイト数を指定します。

"DEFAULT" | "SPECIFIED"

•　DEFAULT：デフォルト

•　SPECIFIED：ユーザー指定

  
ソケットリードタイムアウト socketTimeout 数値

AgentとHULFTとのソケット通信で、HULFTからの応答がなかった場合に、Agentがタイムアウトするまでの時間です。

タイムアウトした場合、Agentは通信異常と判断して通信を切断します。

10 ～ 259200 (単位は秒)

  
開始時刻（通信時間制限） startCommunicationTimeHour 数値

AgentがManagerと通信する時間帯を制限する場合、通信できる時間帯が始まる時刻を指定します。終了時刻と一緒に指定します。

0～23 (単位は時)

  
トレースログ保管サイズ traceLogPoolSize 文字列

Agentに保管するトレースログの量を指定します。

"1m" ～ "1024m"

数値（1 ～ 1024）と単位を入力する。

(単位はメガバイト：m)

  
リクエストパラメータ（パス形式）
項目名 リクエストパラメータ 型 値 省略値
エージェントID agentId 文字列   省略不可