status-job

概要

ジョブの状態を取得します。開始済みジョブの状態に応じたコマンドの戻り値を返します。
ジョブパラメータの指定を省略した場合、指定したジョブ名で実行された全ての実行結果の一覧を取得します。
オプションを指定することで、状態を表示させるジョブを限定することができます。
ジョブ開始コマンドにリクエストID(--reqid)を指定している場合は、リクエストID指定で状態を表示するジョブ実行を特定することができます。

パス

${BS_HOME}/bin

権限

本コマンドを実行するには、アカウントに以下のいずれかのロールが必要です。

書式
status-job <接続オプション> <コマンドオプション>
接続オプション

WebOTX Batch Serverのコマンドは、バッチドメインエージェントを経由して各バッチコンテナへ指示を行います。
そのため、WebOTX Batch Serverが提供する主なコマンドはバッチドメインエージェントへの接続オプションの指定が必要です。

{--user <user> --password <password> [--host <host>] [--port <port>] [--responseTimeout <responseTimeout>]
 [--responseRetry <responseRetry>]}
接続オプション
オプション名 説明
--user <user> バッチドメインエージェントに接続するアカウント名を指定します。
バッチドメインエージェントが稼働しているサーバ上のOSユーザのアカウント名を指定します。
--password <password> アカウントのパスワードを指定します。
バッチドメインエージェントが稼働しているサーバ上のOSユーザのパスワードを指定します。
--host <host> 接続先のバッチドメインエージェントのIPアドレス、または、ホスト名を指定します。
ドメインセットアップ時に ${BS_HOME}/<domainName>.properties 中の domain.admin.host に指定したIPアドレス、または、ホスト名を指定します。
オプション未指定時に使用される既定値はlocalhostです。
--port <port> 接続先のバッチドメインエージェントのNativeコマンド受信用ポート番号(既定値:6412)を指定します。
ドメインセットアップ時に ${BS_HOME}/<domainName>.properties 中の webotx.batch.domain.http.port に指定したポート番号を指定します。
オプション未指定時に使用される既定値は6412です。
--responseTimeut <responseTimeut> コマンドを実行した後、バッチドメインエージェント側から実行結果を受信するまでの最大待ち時間(タイムアウト値)を指定します。
既定値は180秒です。
1以上の整数値を指定することができ、単位は秒になります。
--responseRetry <responseRetry> タイムアウト時に処理をリトライする上限回数を指定します。既定値は-1(無制限にリトライ実行)となります。
-1、または0以上の整数値を指定することができ、単位はリトライ回数になります。
コマンドオプション
{--jobname <jobname> [--batchap <batchap>] [--batchapgroup <batchapgroup>]
 [--reqid <reqid>]
 [--parametersfile <parametersFile>] [jobParameters]
 [--serverResponseTimeoutRatio <serverResponseTimeoutRatio>] | --version | --help}
{--reqid <reqid> [--serverResponseTimeoutRatio <serverResponseTimeoutRatio>] | --version | --help}
コマンドオプション一覧
オプション名 説明
--jobname <jobName> ジョブ名を指定します。
--batchap <batchapName> バッチアプリケーション名を指定します。
指定を省略した場合は、既定値のバッチアプリケーション名 default が指定されます。
--batchapgroup <batchapGroupName> バッチアプリケーショングループ名を指定します。
指定を省略した場合は、既定値のバッチアプリケーショングループ名 default が指定されます。
--reqid <reqId> ジョブのリクエストIDを指定します。
リクエストIDには一意な値を指定する必要があります。
異なるジョブの実行において、同一のリクエストIDを指定すると異常終了します。
--parametersFile <filePath> ジョブパラメータファイル名を含むファイルの絶対パスを指定します。
ジョブパラメータファイルとは、ジョブのパラメータをkey=valueのプロパティファイル形式で記述したファイルです。
同一ファイル内に重複するkeyが指定された場合、後の行に記載されている値が優先されます。
<jobParameters>と重複するkeyがプロパティファイル内で指定された場合、<jobParameters>で指定された値が優先されます。
<jobParameters> ジョブパラメータをkey=valudeのプロパティ形式をコマンド引数として指定します。複数のパラメータを指定する場合、 (半角空白)区切りで指定します。
<jobParameters>内で重複するkeyが指定された場合、初めに記載された値が優先されます。
--parametersFileに指定したジョブパラメータファイルに含まれるkeyと重複するkeyが指定された場合、<jobParameters>で指定された値が優先されます。
再実行時に指定したパラメータは前回実行時に指定したパラメータに追加・上書きされます。
--serverResponseTimeoutRatio
     <serverResponseTimeoutRatio>
responseTimeoutで指定したコマンド実行側のタイムアウト値に対するバッチドメインエージェント側の最大待ち時間(タイムアウト値)の割合(%)を指定します。
既定値は10(%)です。
1以上の整数値を指定することができ、単位はパーセント(%)になります。
例えば、接続オプションである--responseTimeoutの値を240(秒)として、
--serverResponseTimeoutRatioで指定した値を20(%)とした場合、
バッチドメインエージェント側のタイムアウト値は240秒の20(%)である48秒となります。
--version コマンドのバージョンを表示します。
--help コマンドのヘルプを表示します。
戻り値
戻り値一覧
戻り値 ExitStatus(BatchStatus) 説明
1 FAILED(FAILED以外) その他エラー
100 QUEUING キューイングされた状態
101 COMPLETED ジョブが正常に終了している
102 COMPLETED_WITH_SKIPS ジョブが正常に終了したが、一部処理をスキップ
103 EXECUTING(STARTING) 実行中 (開始前)
104 EXECUTING(STARTED) 実行中
105 EXECUTING(STOPPING) 実行中 (停止待ち)
106 STOPPED 停止
107 FAILED(FAILED) 異常終了
108 NOOP 停止 (何も処理を実行していない)
109 UNKNOWN 不明な状態 (内部状態の保存に失敗等)
200 - ジョブリクエストキューイングエラー
キューがあふれたためジョブリクエストの投入に失敗
201 - 指定したジョブがデプロイされていない
202 - 指定したジョブが実行されていない(JobRepositoryが初期化された場合を含む)
210 - ジョブの開始エラー
指定したジョブのコンテナ上での開始に失敗
211 - ジョブの開始要求が取り消された
230 - 指定したコンテナが存在していない
231 - 利用可能なコンテナが存在していない
240 - コマンドとバッチドメインエージェントとの通信でエラー
241 - バッチドメインエージェントとコンテナ間での通信エラー
242 - JobRepositoryからの状態取得エラー
243 - 環境上の問題(設定ミス等)によるエラー
244 - 認証エラー
指定したアカウントの認証に失敗
245 - 権限エラー
指定したアカウントに当該操作を行う権限が割り当てられていない
250 - コマンドエラー (コマンド解析エラー)
255 - 異常終了。コマンド実行エラー
実行例
例1:ジョブ名を指定してジョブの状態を取得します。
[root@localhost bin]# ./status-job --user user --password pass --batchapgroup default --batchap default --jobname hello --reqid 15 jobParam1=value1 jobParam2=value2

 INFO - Command start processing (status-job)
 INFO - Command is done. (status-job)
ExitCode = 101
関連