7.1.9　遅延監視変更API

指定した実行登録済みのジョブネットの遅延監視の設定を，一時的に変更します。

遅延監視設定の一時変更の詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド　4.5.7 ジョブネットの遅延監視の設定を一時変更する」を参照してください。

このAPIは，JP1/AJS3 - Web Consoleのバージョンが11-10以降のときに使用できます。バージョン情報の取得APIの戻り値（productVersionNumber）が111000以上であることを確認して，使用してください。

実行権限

ログインしたJP1ユーザーが，遅延監視の設定を変更するユニットに対して，次に示すどれかのJP1権限が与えられている必要があります。

JP1_AJS_Admin権限
JP1_AJS_Manager権限
JP1_AJS_Operator権限

リクエストの形式

リクエスト行

POST /application/component/apiVersion/objects/statuses/unitName:execID/actions/changeDelayMonitor/invoke httpVersion

メッセージボディ

{
  "parameters":{
    "manager":"マネージャーホスト名またはIPアドレス",
    "serviceName":"スケジューラーサービス名",
    "delayedStart":"開始遅延を監視する方法",
    "delayedStartTime":"開始遅延の監視を始める時刻",
    "delayedEnd":"終了遅延を監視する方法",
    "delayedEndTime":"終了遅延の監視を始める時刻",
    "monitoringJobnet":"ジョブネットの実行所要時間による終了遅延の監視方法",
    "timeRequiredForExecution":"ジョブネットの実行所要時間"
  }
}

APIのバージョン

リソースを一意に識別する情報

リソースを一意に識別する情報を次の表に示します。

なお，パラメーターの指定に誤りがある場合，またはパラメーターを指定しなかった場合は，リソースを一意に識別できないため，ステータスコード「404」のエラーになります。

リソースを一意に識別する情報	データ型	値の説明	必須・任意
unitName	string	要求対象のユニットのユニット完全名を，1〜930バイトの文字列で指定します。	必須
execID	string	実行IDを，文字列で指定します。指定する形式は「`@[`mmmm`]{`A〜Z`}`nnnn」です（例：`@10A200`）`。`	必須

リソースを一意に識別する情報

データ型

値の説明

必須・任意

unitName

string

要求対象のユニットのユニット完全名を，1〜930バイトの文字列で指定します。

必須

execID

string

実行IDを，文字列で指定します。

指定する形式は「@[mmmm]{A〜Z}nnnn」です（例：@10A200）。

必須

パラメーター

リクエストのメッセージボディのparametersに指定するパラメーターを次の表に示します。

表7‒9　遅延監視変更APIのパラメーター一覧
パラメーター	データ型	値の説明	必須・任意
`manager`	string	マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。	必須
`serviceName`	string	スケジューラーサービス名を，1〜30バイトの文字列で指定します。	必須
`delayedStart^※`	string	開始遅延を監視する方法を，定数`DelayMonitorType`に規定されている文字列定数で指定します。定数`DelayMonitorType`の詳細については，「7.4.11(1) DelayMonitorType」を参照してください。開始遅延の監視設定を変更しない場合，このパラメーターを指定しないか，このパラメーターに「`null」`を指定してください。ルートジョブネットに対して，指定できない定数を指定した場合，エラーになります。ジョブネットが実行中の場合は，開始遅延の監視設定を変更できません。このパラメーターを指定するとエラーになります。	任意
`delayedStartTime`	string	開始遅延監視を始める時刻を，文字列で指定します。パラメーター`delayedStart`で開始遅延の監視設定を変更する場合は，このパラメーターを必ず指定してください。省略するとエラーになります。パラメーター`delayedStart`に「`ABSOLUTE`（絶対時刻）」を指定した場合は，開始遅延の監視を始める絶対時刻を，「hh`:`mm」の形式で指定します。指定する時刻は，要求先JP1/AJS3 - Managerのスケジューラーサービスローカル日時で指定してください。指定できる値を次に示します。 hh：時間を指定します。時間に指定できる値は00〜47（単位：時）です。 mm：分を指定します。分に指定できる値は00〜59（単位：分）です。パラメーター`delayedStart`に「`ROOT`（ルートジョブネットの開始予定時刻からの相対時刻）」，「`TOP`（上位ジョブネットの開始予定時刻からの相対時刻）」または「`OWN`（自ジョブネットの開始予定時刻からの相対時刻）」を指定した場合は，相対時刻を，「hh`:`mm」の形式で指定します。指定する時刻は，要求先JP1/AJS3 - Managerのスケジューラーサービスローカル日時で指定してください。指定できる値を次に示します。 hh：時間を指定します。時間に指定できる値は00〜47（単位：時）です。 mm：分を指定します。分に指定できる値は00〜59（単位：分）です。ただし，00:00は指定できません。00:01〜47:59の範囲内で指定してください。パラメーター`delayedStart`を省略した場合，またはパラメーター`delayedStart`に「`NOT`（監視しない）」を指定した場合は，このパラメーターの指定は無視されます。	任意
`delayedEnd^※`	string	終了遅延を監視する方法を，定数`DelayMonitorType`に規定されている文字列定数で指定します。定数`DelayMonitorType`の詳細については，「7.4.11(1) DelayMonitorType」を参照してください。終了遅延の監視設定を変更しない場合は，このパラメーターを指定しないか，このパラメーターに「`null」`を指定してください。ルートジョブネットに対して，指定できない定数を指定した場合，エラーになります。	任意
`delayedEndTime`	string	終了遅延の監視を始める時刻を，文字列で指定します。パラメーター`delayedEnd`で終了遅延の監視設定を変更する場合は，このパラメーターを必ず指定してください。省略するとエラーになります。パラメーター`delayedEnd`に「`ABSOLUTE`（絶対時刻）」を指定した場合は，終了遅延の監視を始める絶対時刻を，「hh`:`mm」の形式で指定します。指定する時刻は，要求先JP1/AJS3 - Managerのスケジューラーサービスローカル日時で指定してください。指定できる値を次に示します。 hh：時間を指定します。時間に指定できる値は00〜47（単位：時）です。 mm：分を指定します。分に指定できる値は00〜59（単位：分）です。パラメーター`delayedEnd`に「`ROOT`（ルートジョブネットの開始予定時刻からの相対時刻）」，「`TOP`（上位ジョブネットの開始予定時刻からの相対時刻）」または「`OWN`（自ジョブネットの開始予定時刻からの相対時刻）」を指定した場合は，相対時刻を，「hh`:`mm」の形式で指定します。指定する時刻は，要求先JP1/AJS3 - Managerのスケジューラーサービスローカル日時で指定してください。指定できる値を次に示します。 hh：時間を指定します。時間に指定できる値は00〜47（単位：時）です。 mm：分を指定します。分に指定できる値は00〜59（単位：分）です。ただし，00:00は指定できません。00:01〜47:59の範囲内で指定してください。パラメーター`delayedEnd`を省略した場合，またはパラメーター`delayedEnd`に「`NOT`（監視しない）」を指定した場合は，このパラメーターの指定は無視されます。	任意
`monitoringJobnet^※`	string	ジョブネットの実行所要時間による終了遅延の監視方法を，定数`MonitoringJobnetType`に規定されている文字列定数で指定します。定数`MonitoringJobnetType`の詳細については，「7.4.11(2) MonitoringJobnetType」を参照してください。ジョブネットの実行所要時間による終了遅延の監視設定を変更しない場合は，このパラメーターを指定しないか，このパラメーターに「`null」`を指定してください。	任意
`timeRequiredForExecution`	string	ジョブネットの実行所要時間による終了遅延監視をする場合に，ジョブネットの実行所要時間を文字列で指定します。パラメーター`monitoringJobnet`でジョブネットの実行所要時間による終了監視遅延監視を変更する場合は，このパラメーターを必ず指定してください。省略するとエラーになります。パラメーター`monitoringJobnet`に「`TIME_REQUIRED_FOR_EXECUTION`（実行所要時間）」を指定した場合は，ジョブネットの実行所要時間を，「hh`:`mm」の形式で指定します。指定できる値を次に示します。 hh：時間を指定します。時間に指定できる値は00〜47（単位：時）です。 mm：分を指定します。分に指定できる値は00〜59（単位：分）です。ただし，00:00は指定できません。00:01〜47:59の範囲内で指定してください。パラメーター`monitoringJobnet`を省略した場合，またはパラメーター`monitoringJobnet`に「`NOT`（監視しない）」を指定した場合は，このパラメーターの指定は無視されます。	任意

注※

開始遅延を監視する方法（delayedStart），終了遅延を監視する方法（delayedEnd），またはジョブネットの実行所要時間による終了遅延の監視方法（monitoringJobnet）のどれかを必ず指定してください。どれも指定しなかった場合（nullを指定した場合を含む）は，エラーになります。

ステータスコード

レスポンスで返却するステータスコードを次の表に示します。

ステータスコード	メッセージ	説明
200	OK	遅延監視設定の変更が成功しました。
400	Bad Request	引数が不正です。
401	Unauthorized	認証が必要です。
403	Forbidden	実行権限がありません。
404	Not found	リソースにアクセスする権限がありません。または，リソースがありません。
409	Conflict	リクエストは現在のリソースの状態と矛盾しているため，処理を続行できません。
412	Precondition failed	Web Consoleサーバが利用できません。
500	Server-side error	Web Consoleサーバ処理エラーが発生しました。

戻り値

なし（レスポンスのメッセージボディのサイズは0バイトです）

使用例1

指定したジョブネットの遅延監視の設定を，一時的に変更するAPIの使用例を次に示します。

なお，この使用例では，遅延監視の設定を次のように変更します。

ジョブネットの開始遅延の遅延監視を，絶対時刻で08:30から開始する
ジョブネットの終了遅延の遅延監視を設定しない
ジョブネットの実行所要時間による終了遅延監視を10分とする

リクエストの例

POST /ajs/api/v1/objects/statuses/%2FJobGroup%2FJobnet:%40A100/actions/changeDelayMonitor/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "delayedStart":"ABSOLUTE",
    "delayedStartTime":"08:30",
    "delayedEnd":"NOT",
    "monitoringJobnet":"TIME_REQUIRED_FOR_EXECUTION",
    "timeRequiredForExecution":"00:10"
  }
}

レスポンスの例

HTTP/1.1 200 OK
Content-Type: text/plain
Cache-Control: no-store, no-cache, max-age=0
Date: Mon, 08 Aug 2016 09:39:28 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server

使用例2

指定したジョブネットの終了遅延の監視設定だけを一時的に変更するAPIの使用例を次に示します。

リクエストの例

POST /ajs/api/v1/objects/statuses/%2FJobGroup%2FJobnet:%40A100/actions/changeDelayMonitor/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "delayedEnd":"OWN",
    "delayedEndTime":"00:10"
  }
}

レスポンスの例

HTTP/1.1 200 OK
Content-Type: text/plain
Cache-Control: no-store, no-cache, max-age=0
Date: Mon, 08 Aug 2016 09:39:28 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server

ページの先頭へ

7.1.9 遅延監視変更API

7.1.9　遅延監視変更API