転送の応答本体の属性
転送オブジェクトを指定した HTTP GET メソッドを使用して転送に関する情報を要求する場合、次の属性が名前付きの JSON オブジェクト内で返されます。
以下のオブジェクトを使用できます。
destinationAgent
- 名前
- ストリング。
- 宛先システム上のエージェントの名前を示します。
- この属性は、常に返されます。
- qmgrName
- ストリング。
- 宛先システム上のキュー・マネージャーの名前を示します。
originator
- host
- ストリング。
- ソース・ファイルが置かれているシステムのホスト名を示します。
- この属性は、常に返されます。
- mqmdUserId
- ストリング。
- メッセージ記述子 (MQMD) に指定された IBM® MQ ユーザー ID を指定します。
- userID
- ストリング。
- ファイル転送を開始したユーザーの ID を示します。
- この属性は、常に返されます。
sourceAgent
- 名前
- ストリング。
- ソース・システム上のエージェントの名前を示します。
- この属性は、常に返されます。
- qmgrName
- ストリング。
- ソース・システム上のキュー・マネージャーの名前を示します。
統計
- endTime
- ストリング。
- 転送が完了した時刻を示します。 このフィールドは、転送が完了したときにのみ更新されます。 転送が他のいずれかの状態の場合、endTimeは空ストリングです。
- この属性は、常に返されます。
- numberOfFileFailures
- 整数
- 正常に転送できなかったファイルの数を示します。
- この属性は、常に返されます。
- numberOfFileSuccesses
- 整数
- 正常に転送されたファイルの数を示します。
- この属性は、常に返されます。
- numberOfFileWarnings
- 整数
- 警告が生成されてはいても、それ以外の点では正常に転送されたファイルの数を示します。
- この属性は、常に返されます。
- numberOfFiles
- 整数
- 転送要求に含まれるファイルの総数を示します。 この数値には、転送操作のために検討されたすべてのファイルが含まれます。
- この属性は、常に返されます。
- retryCount
- 整数
- 転送がリカバリー状態に入り、エージェントによって再試行された回数を示します。
- IBM MQ ネットワーク・エラーのため、またはエージェントが一定期間データまたは確認応答メッセージを受信していないために、ソース・エージェントと宛先エージェントが通信を失ったために、転送がリカバリー状態になることがあります。 この期間は、エージェント・プロパティーtransferAckTimeoutおよびtransferAckTimeoutRetriesによって決定されます。
- startTime
- ストリング。
- 転送を実行依頼した時刻を UTC 形式で示します。
- この属性は、常に返されます。
状況
- description
- ストリング。
- 完了時の状況 (一部成功、成功、失敗など) に関する詳細情報を示します。
- lastStatusUpdate
- ストリング。
- 最後に転送状況が収集された時の時刻を UTC 形式で示します。
- state
- ストリング。
- 転送の状態を示します。 値は、次の値のうちのいずれかです。
- 開始済み
- inProgress
- 成功しました。
- 失敗
- partiallySuccessful
- 取り消し済み
- malformed
- notAuthorized
- deleted
- inProgressWithFailures
- inProgressWithWarnings
- この属性は、常に返されます。
transferSet
- bytesSent
- 整数
- 合計送信バイト数を示します。
- 項目
- JSON オブジェクト。
- ソースおよび宛先のファイル名と位置を示すエレメントが格納されます。
- destination
- JSON オブジェクト。
- actionIfExists
- ストリング。
- 宛先システムに宛先ファイルが存在する場合に取る処置を示します。 有効なオプションは以下のとおりです。
- エラー
- エラーを報告し、ファイルは転送されません。
- overwrite
- 既存の宛先ファイルを上書きします。
- checksum
- JSON オブジェクト。
- チェックサムが実行されなかった場合、このオブジェクトは表示されません。
- デジタル署名を作成するためにメッセージ・ダイジェストを生成したハッシュ・アルゴリズムのタイプを示します。 Managed File Transfer は、メッセージ・ダイジェスト・アルゴリズム 5 (md5) のみをサポートします。 転送されたファイルの完全性が損なわれていないことを確認する方法として、チェックサムが備えられています。
- JSON オブジェクトには以下のエレメントが含まれます。
- メソッド (method)
- ストリング。
- チェックサムの生成に使用される方式を示します。
- 値
- ストリング。
- 生成されたチェックサム値を示します。
- dataset
- JSON オブジェクト。
fileまたはqueueオブジェクトが返される場合、このオブジェクトは返されません。- 以下のエレメントを持つ z/OS® データ・セットを指定します。
- 属性
- ストリング。
- データ・セットに関連した属性を示します。
- 名前
- ストリング。
- データ・セットの名前を示します。
- size
- 整数
- ファイル・サイズを示します。
- ファイル
- JSON オブジェクト。
queueまたはdatasetオブジェクトが返される場合、このオブジェクトは返されません。- 以下のエレメントで、転送されたファイルに関する情報を示します。
- encoding
- ストリング。
- テキスト・ファイル転送のエンコードを示します。
- endOfLine
- 行末マーカーを指定します。 この値は、次のいずれかの値です。
- LF - 改行文字のみ。
- CRLF - 復帰と改行の文字シーケンス。
- lastModified
- ストリング。
- ファイルの最終変更日時を UTC 形式で示します。
- path
- ストリング。
- ファイルのパス位置を示します。
- size
- 整数
- ファイル・サイズを示します。
- キュー
- JSON オブジェクト。
fileまたはdatasetオブジェクトが返される場合、このオブジェクトは返されません。- 以下のエレメントで、メッセージの転送先キューに関する情報を示します。
- delimiter
- ストリング。
- 使用されている区切り文字を示します。
- delimiterTypeがサイズに設定されている場合、このエレメントは区切り文字のサイズを指定します。 delimiterTypeがバイナリーに設定されている場合、値は区切り文字バイトの数です。
- delimiterが空ストリングの場合、転送の開始時にこのフィールドは設定されません。
- delimiterPosition
- ストリング。
- このエレメントは、delimiterTypeがバイナリーの場合にのみ有効です。 値は、以下のいずれかの値です。
- "prefix"
- 各メッセージの前。
- "postfix"
- 各メッセージの後。
- delimiterPositionが空ストリングの場合、転送の開始時にこのフィールドは設定されません。
- delimiterType
- ストリング。
- メッセージの分割に使用されている区切り文字のタイプを示します。 値は、次の値のうちのいずれかです。
- binary
- 区切り文字のバイト数による分割。
- size
- サイズによる分割。
- delimiterTypeが空ストリングの場合、転送の開始時にこのフィールドは設定されません。
- includeDelimiterInMessage
- ブール値。
- このエレメントは、delimiterTypeがバイナリーの場合にのみ有効です。
- 区切り文字がメッセージに組み込まれているかどうかを示します。
- messageCount
- 整数
- キューに書き込まれたメッセージの数を示します。
- messageLength
- 整数
- キューに書き込まれたメッセージの長さを示します。
- messageOrGroupId
- ストリング。
- 転送要求でファイルが複数のメッセージに分割されるように指定されていない場合、この属性の値は、キューに書き込まれるメッセージの IBM MQ メッセージ ID です。
- 転送要求でファイルが複数のメッセージに分割されるように指定されている場合、この属性の値は、キューに書き込まれるメッセージの IBM MQ グループ ID です。
- 名前
- ストリング。
- 以下の形式で、キューとキュー・マネージャーの名前を示します。
queueName@queueManagerName
- タイプ
- ストリング。
- 宛先のタイプを示します。 この宛先は、以下のいずれかの宛先です。
- キュー
- 宛先として IBM MQ キューを指定します。
- ファイル
- 宛先がファイルであることを示します。
- dataset
- 宛先として z/OS データ・セットを指定します。
- mode
- ストリング。
- 転送モードがバイナリーであるかテキストであるかを示します。
- source
- JSON オブジェクト。
- checksum
- JSON オブジェクト。
- チェックサムが実行されなかった場合、このオブジェクトは表示されません。
- デジタル署名を作成するためにメッセージ・ダイジェストを生成したハッシュ・アルゴリズムのタイプを示します。 Managed File Transfer は、メッセージ・ダイジェスト・アルゴリズム 5 (md5) のみをサポートします。 転送されたファイルの完全性が損なわれていないことを確認する方法として、チェックサムが備えられています。
- JSON オブジェクトには以下のエレメントが含まれます。
- メソッド (method)
- ストリング。
- チェックサムの生成に使用する方式を示します。
- 値
- ストリング。
- 生成されたチェックサム値を示します。
- disposition
- ストリング。
- ソースがその宛先に正常に転送されたときに、ソース・エレメントに対して取るアクションを示します。 このストリングは、以下のいずれかのオプションになります。
- leave
- ソース・ファイルが変更されていないことを示します
- 削除
- ソース・ファイルが正常に転送された後にソース・システムからソース・ファイルが削除されたことを示します
- dataset
- JSON オブジェクト。
fileまたはqueueオブジェクトが返される場合、このオブジェクトは返されません。- 以下のエレメントを持つ z/OS データ・セットを指定します。
- 属性
- ストリング。
- データ・セットに関連した属性を示します。
- 名前
- ストリング。
- データ・セットの名前を示します。
- size
- 整数
- ファイル・サイズを示します。
- ファイル
- JSON オブジェクト。
queueまたはdatasetオブジェクトが返される場合、このオブジェクトは返されません。- このオブジェクトには、以下のエレメントが含まれます。
- encoding
- ストリング。
- テキスト・ファイル転送のエンコードを示します。
- endOfLine
- 行末マーカーを指定します。 この値は、次のいずれかの値です。
- LF - 改行文字のみ。
- CRLF - 復帰と改行の文字シーケンス。
- lastModified
- ストリング。
- ファイルの最終変更日時を UTC 形式で示します。
- path
- ストリング。
- ファイルのパス位置を示します。
- size
- 整数
- ファイルのサイズを示します。
- キュー
- JSON オブジェクト。
fileまたはdatasetオブジェクトが返される場合、このオブジェクトは返されません。- 以下のエレメントで、転送メッセージの取得元キューに関する情報を示します。
- messageCount
- 整数
- キューから読み取られたメッセージの数を示します。
- 名前
- ストリング。
- 以下の形式で、キューとキュー・マネージャーの名前を示します。
queueName@queueManagerName - setMqProperties
- ブール値。
- IBM MQ メッセージ・プロパティーをファイル内の最初のメッセージに設定するかどうか、およびエラー発生時にキューに書き込まれるすべてのメッセージに設定するかどうかを指定します。
- タイプ
- ストリング。
- ソースのタイプを示します。 このソースは、以下のいずれかのソースです。
- キュー
- IBM MQ キューをソースとして指定します。
- ファイル
- ソースがファイルまたはディレクトリーの場合、ソースがファイルであることを示します。
- dataset
- z/OS データ・セットをソースとして指定します。
- 状況
- JSON オブジェクト。
- 転送セット内の単一項目の状況を示します。 status オブジェクトには、以下のエレメントが含まれます。
- description
- ストリング。
- 完了時の状況 (一部成功、成功、失敗など) に関する詳細情報を示します。
- state
- ストリング。
- 転送の状態を示します。 値は、次の値のうちのいずれかです。
- 開始済み
- inProgress
- 成功しました。
- 失敗
- partiallySuccessful
- 取り消し済み
- malformed
- notAuthorized
- deleted
- inProgressWithFailures
- inProgressWithWarnings