7.3.7 実行エージェント定義情報のオブジェクト
実行エージェントまたは実行エージェントグループの定義情報を表すオブジェクトです。
- 形式
{ "execAgent":"実行エージェント名または実行エージェントグループ名", "execHost":"実行ホスト名", "status":"受付配信制限の状態", "conExe":["時間帯ごとのジョブ実行多重度",...], "linkAgents":["関連する実行エージェントと優先順位"], "description":"説明文" }- メンバー
-
返却されるメンバーを次の表に示します。
表7‒48 実行エージェントの定義情報のオブジェクトのメンバー一覧 メンバー
データ型
説明
execAgent
string
「query」に指定するパラメーターmodeによって，次に示す内容を返却します。
-
modeが「agent（実行エージェント）」の場合
実行エージェント名を1〜255バイトの文字列で返却します。
-
modeが「agentGroup（実行エージェントグループ）」の場合
実行エージェントグループ名を1〜255バイトの文字列で返却します。
execHost
string
「query」に指定するパラメーターmodeによって，次に示す内容を返却します。
-
modeが「agent（実行エージェント）」の場合
ジョブの実行先ホスト名を1〜255バイトの文字列で返却します。
-
modeが「agentGroup（実行エージェントグループ）」の場合
この項目を返却しません。
status
string
「query」に指定するパラメーターmodeによって，次に示す内容を返却します。
-
modeが「agent（実行エージェント）」の場合
実行エージェントの受付配信制限の状態を，定数ExecAgentStatusに規定した文字列定数で返却します。
-
modeが「agentGroup（実行エージェントグループ）」の場合
実行エージェントグループの受付配信制限の状態を，定数ExecAgentStatusに規定した文字列定数で返却します。
定数ExecAgentStatusの詳細については，「7.4.14(1) ExecAgentStatus」を参照してください。
conExe
string[]
「query」に指定するパラメーターmodeによって，次に示す内容を返却します。
-
modeが「agent（実行エージェント）」の場合
時間帯ごとのジョブ実行多重度を配列で返却します。時間帯ごとのジョブ実行多重度は，次の形式で返却します。
時間帯=ジョブ実行多重度
時間帯は「hh:mm-hh:mm」形式で返却します。
hhは，0〜23の数値（単位：時），mmは，0または30（単位：分）の数値で返却します。
ジョブ実行多重度は0〜4294967295の範囲の数値で返却します。
-
modeが「agentGroup（実行エージェントグループ）」の場合は「null」を返却します。
linkAgents
string[]
「query」に指定するパラメーターmodeによって，次に示す内容を返却します。
-
modeの値が「agent（実行エージェント）」の場合
「null」を返却します。
-
modeの値が「agentGroup（実行エージェントグループ）」の場合
関連する実行エージェントと優先順位を配列で返却します。関連する実行エージェントと優先順位は次の形式で返却します。
実行エージェント名:優先順位
実行エージェント名は1〜255バイトの文字列で返却します。
優先順位は1〜16の範囲の数値で返却します。
ただし，関連する実行エージェントが存在しない場合は，要素数0個の配列を返却します。
description
string
説明文を0〜80バイトの文字列で返却します。
-