エージェント一覧取得

エージェントの一覧を取得するためのAPIです。Manager画面で［エージェント］を選択したときの操作に相当します。

= 備考 =

エージェント一覧取得APIのcontent階層下のレスポンスパラメータは、エージェント詳細取得APIのレスポンスパラメータと同じです。
書式
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIキー'
            'http://ホスト名:ポート番号/api/v1/agents?クエリ形式のリクエスト'
リクエストパラメータ（クエリ形式）
項目名 リクエストパラメータ 型 値 省略値
エージェントID agentId 文字列 完全一致  
エージェント名 agentName 文字列 部分一致  
ホスト名 host 文字列 部分一致  
登録日（開始） geRegistrationDate 数値

「yyyyMMddHHmmssSSS」の形式で指定します。

•　yyyy：西暦

•　MM：月

•　dd：日

•　HH：時

•　mm：分

•　ss：秒

•　SSS：ミリ秒

（例：20180319030101000）

一方だけを指定できます。開始と終了の両方を指定した場合、検索対象にする期間を指定できます。

  
登録日（終了） leRegistrationDate 数値  
MACアドレス macAddress 文字列 部分一致  
ユニットID unitId 文字列

ユニットが未設定のAgentを検索する場合は、"none"を指定します。

部分一致

  
ユニット名 unitName 文字列 部分一致  
プロファイルID profileId 文字列

プロファイルが未設定のAgentを検索する場合は、"none"を指定します。

部分一致

  
プロファイル名 profileName 文字列 部分一致  

Agentのステータス

 status 文字列

"ON"　|　"OFF"

•　ON：Agentが使用中

•　OFF：Agentが待機

  
ソート順 sort 文字列

"+パラメータ名"　|　"-パラメータ名"

•　+：昇順

•　-：降順

複数のパラメータを指定する場合は「,」で区切ります。

 +name

ページ数

 page 数値

0始まりで指定します。

ページ数が1の場合、0を指定します。

 0
1ページ当たりの項目数 size 数値   10
ソート順に指定できるパラメータ
項目名 パラメータ名
エージェントID agentId
エージェントバージョン（設定履歴） agentVersion
自動再配信リトライ回数 basicSettings.autoResendingRetryCount
自動再配信リトライ間隔 basicSettings.autoResendingRetryInterval
コネクションリトライ回数 basicSettings.connectionRetryCount
コネクションリトライ間隔 basicSettings.connectionRetryInterval
履歴出力モード basicSettings.historyMode
ジョブタイムアウト(時間) basicSettings.jobTimeout
ジョブタイムアウト(有効/無効) basicSettings.receivingTaskQueueSize
リクエストタイムアウト basicSettings.requestTimeout
配信多重度 basicSettings.sendProcessMultiplexLevel
ソケットバッファサイズ(バイト数) basicSettings.socketBufferSize
ソケットバッファサイズ(タイプ) basicSettings.socketBufferSizeMode
ソケットリードタイムアウト basicSettings.socketTimeout
通信時間制限 basicSettings.communicationTimeLimitEnabled
開始時刻(通信時間制限) basicSettings.startCommunicationTimeHour
終了時刻(通信時間制限) basicSettings.endCommunicationTimeHour
Agentビット数 bit
Agentアーキテクチャ cpu
アクセス日時 deviceAccessLog.accessedDate
エージェントID deviceAccessLog.agentId
エージェントバージョン（設定履歴） deviceAccessLog.agentVersion
モジュールバージョン（現在） deviceAccessLog.attachedModuleVersion
アクセスログID deviceAccessLog.deviceAccessLogId
モジュールバージョン（適用予定） deviceAccessLog.moduleVersion
ポーリング間隔 deviceAccessLog.pollingInterval
プロファイルID deviceAccessLog.profileId
プロファイルバージョン deviceAccessLog.profileVersion
アクセスログタイプ deviceAccessLog.type
ユニットID deviceAccessLog.unitId
ユニットバージョン deviceAccessLog.unitVersion
自動再配信リトライ回数の固定化 lockDown.autoResendingRetryCount
自動再配信リトライ間隔の固定化 lockDown.autoResendingRetryInterval
コネクションリトライ回数の固定化 lockDown.connectionRetryCount
コネクションリトライ間隔の固定化 lockDown.connectionRetryInterval
履歴出力モードの固定化 lockDown.historyMode
ジョブタイムアウト(時間)の固定化 lockDown.jobTimeout
ジョブタイムアウト(有効/無効)の固定化 lockDown.jobTimeoutEnabled
ポーリング間隔の固定化 lockDown.pollingInterval
受信キューポーリング間隔の固定化 lockDown.receivingQueuePollingInterval
リクエストタイムアウトの固定化 lockDown.requestTimeout
配信履歴保管サイズの固定化 lockDown.sendLogPoolSize
配信多重度の固定化 lockDown.sendProcessMultiplexLevel
ソケットバッファサイズの固定化 lockDown.socketBufferSize
ソケットリードタイムアウトの固定化 lockDown.socketTimeout
トレースログ保管サイズの固定化 lockDown.traceLogPoolSize
通信時間制限の固定化 lockDown.communicationTimeLimitEnabled
開始時刻(通信時間制限)の固定化 lockDown.startCommunicationTimeHour
終了時刻(通信時間制限)の固定化 lockDown.endCommunicationTimeHour
MACアドレス macAddress
モジュールバージョン moduleVersion
モジュールのアップデート moduleVersionUpdated
エージェント名 name
OS os
リージョン otherInfo.region
Agentの浮動小数点演算 otherInfo.floating
プロファイルID profile.profileId
プロファイル名 profile.profileName
プロファイルのアップデート profileVersionUpdated
登録日 registrationDate
備考 agentRemarks.remarks
エージェントID sendLog.agentId
エージェント名 sendLog.agentName
暗号種別 sendLog.cipherType
圧縮率 sendLog.compressedRate
転送ブロック長 sendLog.dTelegramLen
データサイズ（配信） sendLog.dataSize
詳細コード（配信） sendLog.detailCode
異常時ジョブ完了コード sendLog.errorJobExitCode
異常時ジョブ sendLog.errorJobName
完了コード（配信） sendLog.exitCode
ファイルID（配信） sendLog.fileId
ホスト名（配信先） sendLog.hostName
最新処理識別子 sendLog.latestProcessId
最新転送識別子 sendLog.latestTransferId
配信前ジョブ完了コード sendLog.preJobExitCode
配信前ジョブ sendLog.preJobName
プロファイルID sendLog.profileId
プロファイル名 sendLog.profileName
レコード数 sendLog.recordCount
配信履歴ID sendLog.sendLogId
配信終了日時(文字列) sendLog.sndEndTimeStr
配信終了日時(UTC) sendLog.sndEndTimeUtc
配信ファイル名 sendLog.sndFileName
配信開始日時(文字列) sendLog.sndStartTimeStr
配信開始日時(UTC) sendLog.sndStartTimeUtc
開始処理識別子 sendLog.startProcessId
開始転送識別子 sendLog.startTransferId
正常時ジョブ完了コード sendLog.successJobExitCode
正常時ジョブ sendLog.successJobName
転送レート sendLog.transferRate
転送タイプ sendLog.transferType
トリガー発火イベント sendLog.triggerEvent

トリガー発火時のファイルステータス

 sendLog.triggerStatus
ユニットID sendLog.unitId
ユニット名 sendLog.unitName
Agentのステータス status
ユニットID unit.unitId
ユニット名 unit.unitName
ユニットのアップデート unitVersionUpdated
レスポンス
{
  "content": [
    {
      "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
    }
  ],
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "size": 0,
  "sort": [],
  "totalElements": 0,
  "totalPages": 0
}
レスポンスパラメータ

content階層下のパラメータについては、「エージェント詳細取得」の「レスポンスパラメータ」を参照してください。

また、ページ設定のパラメータ（first, last, number, numberOfElements, size, sort, totalElements, totalPages）については、「ページ設定に関するレスポンスパラメータ」を参照してください。