転送履歴一覧取得

転送履歴の一覧を取得するためのAPIです。Manager画面で[ログ]を選択した後、[転送履歴]タブを選択したときに表示される画面での操作に相当します。

= 備考 =

転送履歴一覧取得APIのcontent階層下のレスポンスパラメータは、転送履歴詳細取得APIのレスポンスパラメータと同じです。

書式

curl -X GET --header 'Accept: application/json'

--header 'X-API-KEY:APIキー'

'http://ホスト名:ポート番号/api/v1/transfer-logs?クエリ形式のリクエスト'

リクエストパラメータ(クエリ形式)
項目名 リクエストパラメータ 省略値
ファイルID fileId 文字列

転送に使用されたファイルID

部分一致

 
エージェントID agentId 文字列

配信処理を行ったエージェントのID

完全一致

 
エージェント名 agentName 文字列

配信処理を行ったエージェントの名称

部分一致

 
プロファイルID profileId 文字列

配信処理に用いたプロファイルのID

完全一致

 
プロファイル名 profileName 文字列

配信処理に用いたプロファイルの名称

部分一致

 
ユニットID unitId 文字列

配信処理が行われたユニットのID

完全一致

 
ユニット名 unitName 文字列

配信処理が行われたユニットの名称

部分一致

 

集信ホスト名

shushinHostName 文字列

部分一致

 
ソート順 sort 文字列

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

• +:昇順

• -:降順

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

-modifiedOn

ページ数 page 数値

0始まりで指定します。

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

0
1ページ当たりの項目数 size 数値   10
配信の完了コード sndExitCode 数値 完全一致  
集信の完了コード rcvExitCode 数値 完全一致  
開始処理識別子 startProcessId 文字列 完全一致  
最新処理識別子 latestProcessId 文字列 完全一致  
検索対象 filter 文字列

"sndErrorOnly" | "rcvErrorOnly" | "sndOnly" | "rcvOnly"

• "sndErrorOnly":配信履歴が配信エラーとなっている転送履歴を検索

• "rcvErrorOnly":集信履歴が集信エラーとなっている転送履歴を検索

• "sndOnly":配信履歴のみ存在する転送履歴を検索(集信履歴はない)

• "rcvOnly":集信履歴のみ存在する転送履歴を検索(配信履歴はない)

 
ソート順に指定できるパラメータ
項目名 パラメータ名
暗号種別 hulrcvLog.cipherType
データサイズ(集信) hulrcvLog.dataSize
詳細コード(集信) hulrcvLog.detailCode
完了コード(集信) hulrcvLog.exitCode
ファイルID(集信) hulrcvLog.fileId
ホスト名(エージェントID) hulrcvLog.hostName
集信履歴ID hulrcvLog.hulrcvLogId
ジョブID hulrcvLog.jobId
最新処理識別子 hulrcvLog.latestProcessId
集信終了日時(文字列) hulrcvLog.rcvEndTimeStr
集信終了日時(UTC) hulrcvLog.rcvEndTimeUtc
集信ファイル名 hulrcvLog.rcvFileName
集信開始日時(文字列) hulrcvLog.rcvStartTimeStr
集信開始日時(UTC) hulrcvLog.rcvStartTimeUtc
レコード数 hulrcvLog.recordCount
開始処理識別子 hulrcvLog.startProcessId
開始転送識別子 hulrcvLog.startTransferId
転送レート hulrcvLog.transferRate
転送タイプ hulrcvLog.transferType
エージェント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
転送履歴ID transferLogId
更新日時 modifiedOn
レスポンス

{

"content": [

{

"hulrcvLog": {

"cipherType": "string",

"dataSize": 0,

"detailCode": 0,

"exitCode": 0,

"fileId": "string",

"hostName": "string",

"hulrcvLogId": "string",

"jobId": "string",

"latestProcessId": "string",

"latestTransferId": "string",

"rcvEndTimeStr": "string",

"rcvEndTimeUtc": 0,

"rcvFileName": "string",

"rcvStartTimeStr": "string",

"rcvStartTimeUtc": 0,

"recordCount": 0,

"startProcessId": "string",

"startTransferId": "string",

"transferRate": 0,

"transferType": "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"

},

"transferLogId":"string"

}

],

"first": true,

"last": true,

"number": 0,

"numberOfElements": 0,

"size": 0,

"sort": [],

"totalElements": 0,

"totalPages": 0

}

レスポンスパラメータ

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

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