モニター・オブジェクトを指定した HTTP GET メソッドを使用してリソース・モニターに関する情報を要求する場合、次の属性が名前付きの JSON オブジェクト内で返されます。
- 名前
- ストリング。
- リソースのモニターの固有の名前
- タイプ
- ストリング。
- リソースのモニターのタイプ
- 値は、以下のいずれかの値です。
- directory
- モニター対象リソースのタイプはファイル・システムのディレクトリーです。
- キュー
- モニター対象のリソースのタイプは、 IBM® MQ キューです。
- agentName
- ストリング。
- リソース・モニターを所有するエージェントの名前。
- State
- ストリング。
- モニターの状態。
- 値は、以下のいずれかの値です。
- 開始済み
- モニターは実行中です。
- stopped
- モニターは停止されました。
general
モニターのその他の上位属性を定義するグループ・エレメント。
- pollInterval
- 整数
- モニターがリソースのポーリングを行う頻度。 この値に使用される時間の単位は、pollIntervalUnit 属性で指定されます。
- pollIntervalUnit
- ストリング。
- pollInterval属性の時間間隔を指定します。 可能な値は
seconds, minutes, hours, days です。
- matchesPerTask
- 整数
- 単一タスクに含めるトリガー・マッチングの最大数。
resource
モニター対象リソースを定義するグループ・エレメント。
このオブジェクトの
name属性は常に返されます。
- 名前
- ストリング。
- ファイル・システム・ディレクトリーの絶対パスか、キュー名を示します。
- この属性は、常に返されます。
- recursionLevel
- 整数
- 一致するトリガー・ファイルを見つけるために検索するサブディレクトリーの数を示します。 この属性は、リソース・モニターのディレクトリー・タイプに限り有効です。
transferDefinition
トリガー・イベントが発生したときに転送される項目のリスト。 応答には項目が 1 つ以上あります。
- destinationAgent
- 宛先エージェントを定義するエレメントが入っているグループ・エレメント。
このオブジェクトの
name属性と
qmgrName属性は常に返されます。
- qmgrName
- ストリング。
- 宛先システム上のキュー・マネージャーの名前。
- 名前
- ストリング。
- 宛先システム上のエージェントの名前。
- job
- 以下の属性が入っているグループ。常に返されます。
- 名前
- ストリング。
- 転送に関するユーザー定義のジョブ名。
- originator
- 転送要求の発信元を示すエレメントが含まれるグループ・エレメント。
このオブジェクトの
host属性と
userid属性は常に返されます。
- host
- ストリング。
- ソース・ファイルが置かれているシステムのホスト名。
- ユーザーID
- ストリング。
- ファイル転送を開始したユーザーの ID。
- sourceAgent
- ソース・エージェントを定義するエレメントが含まれるグループ・エレメント。
このオブジェクトの
name属性と
qmgrName属性は常に返されます。
- qmgrName
- ストリング。
- ソース・システム上のキュー・マネージャーの名前。
- 名前
- ストリング。
- ソース・システム上のエージェントの名前。
- transferSet
- 転送要求を示すエレメントが含まれるグループ・エレメント。
このオブジェクトの
item属性は常に返されます。
- priority
- 整数 (オプション)。
- 転送要求に割り当てる優先順位。 値を設定しない場合のデフォルトはゼロです。
- userProperties
- オブジェクト (オプション)。
- 転送要求内で指定されるユーザー定義のプロパティー。
- 項目
- オブジェクト。
- 転送するためのソース項目と宛先項目の構成を記述するグループ・エレメントの配列。
- source
- オブジェクト。
- ソース項目の属性が含まれるグループ・エレメント。
このオブジェクトの
name属性と
type属性は常に返されます。
- 名前
- ストリング。
- ソース側のファイル、ディレクトリー、データ・セット、区分データ・セット、またはキューの絶対パスを示します。
- タイプ
- ストリング。
- ソースのタイプ。 値は、以下のいずれかの値です。
- キュー
- IBM MQ キューをソースとして指定します。
- ファイル
- ソースがファイルであることを示します。
- directory
- ソースがディレクトリーであることを示します。
- sequentialDataset
- z/OS® 順次データ・セットをソースとして指定します。
- partitionedDataset
- z/OS 区分データ・セットをソースとして指定します。
- recursive
- ブール値 (オプション)。
- ソース・エレメントがディレクトリーであるかそこにワイルドカード文字が含まれる場合に、ファイルがサブディレクトリーで再帰的に転送されることを示します。
- disposition
- 文字列 (オプション)。
- ソースがその宛先に正常に転送されたときに、ソース・エレメントに対して取るアクションを示します。 disposition の値は以下のいずれかになります。
- leave
- ソース・ファイルは変更されません。
- 削除
- ソース・ファイルは、それが正常に転送された後にソース・システムから削除されます。
- encoding
- 文字列 (オプション)。
- 文字変換を実行するときにソース・ファイルの読み取りに使用する文字エンコードを指定します。 このオプションはテキスト・ファイルだけに適用可能で、可能な値は任意の有効なコード・ページ番号です。
- datasetExtended
- オブジェクト (オプション)。
ソースが転送要求の z/OS データ・セットである場合に、ソース仕様の追加属性を定義するグループ・エレメント。
このオブジェクトの
hexDelimiters属性と
delimiterPosition属性は常に返されます。
- keepTrailingSpaces
- ブール値 (オプション)。
- テキスト・モード転送の一部として固定長形式のレコード単位ファイル (例えば、 z/OS データ・セット) から読み取られるソース・レコードに末尾スペースがある場合に実行されるアクションを記述します。
- hexDelimiters
- ストリング。
- レコード単位である (z/OS データ・セットなど) ソース・ファイルの場合、バイナリー・ファイルにレコードを追加するときに区切り文字として挿入する 1 つ以上のバイト値を指定します。 各値は、
00-FFの範囲内の 2 桁の 16 進数字として表され、接頭部として x が付きます。
- delimiterPosition
- ストリング。
- ソース・テキストおよびバイナリー区切り文字の挿入位置を指定します。 値は、以下のいずれかの値です。
- 接頭部
- 区切り文字は各レコードの先頭に挿入されます。
- postfix
- 区切り文字は各レコードの末尾に挿入されます。 このオプションは、デフォルト・オプションです。
- queueExtended
- オブジェクト (オプション)。
ソースが転送要求の IBM MQ キューである場合に、ソース仕様の追加属性を定義するグループ・エレメント。
このオブジェクトの
useMessageGroup属性と
grouplD属性は常に返されます。
- useMessageGroup
- ブール値。
- メッセージを IBM MQ グループ ID でグループ化することを指定します。 完全に揃った最初のグループが宛先ファイルに書き込まれます。 このパラメーターを指定しない場合は、ソース・キューに存在するすべてのメッセージが宛先ファイルに書き込まれます。
- grouplD
- ストリング。
- キューからメッセージを取得する際に使用するグループ ID。
- textDelimiters
- 文字列 (オプション)。
- 1 つのテキスト・ファイルに複数のメッセージを追加するときに区切り文字として挿入するテキストのシーケンスを指定します。
- hexDelimiters
- 文字列 (オプション)。
- ファイルに複数のメッセージを追加する際に使用する、16 進数バイトのコンマ区切りストリング。 例えば、
x12 や x03,x7Fなどです。
- delimiterPosition
- 文字列 (オプション)。
- ソース・キューに書き込む、メッセージ内の区切り文字の位置を定義します。 指定可能な値は以下のとおりです。
- 接頭部
- メッセージ本文の先頭の前。
- postfix
- メッセージ本文の末尾の後。これはデフォルト・オプションです。
- messageArrivalWaitTime
- 整数
- ソース・キューのメッセージの到着を待機する時間 (秒数)。
- destination
- オブジェクト。
- 宛先項目の属性が含まれるグループ・エレメント。
このオブジェクトの
name属性と
type属性は常に返されます。
- 名前
- ストリング。
- 宛先側のファイル、ディレクトリー、データ・セット、区分データ・セット、またはキューの絶対パスを示します。
- タイプ
- ストリング。
- 宛先のタイプ。 値は、以下のいずれかの値です。
- キュー
- 宛先として IBM MQ キューを指定します。
- ファイル
- 宛先がファイルであることを示します。
- directory
- 宛先がディレクトリーであることを示します。
- sequentialDataset
- z/OS 順次データ・セットを宛先として指定します。
- partitionedDataset
- 宛先として z/OS 区分データ・セットを指定します。
- actionIfExists
- 文字列 (オプション)。
- 宛先システムに宛先ファイルが存在する場合に取る処置を示します。 値は、以下のいずれかの値です。
- エラー
- エラーを報告し、ファイルは転送されません。これはデフォルト値です。
- overwrite
- 既存の宛先ファイルを上書きします。
- encoding
- 文字列 (オプション)。
- 文字変換を実行するときにソース・ファイルの読み取りに使用する文字エンコードを指定します。 このオプションはテキスト・ファイルだけに適用可能で、可能な値は任意の有効なコード・ページ番号です。
- endOfLine
- 文字列 (オプション)。
- 宛先でファイルが書き込まれるときに使用される行末文字を指定します。 このオプションは、テキスト・ファイルにのみ適用されます。
- userId
- 文字列 (オプション)。
- ファイルの転送先の宛先ファイル・スペースを使用するユーザーの名前。
- datasetExtended
- オブジェクト (オプション)。
- 宛先が転送要求の z/OS データ・セットである場合に、宛先指定の追加属性を定義するグループ・エレメント。
- truncateRecords
- ブール値。
- LRECL データ・セット属性よりも長い宛先レコードが切り捨てられることを指定します。 このパラメーターを指定しない場合、それらのレコードは折り返されます。 このパラメーターは、宛先がデータ・セットであるテキスト・モードの転送のみに有効です。
- queueExtended
- オブジェクト (オプション)。
宛先が転送要求の IBM MQ キューである場合に、宛先仕様の追加属性を定義するグループ・エレメント。
このオブジェクトの
messagePersistence属性と
delimiterType属性は常に返されます。
- messagePersistence
- ストリング。
- 宛先キューに書き込まれるメッセージが持続メッセージと非持続メッセージのどちらであるかを定義します。 値は、以下のいずれかの値です。
- persistent
- メッセージに持続性を与える
- nonPersistent
- メッセージが非持続である。
- asQueueDefault
- キュー定義に応じて、メッセージ・パーシステンシーが設定されます。
- delimiterType
- ストリング。
- 着信データを複数のメッセージに分割する際に使用する区切り文字のタイプを定義します。 値は、以下のいずれかの値です。
- size
- 指定されたサイズに基づいて分割します。
- binary
- 指定された区切り文字に基づいて分割します。
- hexDelimiters
- 文字列 (オプション)。
- メッセージを分割する際に使用する、16 進数バイトのコンマ区切りストリング。 例えば、
x12 や x03,x7Fなどです。
- textDelimiters
- 文字列 (オプション)。
- テキスト・ファイルを複数のメッセージに分割するときに使用する Java 正規表現を指定します。
- includeDelimitersInMessage
- ブール値。
- 宛先キューに書き込むメッセージ内に区切り文字を組み込むかどうかを定義します。
- delimiterPosition
- ストリング。
- 宛先キューに書き込む、メッセージ内の区切り文字の位置を定義します。 値は、以下のいずれかの値です。
- 接頭部
- メッセージ本文の先頭の前。
- postfix
- メッセージ本文の末尾の後。これはデフォルト・オプションです。
- setMQProperties
- ブール値 (オプション)。
- 宛先がキューである場合のみ有効です。 値は、以下のいずれかの値です。
- true
- 転送で作成する最初のメッセージでメッセージ・プロパティーを設定します。
- false
- 転送で作成する最初のメッセージでメッセージ・プロパティーを設定しません。
- messageSize
- 整数
- 着信データをメッセージに分割する際のサイズをバイト数で定義します。
- checksum
- 文字列 (オプション)。
- データ保全性を検証するチェックサム方式。 値は、以下のいずれかの値です。
- md5
- 整合性の検証に MD5 アルゴリズムを使用します。
- なし
- チェックサム検証は行われません。
- mode
- 文字列 (オプション)。
- 転送モードがバイナリーであるかテキストであるかを示します。 値は、以下のいずれかの値です。
- text
- データはテキストで転送されます。
- binary
- データはバイナリーで転送されます。
- recoveryTimeout
- 整数 (オプション)。
- 転送の復旧を待機する時間 (秒)。
- -1 がデフォルト値です。
- preSourceCall
- オブジェクト (オプション)。
- ソースで転送が始まる前のプログラム呼び出しのエレメントが含まれるグループ・エレメント。
プログラム呼び出しを使用するようにリソース・モニターが構成されていない場合は、これらのグループ・エレメントは存在しません。
- タイプ
- 文字列 (オプション)。
- 呼び出されるプログラムのタイプを定義します。 値は、以下のいずれかの値です。
- executable
- この値がデフォルト値です。
プラットフォーム固有の実行可能プログラムの属性を定義します。
- 名前
- ストリング。
- 処理するプログラムの名前。
- arguments
- 文字列 (オプション)。
- 呼び出されるプログラムに渡す 1 つ以上の引数。
- antScript
Ant スクリプトの属性を定義します。
- 名前
- ストリング。
- 処理する Ant スクリプトの名前。
- target
- 文字列 (オプション)。
- 指定された Ant スクリプトで呼び出すターゲット。
default ターゲットが呼び出される場合、属性は JSON 応答に存在しません。
- arguments
- 文字列 (オプション)。
- スペースで区切られた key=value のタイプ String のペア内のユーザー定義カスタム・データのリスト。 以下に例を示します。
"arguments":"coffeeType=Arabica teaChoice=lemon"
- jcl
実行依頼する
z/OS JCL の属性を定義します。
- 名前
- ストリング。
- 実行依頼する JCL の名前。
- retryCount
- 整数 (オプション)。
- 終了前にコマンドの実行を試行する回数 (正数)。
- retryWait
- 整数 (オプション)。
- 次に再試行を行うまでの待機時間の長さ (秒数)。
- successReturnCode
- 文字列 (オプション)。
- 転送完了時に返される理由コード。 指定されたプログラム、スクリプト、または JCL の実行前にこれが検索されます。 この戻りコードは、
"[>|<|!] value"の形式の演算子と値の組み合わせです。 複数の演算子の組み合わせ (例: ">= 40") を使用することもできます。
- postSourceCall
- オブジェクト (オプション)。
- ソースで転送が完了した後のプログラム呼び出しのエレメントが含まれるグループ・エレメント。 このオブジェクトには、preSourceCallと同じエレメントが含まれます。
- preDestinationCall
- オブジェクト (オプション)。
- 宛先で転送が始まる前のプログラム呼び出しのエレメントが含まれるグループ・エレメント。 このオブジェクトには、preSourceCallと同じエレメントが含まれます。
- postDestinationCall
- オブジェクト (オプション)。
- 宛先で転送が完了した後のプログラム呼び出しのエレメントが含まれるグループ・エレメント。 このオブジェクトには、preSourceCallと同じエレメントが含まれます。
triggerCondition
リソース・モニターで使用されるトリガー条件の詳細を定義するグループ・エレメント。
- タイプ
- ストリング。
- 転送のトリガーを決定するために行うマッチングのタイプを示します。 値は、以下のいずれかの値です。
リソース・タイプ
Directoryの場合:
- matchAll
- includePattern 属性および excludePattern 属性に指定された値と一致する必要があります。
- matchNone
- モニター対象ディレクトリー内のどのファイルも、includePattern 属性および excludePattern 属性に指定された値と一致しません。
- noChangeInSize
- ポーリング間隔の指定回数の間に、モニター対象ファイルのサイズが変更されない場合に、転送を開始します。
- sizeGreaterOrEqualTo
- モニター対象ファイルのサイズが指定サイズ以上の場合に、転送を開始します。
リソース・タイプ
Queueの場合:
- queueNotEmpty
- キューには少なくとも 1 つのメッセージが必要です。
- completeMessageGroups
- キューには少なくとも 1 つのメッセージ・グループが必要です。
- noFileSizeChangePollCount
- 整数
- ポーリング間隔の回数を示します。この間はモニター対象ファイルのサイズは変更されません。 noChangeInSize 属性と組み合わせて使用します
- fileSize
- 整数
- モニター対象のトリガー・ファイルのサイズを示します。このサイズ以上かどうかモニターされます。 sizeGreaterOrEqualTo 属性と組み合わせて使用します。
- fileSizeUnit
- ストリング。
- fileSize 属性の単位を定義します。 値は、以下のいずれかの値です。
- バイト
- ファイル・サイズの単位はバイトです
- kilobytes
- ファイル・サイズの単位はキロバイトです
- megabytes
- ファイル・サイズの単位は M バイトです
- gigabytes
- ファイル・サイズの単位は G バイトです
- includePattern
- ストリング。
- トリガー条件のマッチング中に含められるファイルの名前のパターン。
- excludePattern
- ストリング。
- トリガー条件のマッチング中に除外されるファイルの名前のパターン。
- matchPattern
- ストリング。
- includePattern 属性および excludePattern 属性の内容を解釈する方法を示します。 値は、以下のいずれかの値です。
- ワイルドカード
- - includePattern 属性と excludePattern 属性にワイルドカード文字が含まれていることを示します (例:
*)。
- regularExpression
- includePattern 属性と excludePattern 属性に Java 正規表現が含まれていることを示します。
triggerFileContentFormat
トリガー・ファイルは、トリガー条件が満たされると転送されるファイルのリストを定義します。 トリガー・ファイルは、ソース・パスのみ定義することも、ソース・パスと宛先パスの両方を定義することもできます。 トリガー・ファイル内の各行は、転送されるファイルを指します。
このオブジェクトは、
matchAll および
noChangeInSizeの
triggerCondition.type に対してのみ有効です。
- groupOrder
- ストリング。
- トリガー・ファイルには、ソース・ファイル名、宛先ファイル名、または両方の名前が含まれます。 この属性は、ソース・ファイル名、宛先ファイル名、または両方の名前の順序を定義します。 値は、以下のいずれかの値です。
- sourceDestination
- ソース・ファイル名が最初に示され、宛先ファイル名が後になります。
- destinationSource
- 宛先ファイル名が最初に示され、ソース・ファイル名が後になります。
- customPattern
- 文字列 (オプション)。
- 転送するファイルのリストを生成するためにトリガー・ファイルの内容を構文解析する際に適用する Java 正規表現。