エージェント詳細取得

指定したエージェントの詳細を取得するためのAPIです。Manager画面で［エージェント］を選択したときに表示される画面の［詳細］ボタンの操作に相当します。

= 備考 = エージェント一覧取得APIとの違いは、レスポンスに次のパラメータが含まれないことです。 content階層（階層下のパラメータは、一覧取得APIと詳細取得APIですべて同じです） first last number numberOfElements size sort totalElements totalPages

書式

curl -X GET --header 'Accept: application/json' --header 'X-API-KEY:APIキー' 'http://ホスト名:ポート番号/api/v1/agents/agentId'

リクエストパラメータ（パス形式）

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

レスポンス

{ "agentId": "string", "agentVersion": 0, "agentVersionSyncronized": true, "basicSettings": { "autoResendingRetryCount": 0, "autoResendingRetryInterval": 0, "connectionRetryCount": 0, "connectionRetryInterval": 0, "historyMode": 0, "jobTimeout": 0, "jobTimeoutEnabled": true, "pollingInterval": "string", "receivingQueuePollingInterval": "string", "receivingTaskQueueSize": 0, "requestTimeout": 0, "sendLogPoolSize": "string", "sendProcessMultiplexLevel": 0, "socketBufferSize": 0, "socketBufferSizeMode": "string", "socketTimeout": 0, "traceLogPoolSize": "string", "communicationTimeLimitEnabled": true, "startCommunicationTimeHour": 0, "endCommunicationTimeHour": 0 }, "bit": "string", "cpu": "string", "deviceAccessLog": { "accessedDate": 0, "agentId": "string", "agentVersion": 0, "attachedModuleVersion": "string", "deviceAccessLogId": "string", "moduleVersion": "string", "pollingInterval": 0, "profileId": "string", "profileVersion": 0, "type": "string", "unitId": "string", "unitVersion": 0 }, "host": "string", "lockDown": { "autoResendingRetryCount": true, "autoResendingRetryInterval": true, "connectionRetryCount": true, "connectionRetryInterval": true, "historyMode": true, "jobTimeout": true, "jobTimeoutEnabled": true, "pollingInterval": true, "receivingQueuePollingInterval": true, "requestTimeout": true, "sendLogPoolSize": true, "sendProcessMultiplexLevel": true, "socketBufferSize": true, "socketTimeout": true, "traceLogPoolSize": true, "communicationTimeLimitEnabled": true, "startCommunicationTimeHour": true, "endCommunicationTimeHour": true }, "macAddress": "string", "moduleVersion": "string", "moduleVersionSyncronized": true, "moduleVersionUpdated": true, "name": "string", "nextSyncronizationScheduledTime": 0, "os": "string", "otherInfo": { "region": 0, "floating": "string" }, "profileId": "string", "profileName": "string", "profileVersionSyncronized": true, "profileVersionUpdated": true, "registrationDate": 0, "remarks": "string", "sendLog": { "agentId": "string", "agentName": "string", "cipherType": "string", "compressedRate": 0, "dTelegramLen": 0, "dataSize": 0, "detailCode": 0, "errorJobExitCode": 0, "errorJobName": "string", "exitCode": 0, "fileId": "string", "hostName": "string", "latestProcessId": "string", "latestTransferId": "string", "preJobExitCode": 0, "preJobName": "string", "profileId": "string", "profileName": "string", "recordCount": 0, "sendLogId": "string", "sndEndTimeStr": "string", "sndEndTimeUtc": 0, "sndFileName": "string", "sndStartTimeStr": "string", "sndStartTimeUtc": 0, "startProcessId": "string", "startTransferId": "string", "successJobExitCode": 0, "successJobName": "string", "transferRate": 0, "transferType": "string", "triggerEvent": 0, "triggerStatus": 0, "unitId": "string", "unitName": "string" }, "session": "string", "status": "string", "unitId": "string", "unitName": "string", "unitVersionSyncronized": true, "unitVersionUpdated": true }

レスポンスパラメータ

項目名	レスポンスパラメータ		型	値
エージェントID	agentId		文字列
エージェントバージョン （設定履歴）	agentVersion		数値	エージェントの設定履歴を管理するための値が返却されます。 アクティベートした直後は「1」ですが、設定を変えるたびに値が1ずつ増えます。
モジュールの同期	agentVersionSyncronized		論理型	•　true：同期済み •　false：同期待ち
自動再配信リトライ回数	basicSettings	autoResendingRetryCount	数値	0 ～ 9999　(単位は回)
自動再配信リトライ間隔		autoResendingRetryInterval	数値	0 ～ 9999　(単位は秒)
コネクションリトライ回数		connectionRetryCount	数値	0 ～ 9999　(単位は回)
コネクションリトライ間隔		connectionRetryInterval	数値	0 ～ 9999　(単位は秒)
履歴出力モード		historyMode	数値	0 | 1 •　0：異常時のみ履歴出力 •　1：常時履歴出力
ジョブタイムアウト(時間)		jobTimeout	数値	10 ～ 86400　(単位は秒) タイムアウトが「無効」の場合は、「有効」だったときの値が返却されます。
ジョブタイムアウト(有効/無効)		jobTimeoutEnabled	論理型	•　true：有効 •　false：無効

項目名	レスポンスパラメータ		型	値
ポーリング間隔	basicSettings	pollingInterval	文字列	数値（1～59）と単位が返却されます。 (単位は秒：s、分：m、時間：h、日：d)
受信キューポーリング間隔		receivingQueuePollingInterval	文字列	数値（1～59）と単位が返却されます。 (単位は秒：s、分：m、時間：h、日：d)
受信タスクキューサイズ		receivingTaskQueueSize	数値	1 ～ 9999　(単位は個)
リクエストタイムアウト		requestTimeout	数値	10 ～ 259200 (単位は秒)
配信履歴保管サイズ		sendLogPoolSize	文字列	数値（1～1024）と単位が返却されます。 (単位はメガバイト：m)
配信多重度		sendProcessMultiplexLevel	数値	1 ～ 99　(単位は個)
ソケットバッファサイズ (バイト数)		socketBufferSize	数値	•　「socketBufferSizeMode」が「DEFAULT」の場合：「SPECIFIED」で指定していたときの値が返却されます。初期値はNULLです。 •　「socketBufferSizeMode」が「SPECIFIED」の場合：4096 ～ 2147483647 (単位はバイト)
ソケットバッファサイズ (タイプ)		socketBufferSizeMode	文字列	"DEFAULT" | "SPECIFIED" •　DEFAULT：デフォルト •　SPECIFIED：ユーザー指定
ソケットリードタイムアウト		socketTimeout	数値	10 ～ 259200　(単位は秒)
トレースログ保管サイズ		traceLogPoolSize	文字列	数値（1～1024）と単位が返却されます。 　(単位はメガバイト：m)
通信時間制限		communicationTimeLimitEnabled	論理型	•　true：通信時間帯を制限する •　false：通信時間帯を制限しない
開始時刻 (通信時間制限)		startCommunicationTimeHour	数値	0　～ 23　(単位は時)
終了時刻 (通信時間制限)		endCommunicationTimeHour	数値	0 ～ 23　(単位は時)
Agentビット数	bit		文字列	"32" | "64" Agentモジュールのビット数が返却されます。
Agentアーキテクチャ	cpu		文字列	Agentが動作するcpuアーキテクチャが返却されます。 例：x86_84
アクセス日時	deviceAccessLog	accessedDate	数値	「yyyyMMddHHmmssSSS」の形式で返却されます。 例：20171114142949096
エージェントID		agentId	文字列
エージェントバージョン （設定履歴）		agentVersion	数値	エージェントの設定履歴を管理するための値が返却されます。 アクティベートした直後は「1」ですが、設定を変えるたびに値が1ずつ増えます。
モジュールバージョン（現在）		attachedModuleVersion	文字列	現在エージェントに適用されているモジュールのバージョンが返却されます。 例："V01L04R00P00"
アクセスログID		deviceAccessLogId	文字列
モジュールバージョン （適用予定）		moduleVersion	文字列	現在の、もしくは、適用予定のモジュールのバージョンが返却されます。 例："V01L04R00P00"
ポーリング間隔		pollingInterval	数値	数値が返却されます。(単位は秒) 例：60
プロファイルID		profileId	文字列
プロファイルバージョン		profileVersion	数値
アクセスログタイプ		type	文字列	"FULLSET" | "VERSION" | "UPDATE_STATUSES" •　"FULLSET"：設定取得 •　"VERSION"：バージョン確認 •　"UPDATE_STATUSES"：更新状況通知
ユニットID		unitId	文字列
ユニットバージョン		unitVersion	数値
ホスト名	host		文字列

項目名	レスポンスパラメータ		型	値
自動再配信リトライ回数の固定化	lockDown	autoResendingRetryCount	論理型	•　true：固定化されている •　false：固定化されていない
自動再配信リトライ間隔の固定化		autoResendingRetryInterval	論理型	•　true：固定化されている •　false：固定化されていない
コネクションリトライ回数の固定化		connectionRetryCount	論理型	•　true：固定化されている •　false：固定化されていない
コネクションリトライ間隔の固定化		connectionRetryInterval	論理型	•　true：固定化されている •　false：固定化されていない
履歴出力モードの固定化		historyMode	論理型	•　true：固定化されている •　false：固定化されていない
ジョブタイムアウト(時間)の固定化		jobTimeout	論理型	•　true：固定化されている •　false：固定化されていない
ジョブタイムアウト(有効/無効)の固定化		jobTimeoutEnabled	論理型	•　true：固定化されている •　false：固定化されていない
ポーリング間隔の固定化		pollingInterval	論理型	•　true：固定化されている •　false：固定化されていない
受信キューポーリング間隔の固定化		receivingQueuePollingInterval	論理型	•　true：固定化されている •　false：固定化されていない
リクエストタイムアウトの固定化		requestTimeout	論理型	•　true：固定化されている •　false：固定化されていない
配信履歴保管サイズの固定化		sendLogPoolSize	論理型	•　true：固定化されている •　false：固定化されていない
配信多重度の固定化		sendProcessMultiplexLevel	論理型	•　true：固定化されている •　false：固定化されていない
ソケットバッファサイズの固定化		socketBufferSize	論理型	•　true：固定化されている •　false：固定化されていない
ソケットリードタイムアウトの固定化		socketTimeout	論理型	•　true：固定化されている •　false：固定化されていない
トレースログ保管サイズの固定化		traceLogPoolSize	論理型	•　true：固定化されている •　false：固定化されていない
通信時間制限の固定化		communicationTimeLimitEnabled	論理型	•　true：固定化されている •　false：固定化されていない
開始時刻(通信時間制限)の固定化		startCommunicationTimeHour	論理型	•　true：固定化されている •　false：固定化されていない
終了時刻(通信時間制限)の固定化		endCommunicationTimeHour	論理型	•　true：固定化されている •　false：固定化されていない

項目名	レスポンスパラメータ		型	値
MACアドレス	macAddress		文字列
モジュールバージョン	moduleVersion		文字列
モジュールの同期	moduleVersionSyncronized		論理型	•　true：同期済み •　false：同期待ち
モジュールのアップデート	moduleVersionUpdated		論理型	•　true：アップデート成功 •　false：アップデート失敗 「moduleVersionSyncronized」と両方trueの場合に同期完了となります。
エージェント名	name		文字列
次回同期予定時刻	nextSyncronizationScheduledTime		数値	「yyyyMMddHHmmssSSS」の形式で返却されます。 例：20171124164131676
OS	os		文字列
リージョン	otherInfo	region	数値	0 | 1 •　0：Region Editionではない •　1：Region Editionである
Agentの浮動小数点演算		floating	文字列	"soft-float" | "hard-float" •　"soft-float"：ソフトウェア使用 •　"hard-float"：ハードウェア使用 AgentがARM版の場合のみ有効です。
プロファイルID	profileId		文字列
プロファイル名	profileName		文字列
プロファイルの同期	profileVersionSyncronized		論理型	•　true：同期済み •　false：同期待ち
プロファイルのアップデート	profileVersionUpdated		論理型	•　true：アップデート成功 •　false：アップデート失敗 「profileVersionSyncronized」と両方trueの場合に同期完了となります。
登録日	registrationDate		数値	「yyyyMMddHHmmssSSS」の形式で返却されます。 例：20171124164131676
備考	remarks		文字列	512文字以内のASCII文字が返却されます。

項目名	レスポンスパラメータ		型	値
エージェントID	sendLog	agentId	文字列
エージェント名		agentName	文字列
暗号種別		cipherType	文字列	"0" | "1" • 0：暗号機能を使用していない※ • 1：HULFT暗号化 ※ Region Editionの場合は、必ず0が設定されます。
圧縮率		compressedRate	数値
転送ブロック長		dTelegramLen	数値
データサイズ（配信）		dataSize	数値	配信データのサイズ
詳細コード（配信）		detailCode	数値	配信処理の詳細コード
異常時ジョブ完了コード		errorJobExitCode	数値
異常時ジョブ		errorJobName	文字列	ジョブ自体が返却されます。
完了コード（配信）		exitCode	数値	配信処理の完了コード
ファイルID（配信）		fileId	文字列	配信ファイルID
ホスト名（配信先）		hostName	文字列
最新処理識別子		latestProcessId	文字列
最新転送識別子		latestTransferId	文字列
配信前ジョブ完了コード		preJobExitCode	数値
配信前ジョブ		preJobName	文字列	ジョブ自体が返却されます。
プロファイルID		profileId	文字列	配信処理に用いたプロファイルのID
プロファイル名		profileName	文字列	配信処理に用いたプロファイルの名称
レコード数		recordCount	数値	配信したファイルのレコード数
配信履歴ID		sendLogId	文字列
配信終了日時　(文字列)		sndEndTimeStr	文字列	"曜日 月 日 時:分:秒 西暦" 例："Fri Sep 08 17:15:52 2017"
配信終了日時　(UTC)		sndEndTimeUtc	数値	協定世界時（UTC）の1970年1月1日0時0分0秒からの経過時間（単位：秒）
配信ファイル名		sndFileName	文字列	UTF-8で格納
配信開始日時 (文字列)		sndStartTimeStr	文字列	"曜日 月 日 時:分:秒 西暦" 例："Fri Sep 08 17:15:52 2017"
配信開始日時　(UTC)		sndStartTimeUtc	数値	協定世界時（UTC）の1970年1月1日0時0分0秒からの経過時間（単位：秒）

項目名	レスポンスパラメータ		型	値
開始処理識別子	sendLog	startProcessId	文字列
開始転送識別子		startTransferId	文字列
正常時ジョブ完了コード		successJobExitCode	数値
正常時ジョブ		successJobName	文字列	ジョブ自体が返却されます。
転送レート		transferRate	数値	データサイズ÷配信時間の計算結果が返却されます。（バイト/秒）
転送タイプ		transferType	文字列	"B" | "T" •　B：バイナリ •　T：テキスト
トリガー発火イベント		triggerEvent	数値	0 | 1 •　0：サイズ監視による発火 •　1：タイムスタンプ監視による発火
トリガー発火時のファイルステータス		triggerStatus	数値	ファイルサイズ | 日時 •　サイズ監視による発火の場合：ファイルサイズ（単位：バイト） •　タイムスタンプ監視による発火の場合：日時
ユニットID		unitId	文字列	配信処理が行われたユニットのID
ユニット名		unitName	文字列	配信処理が行われたユニットの名称
セッション	session		文字列	"ONLINE" | "OFFLINE" | "OUT_OF_HOURS" •　ONLINE：オンライン •　OFFLINE：オフライン •　OUT_OF_HOURS：通信時間制限による通信可能時間外
Agentのステータス	status		文字列	"ON" | "OFF" •　ON：Agentが使用中 •　OFF：Agentが待機
ユニットID	unitId		文字列
ユニット名	unitName		文字列
ユニットの同期	unitVersionSyncronized		論理型	•　true：同期済み •　false：同期待ち
ユニットのアップデート	unitVersionUpdated		論理型	•　true：アップデート成功 •　false：アップデート失敗 「unitVersionSyncronized」と両方trueの場合に同期完了となります。