Hitachi

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

7.1.6　確定実行登録API

指定したジョブネットを確定実行登録します。

確定実行登録の詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド　4.1.1(3) 確定実行登録」を参照してください。

また，日時指定の確定実行登録の詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド　4.5.2 ジョブネットに実行予定を追加する」もあわせて参照してください。

実行権限

ログインしたJP1ユーザーが，確定実行登録するユニットに対して，次に示すどれかのJP1権限が与えられている必要があります。

  • JP1_AJS_Admin権限

  • JP1_AJS_Manager権限

  • JP1_AJS_Operator権限

リクエストの形式
リクエスト行
POST /application/component/apiVersion/objects/definitions/unitName/actions/registerFixedExec/invoke httpVersion
メッセージボディ
{
  "parameters":{
    "manager":"マネージャーホスト名またはIPアドレス",
    "serviceName":"スケジューラーサービス名",
    "fixedScheduleFrom":"確定期間の開始年月日",
    "fixedScheduleTo":"確定期間の終了年月日",
    "futureGeneration":未来世代数,
    "startTime":"ジョブネットの実行を開始する日時",
    "passedDaemonStarts":"スケジューラーサービス起動時に予定時刻を超過していた場合の動作",
    "holding":ジョブネットの実行を保留するかどうか,
    "macro":[マクロ変数のオブジェクト,...]
  }
}
APIのバージョン

v1

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

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

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

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

データ型

説明

必須・任意

unitName

string

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

必須
パラメーター

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

表7‒6　確定実行登録APIのパラメーター一覧

パラメーター

データ型

値の説明

必須・任意

manager

string

マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。

必須

serviceName

string

スケジューラーサービス名を，1〜30バイトの文字列で指定します。

必須

fixedScheduleFrom※1

string

確定期間を指定して確定実行登録する場合に指定します。

確定実行スケジュールで実行する確定期間の開始年月日を，「YYYY-MM-DD」の形式で指定します。指定できる値を次に示します。

  • YYYY：年を指定します。

    年に指定できる値は，次のとおりです。

    JP1/AJS3 - Web Consoleのバージョンが13-00以降，かつ接続先JP1/AJS3 - Managerのバージョンが13-00以降の場合：

    1994〜環境設定パラメーターSCHEDULELIMITに設定した値（単位：年）※2

    上記以外の場合：

    1994〜2036（単位：年）

  • MM：月を指定します。

    月に指定できる値は，01〜12（単位：月）です。

  • DD：日にちを指定します。

    日にちに指定できる値は，01〜指定した月の最終日（単位：日）です。

指定する年月日は，要求先JP1/AJS3 - Managerのスケジューラーサービスローカル日時で指定してください。

確定期間の開始年月日を指定した場合，確定期間の終了年月日は必ず指定してください。指定しない場合，エラーになります。

確定期間を指定しない場合は，このパラメーターを指定しないか，またはこのパラメーターに「null」を指定してください。

任意

fixedScheduleTo※1

string

確定期間を指定して確定実行登録する場合に指定します。

確定実行スケジュールで実行する確定期間の終了年月日を，「YYYY-MM-DD」の形式で指定します。指定できる値を次に示します。

  • YYYY：年を指定します。

    年に指定できる値は，次のとおりです。

    JP1/AJS3 - Web Consoleのバージョンが13-00以降，かつ接続先JP1/AJS3 - Managerのバージョンが13-00以降の場合：

    1994〜環境設定パラメーターSCHEDULELIMITに設定した値（単位：年）※2

    上記以外の場合：

    1994〜2036（単位：年）

  • MM：月を指定します。

    月に指定できる値は，01〜12（単位：月）です。

  • DD：日にちを指定します。

    日にちに指定できる値は，01〜指定した月の最終日（単位：日）です。

指定する年月日は，要求先JP1/AJS3 - Managerのスケジューラーサービスローカル日時で指定してください。

確定期間の終了年月日を指定した場合，確定期間の開始年月日は必ず指定してください。指定しない場合，エラーになります。

確定期間を指定しない場合は，このパラメーターを指定しないか，またはこのパラメーターに「null」を指定してください。

任意

futureGeneration※1

int

未来世代数を指定して確定実行登録する場合に指定します。

何回先まで実行予定を作成するかを数値で指定します。指定できる値は，1〜99（単位：世代）です。

未来世代数を指定しない場合は，このパラメーターを指定しないか，またはこのパラメーターに「0」を指定してください。

任意

startTime※1

string

ジョブネットのスケジュール定義に関係なく，日時を指定して実行予定を追加する場合に指定します。

ジョブネットの実行を開始する日時を，「YYYY-MM-DDThh:mm」の形式で指定します。

指定できる値を次に示します。

  • YYYY：年を指定します。年に指定できる値は，次のとおりです。

    JP1/AJS3 - Web Consoleのバージョンが13-00以降，かつ接続先JP1/AJS3 - Managerのバージョンが13-00以降の場合：

    1994〜環境設定パラメーターSCHEDULELIMITに設定した値（単位：年）※2

    上記以外の場合：

    1994〜2036（単位：年）

  • MM：月を指定します。月に指定できる値は，01〜12（単位：月）です。

  • DD：日にちを指定します。日にちに指定できる値は，01〜指定した月の最終日（単位：日）です。

  • hh：時間を指定します。時間に指定できる値は，00〜47（単位：時）です。

  • mm：分を指定します。分に指定できる値は，00〜59（単位：分）です。

指定する日時は，要求先JP1/AJS3 - Managerのスケジューラーサービスローカル日時で指定してください。

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

バージョン情報の取得APIの詳細については，「7.1.37 バージョン情報の取得API」を参照してください。

任意

passedDaemonStarts

string

スケジューラーサービス起動時に予定時刻を超過していた場合の動作を，定数PlannedTimePassedTypeに規定されている文字列定数で指定します。定数PlannedTimePassedTypeの詳細については，「7.4.3(1) PlannedTimePassedType」を参照してください。

このパラメーターの指定は，スケジューラーサービスの起動モードがウォームスタートまたはディザスターリカバリースタートの場合だけ有効です。

このパラメーターは，確定期間，未来世代数を指定した場合と，日時を指定した場合で，動作が異なります。

動作を次に示します。

  • 確定期間，未来世代数を指定した場合，このパラメーターを省略するとエラーになります。

  • 日時を指定した場合，このパラメーターを指定しなかったとき，またはこのパラメーターに「null」を指定したときは，「IMMEDIATE（すぐに実行する）」が仮定されます。このパラメーターは，JP1/AJS3 - Web Consoleのバージョンが11-10以降，かつ接続先JP1/AJS3 - Managerのバージョンが11-10以降の場合だけ指定できます。バージョン情報の取得APIの戻り値（productVersionNumber）が111000以上，かつJP1/AJS3 - Managerのプロトコルバージョンの取得APIの戻り値（protocolVersionNumber）が1110以上であることを確認して，指定してください。

    バージョン情報の取得APIの詳細については，「7.1.37 バージョン情報の取得API」を参照してください。

    JP1/AJS3 - Managerのプロトコルバージョンの取得APIの詳細については，「7.1.38 JP1/AJS3 - Managerのプロトコルバージョンの取得API」を参照してください。

任意

holding

boolean

確定実行登録時にジョブネットの実行を保留するかどうかを指定します。

保留する場合は「true」を指定します。保留しない場合は「false」を指定します。

「true」を指定した場合は，実行登録時に作成される世代のうち，最初の実行世代に対して保留を設定します。

このパラメーターを指定しなかった場合は，「false」が仮定されます。

このパラメーターは，JP1/AJS3 - Web Consoleのバージョンが11-10以降，かつ接続先JP1/AJS3 - Managerのバージョンが11-10以降の場合だけ指定できます。バージョン情報の取得APIの戻り値（productVersionNumber）が111000以上，かつJP1/AJS3 - Managerのプロトコルバージョンの取得APIの戻り値（protocolVersionNumber）が1110以上であることを確認して，指定してください。

バージョン情報の取得APIの詳細については，「7.1.37 バージョン情報の取得API」を参照してください。

JP1/AJS3 - Managerのプロトコルバージョンの取得APIの詳細については，「7.1.38 JP1/AJS3 - Managerのプロトコルバージョンの取得API」を参照してください。

任意

macro

object[]

ルートジョブネット配下のジョブで使用しているマクロ変数に設定する情報を，マクロ変数のオブジェクトの配列で指定します。

マクロ変数のオブジェクトの詳細については，「7.3.5 マクロ変数オブジェクト」を参照してください。

マクロ変数は32個まで指定できます。複数指定する場合，「マクロ変数名のバイト数＋引き継ぎ情報のバイト数＋4」の値が4,085以内になるよう指定してください。同じマクロ変数を複数指定した場合，最初に指定したマクロ変数の引き継ぎ情報が引き継がれます。

マクロ変数を引き継がない場合は，このパラメーターを指定しないか，またはこのパラメーターに「null」を指定してください。

任意
注※1

確定期間（fixedScheduleFromとfixedScheduleTo），未来世代数（futureGeneration）または日時指定の予定追加（startTime）のどれかを必ず指定してください。どれも指定しなかった場合（nullを指定した場合を含む）は，エラーになります。

確定期間と未来世代数は同時に指定できます。しかし，日時指定の予定追加は，確定期間および未来世代数と同時に指定できません。指定するとエラーになります。

注※2

接続先JP1/AJS3 - Managerの環境設定パラメーターSCHEDULELIMITの詳細については，マニュアル「JP1/Automatic Job Management System 3 構築ガイド　20.4.2(123) SCHEDULELIMIT」を参照してください。

また，JP1/AJS3 - Web Consoleのバージョンはバージョン情報の取得APIの戻り値（productVersionNumber）を，接続先JP1/AJS3 - Managerのバージョンは，JP1/AJS3 - Managerのプロトコルバージョンの取得APIの戻り値（protocolVersionNumber）を確認してください。

バージョン情報の取得APIの詳細については，「7.1.37 バージョン情報の取得API」を参照してください。

JP1/AJS3 - Managerのプロトコルバージョンの取得APIの詳細については，「7.1.38 JP1/AJS3 - Managerのプロトコルバージョンの取得API」を参照してください。

ステータスコード

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

ステータスコード

テキスト記述

説明

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バイトです）

日時を指定した場合のレスポンスのメッセージボディ
{
  "execID":"実行ID"
}
戻り値
確定期間，未来世代数を指定した場合

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

日時を指定した場合

ステータスコードが「200」のとき，次の情報を返却します。

メンバー

データ型

説明

execID

string

実行IDを「@[mmmm]{A〜Z}nnnn」の形式で返却します（例：@10A200）。
使用例1

期間を指定して，確定実行登録するAPIの使用例を次に示します。

リクエストの例
POST /ajs/api/v1/objects/definitions/%2FJobGroup%2FJobnet/actions/registerFixedExec/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "fixedScheduleFrom":"2015-09-07",
    "fixedScheduleTo":"2015-09-11",
    "passedDaemonStarts":"IMMEDIATE"
  }
}
使用例2

未来世代数とマクロ変数を指定して，確定実行登録するAPIの使用例を次に示します。

リクエストの例
POST /ajs/api/v1/objects/definitions/%2FJobGroup%2FJobnet/actions/registerFixedExec/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "futureGeneration":5,
    "passedDaemonStarts":"IMMEDIATE",
    "macro":[{"name":"AJS2KEY1","value":"1"},{"name":"AJS2KEY2","value":"2"}]
  }
}
使用例3

ジョブネットのスケジュール定義に関係なく，日時を指定して実行予定を追加するAPIの使用例を次に示します。

リクエストの例
POST /ajs/api/v1/objects/definitions/%2FJobGroup%2FJobnet/actions/registerFixedExec/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "startTime":"2016-09-07T08:30",
    "passedDaemonStarts":"IMMEDIATE"
  }
}
レスポンス（メッセージボディ）の例
{
  "execID": "@A100"
}
使用例4

確定実行登録時にジョブネットの初回の実行開始を保留にするAPIの使用例を次に示します。

リクエストの例
POST /ajs/api/v1/objects/definitions/%2FJobGroup%2FJobnet/actions/registerFixedExec/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "fixedScheduleFrom":"2016-09-07",
    "fixedScheduleTo":"2016-09-11",
    "passedDaemonStarts":"IMMEDIATE",
    "holding":true
  }
}

ページの先頭へ

Copyright (C) 2023, 2024, Hitachi, Ltd.

Copyright (C) 2023, 2024, Hitachi Solutions, Ltd.