7.3.8 実行エージェントの状況オブジェクト
実行エージェントまたは実行エージェントグループの状況を表すオブジェクトです。
- 形式
{ "execAgent":"実行エージェント名または実行エージェントグループ名", "execHost":"実行ホスト名", "status":"受付配信制限の状態", "comStatus":"実行エージェントの状態", "conExe":ジョブ実行多重度, "job":実行中ジョブ数, "event":実行中イベントジョブ数, "que":キューイング中ジョブ数, "linkAgents":["関連する実行エージェントと優先順位"], "description":"説明文" }- メンバー
-
返却されるメンバーを次の表に示します。
表7‒49 実行エージェントの状況オブジェクトのメンバー一覧 メンバー
データ型
説明
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」を参照してください。
comStatus
string
「query」に指定するパラメーターmodeによって，次に示す内容を返却します。
-
modeが「agent（実行エージェント）」の場合
実行エージェントの状態を，定数ComStatusに規定した文字列定数で返却します。ただし，ジョブ配信遅延の軽減機能が無効な場合は，「NONE（該当せず）」を返却します。
-
modeが「agentGroup（実行エージェントグループ）」の場合
この項目を返却しません。
定数ComStatusの詳細については，「7.4.14(2) ComStatus」を参照してください。
conExe
long
「query」に指定するパラメーターmodeによって，次に示す内容を返却します。
-
modeの値が「agent（実行エージェント）」の場合
ジョブ実行多重度を0〜4294967295の範囲の数値で返却します。
-
modeの値が「agentGroup（実行エージェントグループ）」の場合
この項目を返却しません。
que
long
キューイング中のUNIXジョブ，PCジョブ，アクションジョブ，カスタムジョブ，および引き継ぎ情報設定ジョブの数を0以上の数値で返却します。
job
long
「query」に指定するパラメーターmodeによって，次に示す内容を返却します。
-
modeの値が「agent（実行エージェント）」の場合
実行中のUNIXジョブ，PCジョブ，アクションジョブ，カスタムジョブ，および引き継ぎ情報設定ジョブの数を0以上の数値で返却します。
-
modeの値が「agentGroup（実行エージェントグループ）」の場合
この項目を返却しません。
event
long
「query」に指定するパラメーターmodeによって，次に示す内容を返却します。
-
modeの値が「agent（実行エージェント）」の場合
実行中のイベントジョブ数を0以上の数値で返却します。
-
modeの値が「agentGroup（実行エージェントグループ）」の場合
この項目を返却しません。
linkAgents
string[]
「query」に指定するパラメーターmodeによって，次に示す内容を返却します。
-
modeの値が「agent（実行エージェント）」の場合
「null」を返却します。
-
modeの値が「agentGroup（実行エージェントグループ）」の場合
関連する実行エージェントと優先順位を配列で返却します。関連する実行エージェントと優先順位は次の形式で返却します。
実行エージェント名:優先順位
実行エージェント名は1〜255バイトの文字列で返却します。
優先順位は1〜16の範囲の数値で返却します。
ただし，関連する実行エージェントが存在しない場合は，要素数0個の配列を返却します。
description
string
説明文を0〜80バイトの文字列で返却します。
-