Hitachi

JP1 Version 11 JP1/Automatic Job Management System 3 コマンドリファレンス


7.3.2 ステータス情報オブジェクト

ユニットのステータス情報を示すオブジェクトです。

ステータス情報オブジェクトのAPIでの取得可否については,「付録D.3 APIで取得できるステータス情報オブジェクトのメンバーの一覧」を参照してください。

形式
{
  "unitName":"ユニット完全名",
  "execID":"実行ID",
  "status":"状態",
  "schStartTime":"開始予定日時",
  "startTime":"開始日時",
  "reStartTime":"再実行開始日時",
  "endTime":"終了日時",
  "startDelayStatus":"開始遅延有無",
  "nestStartDelayStatus":"ユニット配下の開始遅延有無",
  "endDelayStatus":"終了遅延有無",
  "nestEndDelayStatus":"ユニット配下の終了遅延有無",
  "startDelayTime":"開始遅延日時",
  "endDelayTime":"終了遅延日時",
  "changeType":"計画一時変更の有無",
  "holdAttr":"保留属性",
  "registerTime":"ジョブ登録日時",
  "jobNumber":ジョブ番号,
  "retCode":"終了コード",
  "execHost":"実行ホスト名",
  "simpleUnitName":"ユニット名",
  "delayedStart":"開始遅延を監視する方法",
  "delayedStartTime":"開始遅延の監視を始める時刻",
  "delayedEnd":"終了遅延を監視する方法",
  "delayedEndTime":"終了遅延の監視を始める時刻",
  "monitoringJobnet":"ジョブネットの実行所要時間による終了遅延の監視方法",
  "timeRequiredForExecution":"ジョブネットの実行所要時間"
}
メンバー

返却されるメンバーを次の表に示します。

表7‒23 ステータス情報オブジェクトのメンバー一覧

メンバー

データ型

説明

unitName

string

ユニット完全名を1〜930バイトの文字列で返却します。

情報を取得できない場合は,長さ0バイトの文字列を返却します。

execID

string

実行IDを「@[mmmm]{A〜Z}nnnn」の形式で返却します(例:@10A200)。

情報を取得できない場合は,長さ0バイトの文字列を返却します。

status

string

ユニットの状態を,定数Statusに規定されている文字列定数で返却します。定数Statusの詳細については,「7.4.5(1) Status」を参照してください。

情報を取得できない場合は,「NONE(該当なし)」を返却します。

schStartTime

string

開始予定日時を返却します。開始予定日時は,1970年1月1日0時0分0秒からの経過時間(秒単位)が,次のISO 8601形式に変換されます。

YYYY-MM-DDThh:mm:ssTZD

ISO 8601形式の詳細については,「6.3 APIで利用できるデータ型」を参照してください。

情報を取得できない場合は,長さ0バイトの文字列を返却します。

startTime

string

開始日時を返却します。開始日時は,1970年1月1日0時0分0秒からの経過時間(秒単位)が,次のISO 8601形式に変換されます。

YYYY-MM-DDThh:mm:ssTZD

ISO 8601形式の詳細については,「6.3 APIで利用できるデータ型」を参照してください。

情報を取得できない場合は,長さ0バイトの文字列を返却します。

reStartTime

string

再実行開始日時を返却します。再実行開始日時は,1970年1月1日0時0分0秒からの経過時間(秒単位)が,次のISO 8601形式に変換されます。

YYYY-MM-DDThh:mm:ssTZD

ISO 8601形式の詳細については,「6.3 APIで利用できるデータ型」を参照してください。

情報を取得できない場合は,長さ0バイトの文字列を返却します。

endTime

string

終了日時を返却します。終了日時は,1970年1月1日0時0分0秒からの経過時間(秒単位)が,次のISO 8601形式に変換されます。

YYYY-MM-DDThh:mm:ssTZD

ISO 8601形式の詳細については,「6.3 APIで利用できるデータ型」を参照してください。

情報を取得できない場合は,長さ0バイトの文字列を返却します。

startDelayStatus

string

このユニットの開始遅延の有無を,定数DelayStartに規定されている文字列定数で返却します。定数DelayStartの詳細については,「7.4.5(2) DelayStart」を参照してください。

情報を取得できない場合は,「NONE(該当なし)」を返却します。

nestStartDelayStatus

string

このユニットの配下の開始遅延の有無を,定数DelayStartに規定されている文字列定数で返却します。定数DelayStartの詳細については,「7.4.5(2) DelayStart」を参照してください。

情報を取得できない場合は,「NONE(該当なし)」を返却します。

endDelayStatus

string

このユニットの終了遅延の有無を,定数Delayendに規定されている文字列定数で返却します。定数DelayEndの詳細については,「7.4.5(3) DelayEnd」を参照してください。

情報を取得できない場合は,「NONE(該当なし)」を返却します。

nestEndDelayStatus

string

このユニットの配下の終了遅延の有無を,定数Delayendに規定されている文字列定数で返却します。定数DelayEndの詳細については,「7.4.5(3) DelayEnd」を参照してください。

情報を取得できない場合は,「NONE(該当なし)」を返却します。

startDelayTime

string

開始遅延日時を返却します。開始遅延日時は,1970年1月1日0時0分0秒からの経過時間(秒単位)が,次のISO 8601形式に変換されます。

YYYY-MM-DDThh:mm:ssTZD

ISO 8601形式の詳細については,「6.3 APIで利用できるデータ型」を参照してください。

情報を取得できない場合は,長さ0バイトの文字列を返却します。

endDelayTime

string

終了遅延日時を返却します。終了遅延日時は,1970年1月1日0時0分0秒からの経過時間(秒単位)が,次のISO 8601形式に変換されます。

YYYY-MM-DDThh:mm:ssTZD

ISO 8601形式の詳細については,「6.3 APIで利用できるデータ型」を参照してください。

情報を取得できない場合は,長さ0バイトの文字列を返却します。

changeType

string

計画一時変更の有無を,定数ChangeTypeに規定されている文字列定数で返却します。定数ChangeTypeの詳細については,「7.4.5(4) ChangeType」を参照してください。

情報を取得できない場合は,「NONE(該当なし)」を返却します。

holdAttr

string

保留属性を,定数HoldAttrに規定されている文字列定数で返却します。定数HoldAttrの詳細については,「7.4.5(5) HoldAttr」を参照してください。

情報を取得できない場合は,「NONE(該当なし)」を返却します。

registerTime

string

ジョブ登録日時を返却します。ジョブ登録日時は,1970年1月1日0時0分0秒からの経過時間(秒単位)が,次のISO 8601形式に変換されます。

YYYY-MM-DDThh:mm:ssTZD

ISO 8601形式の詳細については,「6.3 APIで利用できるデータ型」を参照してください。

情報を取得できない場合は,長さ0バイトの文字列を返却します。

jobNumber

int

ジョブ番号を数値で返却します。

情報を取得できない場合,または情報がないユニットの場合は,「-1」を返却します。

retCode

string

終了コードを文字列で返却します。

情報を取得できない場合,または情報がないユニットの場合は,長さ0バイトの文字列を返却します。

execHost

string

実行ホスト名を0〜255バイトの文字列で返却します。

情報を取得できない場合,またはユニットが開始していない場合は,長さ0バイトの文字列を返却します。

simpleUnitName

string

ユニット名を0〜30バイトの文字列で返却します。

情報を取得できない場合は,長さ0バイトの文字列を返却します。

delayedStart

string

開始遅延を監視する方法を,定数DelayMonitorに規定されている文字列で返却します。

情報を取得できない場合は,「NONE(該当せず)」を返却します。定数DelayMonitorの詳細については,「7.4.5(7) DelayMonitor」を参照してください。

delayedStartTime

string

開始遅延の監視を始める時刻を返却します。

メンバーdelayedStartで取得した定数DelayMonitorによって,次に示すとおりに返却します。

  • 定数DelayMonitorがABSOLUTE」の場合

    開始遅延の監視を始める時刻を「hh:mm」の形式で返却します。

    hh:時間を00〜47(単位:時)で返却します。

    mm:分を00〜59(単位:分)で返却します。

  • 定数DelayMonitorが「ROOT」,「TOP」,または「OWN」の場合

    開始遅延の監視を始める相対時刻(単位:分)を1〜2879の数字で返却します。

  • 定数DelayMonitorが「ABSOLUTE」,「ROOT」,「TOP」,または「OWN」以外の場合

    長さ0バイトの文字列を返却します。

delayedEnd

string

終了遅延を監視する方法を,定数DelayMonitorに規定されている文字列で返却します。

情報を取得できない場合は,「NONE(該当せず)」を返却します。定数DelayMonitorの詳細については,「7.4.5(7) DelayMonitor」を参照してください。

delayedEndTime

string

終了遅延の監視を始める時刻を返却します。

メンバーdelayedEndで取得した定数DelayMonitorによって,次に示すとおりに返却します。

  • 定数DelayMonitorがABSOLUTE」の場合

    開始遅延の監視を始める時刻を「hh:mm」の形式で返却します。

    hh:時間を00〜47(単位:時)で返却します。

    mm:分を00〜59(単位:分)で返却します。

  • 定数DelayMonitorが「ROOT」,「TOP」,または「OWN」の場合

    開始遅延の監視を始める相対時刻(単位:分)を1〜2879の数字で返却します。

  • 定数DelayMonitorが「ABSOLUTE」,「ROOT」,「TOP」,または「OWN」以外の場合

    長さ0バイトの文字列を返却します。

monitoringJobnet

string

ジョブネットの実行所要時間による終了遅延の監視方法を,定数MonitoringJobnetに規定されている文字列で返却します。

情報を取得できない場合は,「NONE(該当せず)」を返却します。定数MonitoringJobnetの詳細については,「7.4.5(8) MonitoringJobnet」を参照してください。

timeRequiredForExecution

string

ジョブネットの実行所要時間を返却します。

メンバーmonitoringJobnetで取得した定数MonitoringJobnetによって,次に示すとおりに返却します。

  • 定数MonitoringJobnetが「TIME_REQUIRED_FOR_EXECUTION_YES」の場合

    ジョブネットの実行所要時間(単位:分)を1〜2879の数字で返却します。

  • 定数MonitoringJobnetが「TIME_REQUIRED_FOR_EXECUTION_YES」以外の場合

    長さ0バイトの文字列を返却します。

  • 情報を取得できない場合

    長さ0バイトの文字列を返却します。