ページの先頭行へ戻る
Systemwalker Operation Manager V17.0.1 リファレンス集
第20章 ファイルリファレンス > 20.9 クラウドサービス連携の定義ファイル【Windows版】【Linux版】 > 20.9.1 接続情報ファイル
前次

20.9.1 接続情報ファイル

ファイル名

nnnnn.json

※nnnnは任意の文字

使用用途

REST実行ジョブがクラウドサービスに接続するために必要なパラメタを記載する接続情報ファイルです。REST実行ジョブを利用する場合には必須です。REST実行ジョブ登録時には、本ファイルをフルパスで指定します。

格納場所

任意

ファイル形式

本ファイルはJSON形式、文字コードはUTF-8で記載します。string型の値にダブルクォーテーションやバックスラッシュ、および、制御文字などを含める場合、JSONのフォーマットに従いエスケープした文字列を指定してください。

パラメタ

requestオブジェクトのパラメタ

requestオブジェクトの指定は必須です。

パラメタ

キー名・型・デフォルト値

説明

接続URL (*)

キー名

url

接続先のURLを以下の形式で指定します。

  • httpsを使用する場合

    https://ホスト[:ポート番号]/リソースパス

  • httpを使用する場合

    http://ホスト[:ポート番号]/リソースパス

URLは2083バイト以内で指定します。URL内で利用可能な文字については接続先のクラウドサービスの規約に従ってください。

型

string

デフォルト値

なし

HTTPメソッド (*)

キー名

method

HTTPメソッドを設定します。

GET/PUT/POST/DELETEのいずれかを指定します。

型

string

デフォルト値

なし

認証情報名

キー名

authName

jobschsetauthinfoコマンドで設定したリクエストの認証情報名を指定します。コマンドの詳細については、“4.9 jobschsetauthinfoコマンド【Windows版】【Linux版】”を参照してください。

省略した場合、認証処理を行いません。

型

string

デフォルト値

なし

プロキシサーバの認証情報名

キー名

proxyAuthName

jobschsetauthinfoコマンドで設定したプロキシサーバの認証情報名を指定します。コマンドの詳細については、“4.9 jobschsetauthinfoコマンド【Windows版】【Linux版】”を参照してください。

省略した場合、プロキシサーバを利用しません。

型

string

デフォルト値

なし

クエリパラメータ

キー名

query

接続先URLにクエリパラメータを指定する場合、“パラメタ名:値”の形式で指定します。以下のようにパラメタ名と値はqueryオブジェクト内で複数指定可能です。

query: {
  パラメタ名1:値1,
  パラメタ名2:値2,
  …
}

クエリパラメータの値にjobschsetauthinfoコマンドで設定した任意のキーの値を設定したい場合は、以下のように値を“@任意のキー名@”の形式で指定することで、設定した値に置きかわります。

query: {
  パラメタ名:@任意のキー名@
}

パラメタ名および値は1024バイト以内で指定してください。

省略した場合、URLにクエリパラメータを追加しません。

型

object

デフォルト値

なし

HTTPリクエストヘッダ

キー名

header

追加のHTTPリクエストヘッダを指定する場合、“ヘッダ名:値”の形式で指定します。以下のようにヘッダ名と値はheaderオブジェクト内で複数指定可能です。

header: {
  ヘッダ名1:値1,
  ヘッダ名2:値2,
  …
}

リクエストヘッダの値にjobschsetauthinfoコマンドで設定した任意のキーの値を設定したい場合は、以下のように値を“@任意のキー名@”の形式で指定することで、設定した値に置きかかわります。

header: {
  ヘッダ名:@任意のキー名@
}

ヘッダ名および値は1024バイト以内で指定してください。

省略した場合、リクエストヘッダを追加しません。

型

object

デフォルト値

なし

HTTPリクエストボディ

キー名

body

HTTPリクエストボディとして指定するファイルをフルパスで指定します。

ファイルパスの長さは256バイト以内で指定してください。ファイルパスには、半角英数字、“/”、“: ”、“\”、“. ”、“_”(半角アンダーバー)、“-”(半角ハイフン)のみ指定可能です。

jobschsetauthinfoコマンドで設定した任意のキーの値をリクエストボディに設定する場合、“@任意のキー名@”の形式で指定することで、リクエスト時に設定した値に置き換わります。

省略した場合、リクエストボディは設定されません。

型

string

デフォルト値

なし

HTTPレスポンスヘッダ

キー名

resHeader

HTTPレスポンスのヘッダ情報を保存するファイルをフルパスで指定します。

ファイルパスの長さは256バイト以内で指定してください。ファイルパスには、半角英数字、“/”、“: ”、“\”、“. ”、“_”(半角アンダーバー)、“-”(半角ハイフン)のみ指定可能です。

指定ファイルが存在していた場合は上書きします。

本パラメタの指定を変更せず一意のファイル名で出力したい場合は、ファイル名に<date>の文字列を含めることで、出力時に<date>がYYYYMMDDhhmmssの日時情報に置換されて出力されます。この場合、置換後のファイルパス長が256バイトを超えないようにしてください。超えた場合、結果は出力されません。

省略した場合、ヘッダ情報のファイル出力は行いません。

型

string

デフォルト値

なし

HTTPレスポンスボディ

キー名

resBody

HTTPレスポンスのボディ情報を保存するファイルをフルパスで指定します。

ファイルパスの長さは256バイト以内で指定してください。ファイルパスには、半角英数字、“/”、“: ”、“\”、“. ”、“_”(半角アンダーバー)、“-”(半角ハイフン)のみ指定可能です。

指定ファイルが存在していた場合は上書きします。

本パラメタの指定を変更せず一意のファイル名で出力したい場合は、ファイル名に<date>の文字列を含めることで、出力時に<date>がYYYYMMDDhhmmssの日時情報に置換されて出力されます。この場合、置換後のファイルパス長が256バイトを超えないようにしてください。超えた場合、結果は出力されません。

省略した場合、ボディ情報のファイル出力は行いません。

型

string

デフォルト値

なし

接続タイムアウト時間

キー名

timeout

HTTPリクエストの接続タイムアウト時間を１～1800秒で指定します。

省略した場合デフォルトの10秒が設定されます。

型

number

デフォルト値

10

監視、強制終了リクエストに引継ぐキー

キー名

takeoverKeys

monitoringオブジェクトで指定する監視リクエストや、terminationオブジェクトで指定する強制終了リクエストのURLやリクエストボディに本HTTPリクエストの結果を引継ぎたい場合、引き継ぐレスポンス結果のキーを指定することでそのキーの値を引き継ぐことができます。

監視リクエストの場合、監視の終了判定キーおよび正常終了判定キーにも引き継ぐことができます。

引継ぎ先のURLやリクエストボディには本パラメタで指定した置き換え変数名を“<置き換え変数名>”の形式で記載しておくことで、抽出したキーの値に変換されます。

本パラメタは“置き換え変数名:抽出するキー”の形式で指定します。以下のように置き換え変数名と抽出するキーはtakeoverKeysオブジェクト内で複数指定可能です。

takeoverKeys: {
  置き換え変数名1:抽出するキー1(※),
  置き換え変数名2:抽出するキー2,
  …
}

置き換え変数名は64バイト以内の半角英数字で指定してください。

(※)抽出するキーの指定方法の詳細は、“抽出するキーの指定方法”を参照してください。

型

object

デフォルト値

なし

ジョブネット変数に設定するキー

キー名

jobnetValKeys

本HTTPレスポンスの結果をジョブネット変数に設定して後続ジョブと連携したい場合、本パラメタでレスポンスのキーを指定することでそのキーの値をジョブネット変数に設定することができます。

本パラメタで指定したキーは“ジョブネット変数名=キーの値”の形式で標準出力に出力されます。

リスト形式で複数のキーを指定することが可能です。

本パラメタは“ジョブネット変数名:抽出するキー”の形式で指定します。以下のようにジョブネット変数名と抽出するキーはjobnetValKeysオブジェクト内で複数指定可能です。

jobnetValKeys: {
  ジョブネット変数名1:抽出するキー1(※),
  ジョブネット変数名2:抽出するキー2,
  …
}

(※)抽出するキーの指定方法の詳細は、“抽出するキーの指定方法”を参照してください。

ジョブの設定でジョブネット変数を利用する設定になっていない場合、本パラメタを指定していても、ジョブネット変数には設定されません。ジョブネット変数を利用する手順およびジョブネット変数で定義可能な文字列、制限値については“Systemwalker Operation Manager 運用ガイド”の“ジョブネット変数をジョブ間で利用する”を参照してください。

ジョブネット変数名はREST実行ジョブの出力結果で出力される他のキー名と重複しないようにしてください。重複した場合、パラメタエラーとなります。

型

object

デフォルト値

なし

(*)：必須のパラメタ

monitoringオブジェクトのパラメタ

requestオブジェクトで指定した接続URLのAPIの処理の完了を待ち合わせる場合に、monitoringオブジェクトで実行APIの処理結果取得用APIのパラメタを指定します。

本オブジェクトで指定した接続先URLに指定のポーリング間隔、ポーリング回数でHTTPリクエストを送信します。

指定した終了判定キーの値がレスポンス結果の値と一致するか、指定したポーリング回数分のリクエストを送信するとREST実行ジョブは終了します。

monitoringオブジェクトで処理の完了を待ち合わせる場合、正常終了判定キーで指定した値とレスポンス結果の値が一致したときにREST実行ジョブは正常終了となります。それ以外の場合、REST実行ジョブは異常終了となります。

送信されるすべてのリクエストに対してパラメタは共通です。

レスポンス結果は最後のリクエスト分のみ出力されます。

monitoringオブジェクトは省略可能です。省略した場合、APIの完了の待ち合わせは行いません。

パラメタ

キー名・型・デフォルト値

説明

接続URL (*)

キー名

url

接続先のURLを以下の形式で指定します。

  • httpsを使用する場合

    https://ホスト[:ポート番号]/リソースパス

  • httpを使用する場合

    http://ホスト[:ポート番号]/リソースパス

URLは2083バイト以内で指定します。URL内で利用可能な文字については接続先のクラウドサービスの規約に従ってください。

requestオブジェクトで“監視、強制終了リクエストに引継ぐキー”のパラメタで指定したキーの値を本URLに設定する場合、“<置き換え変数名>”の形式で記載することで、リクエスト時に置き換わります。

型

string

デフォルト値

なし

HTTPメソッド (*)

キー名

method

HTTPメソッドを設定します。

GET/PUT/POST/DELETEのいずれかを指定します。

型

string

デフォルト値

なし

クエリパラメータ

キー名

query

接続先URLにクエリパラメータを指定する場合、“パラメタ名:値”の形式で指定します。以下のようにパラメタ名と値はqueryオブジェクト内で複数指定可能です。

query: {
  パラメタ名1:値1,
  パラメタ名2:値2,
  …
}

クエリパラメータの値にjobschsetauthinfoコマンドで設定した任意のキーの値を設定したい場合は、以下のように値を“@任意のキー名@”の形式で指定することで、設定した値に置きかわります。

query: {
  パラメタ名:@任意のキー名@
}

パラメタ名および値は1024バイト以内で指定してください。

省略した場合、URLにクエリパラメータを追加しません。

型

object

デフォルト値

なし

HTTPリクエストヘッダ

キー名

header

追加のHTTPリクエストヘッダを指定する場合、“ヘッダ名:値”の形式で指定します。以下のようにヘッダ名と値はheaderオブジェクト内で複数指定可能です。

header: {
  ヘッダ名1:値1,
  ヘッダ名2:値2,
  …
}

リクエストヘッダの値にjobschsetauthinfoコマンドで設定した任意のキーの値を設定したい場合は、以下のように値を“@任意のキー名@”の形式で指定することで、設定した値に置きかわります。

header: {
  ヘッダ名:@任意のキー名@
}

ヘッダ名および値は1024バイト以内で指定してください。

省略した場合、リクエストヘッダを追加しません。

型

object

デフォルト値

なし

HTTPリクエストボディ

キー名

body

HTTPリクエストボディとして指定するファイルをフルパスで指定します。

ファイルパスの長さは256バイト以内で指定してください。ファイルパスには、半角英数字、“/”、“: ”、“\”、“. ”、“_”(半角アンダーバー)、“-”(半角ハイフン)のみ指定可能です。

requestオブジェクトで“監視、強制終了リクエストに引継ぐキー”のパラメタで指定したキーの値をリクエストボディに設定する場合、“<置き換え変数名>”の形式で記載することで、リクエスト時に置き換わります。

jobschsetauthinfoコマンドで設定した任意のキーの値をリクエストボディに設定する場合、“@任意のキー名@”の形式で指定することで、リクエスト時に設定した値に置き換わります。

省略した場合、リクエストボディは設定されません。

型

string

デフォルト値

なし

HTTPレスポンスヘッダ

キー名

resHeader

HTTPレスポンスのヘッダ情報を保存するファイルをフルパスで指定します。

ファイルパスの長さは256バイト以内で指定してください。ファイルパスには、半角英数字、“/”、“: ”、“\”、“. ”、“_”(半角アンダーバー)、“-”(半角ハイフン)のみ指定可能です。

指定ファイルが存在していた場合は上書きします。

本パラメタの指定を変更せず一意のファイル名で出力したい場合は、ファイル名に<date>の文字列を含めることで、出力時に<date>がYYYYMMDDhhmmssの日時情報に置換されて出力されます。この場合、置換後のファイルパス長が256バイトを超えないようにしてください。超えた場合、結果は出力されません。

監視の最後のHTTPリクエストに対するHTTPレスポンス結果のみ出力します。

省略した場合、ヘッダ情報のファイル出力は行いません。

型

string

デフォルト値

なし

HTTPレスポンスボディ

キー名

resBody

HTTPレスポンスのボディ情報を保存するファイルをフルパスで指定します。

ファイルパスの長さは256バイト以内で指定してください。ファイルパスには、半角英数字、“/”、“: ”、“\”、“. ”、“_”(半角アンダーバー)、“-”(半角ハイフン)のみ指定可能です。

指定ファイルが存在していた場合は上書きします。

本パラメタの指定を変更せず一意のファイル名で出力したい場合は、ファイル名に<date>の文字列を含めることで、出力時に<date>がYYYYMMDDhhmmssの日時情報に置換されて出力されます。この場合、置換後のファイルパス長が256バイトを超えないようにしてください。超えた場合、結果は出力されません。

監視の最後のHTTPリクエストに対するHTTPレスポンス結果のみ出力します。

省略した場合、ボディ情報のファイル出力は行いません。

型

string

デフォルト値

なし

監視のポーリング間隔

キー名

pollingInterval

リクエストのポーリング間隔を１～600秒で指定します。

省略した場合、デフォルトの60秒が設定されます。

型

number

デフォルト値

60

監視のポーリング回数

キー名

pollingCount

リクエストのポーリング回数を指定します。

0が指定された場合、無制限に待ち合わせます。

省略した場合、デフォルトの0が設定されます。

型

number

デフォルト値

0

初回の監視リクエスト実行までの間隔

キー名

firstMonitorInterval

requestオブジェクトで指定したリクエスト実行から初回の監視リクエストを実行するまでの間隔を1～600秒で指定します。

省略した場合、デフォルトの10秒が設定されます。

型

number

デフォルト値

10

監視の終了判定キー (*)

キー名

pollingEndKey

実行APIが完了したことを判定するためのレスポンス結果のキーを指定します。

キーの指定方法の詳細は、“抽出するキーの指定方法”を参照してください。

requestオブジェクトの“監視、強制終了リクエストに引継ぐキー”パラメタで指定したキーの値を監視の終了判定キーに設定する場合、“<置き換え変数名>”の形式で記載することで、リクエスト時に置き換わります。

型

string

デフォルト値

なし

監視の終了判定の値 (*)

キー名

pollingEndVal

実行APIが完了したことを判定するためのレスポンス結果のキーの値を指定します。

終了判定するための値をリスト形式で指定します。

["値1","値2","値3", …]

値は1024バイト以内で指定してください。

型

array

デフォルト値

なし

正常終了判定キー (*)

キー名

checkResultKey

実行APIが終了した後に、APIが正常終了したかどうかを判定するためのレスポンス結果のキーを指定します。

ジョブの待ち合わせが完了した時に正常終了判定キーで指定した値と合致しなければ、REST実行ジョブは異常終了となります。

キーの指定方法の詳細は、“抽出するキーの指定方法”を参照してください。

requestオブジェクトの“監視、強制終了リクエストに引継ぐキー”パラメタで指定したキーの値を監視の終了判定キーに設定する場合、“<置き換え変数名>”の形式で記載することで、リクエスト時に置き換わります。

型

string

デフォルト値

なし

正常終了判定の値

キー名

checkResultVal

実行APIが終了した後に、APIが正常終了したかどうかを判定するためのレスポンス結果のキーの値を指定します。

正常終了判定するための値をリスト形式で指定します。

["値1","値2","値3", …]

値は1024バイト以内で指定してください。

型

array

デフォルト値

なし

ジョブネット変数に設定するキー

キー名

jobnetValKeys

本HTTPレスポンスの結果をジョブネット変数に設定して後続ジョブと連携したい場合に、本パラメタでレスポンスのキーを指定することで、そのキーの値をジョブネット変数に設定できます。

本パラメタで指定したキーは“ジョブネット変数名=キー”の値の形式で標準出力に出力されます。

本パラメタはジョブネット変数名:抽出するキーの形式で指定します。以下のようにジョブネット変数名と抽出するキーはjobnetValKeysオブジェクト内で複数指定可能です。

jobnetValKeys: {
  ジョブネット変数名1:抽出するキー1(※),
  ジョブネット変数名2:抽出するキー2,
  …
}

(※)抽出するキーの指定方法の詳細は、“抽出するキーの指定方法”を参照してください。

ジョブの設定でジョブネット変数を利用する設定になっていない場合、本パラメタを指定していても、ジョブネット変数には設定されません。ジョブネット変数を利用する手順およびジョブネット変数で定義可能な文字列、制限値については“Systemwalker Operation Manager 運用ガイド”の“ジョブネット変数をジョブ間で利用する”を参照してください。

ジョブネット変数名はREST実行ジョブの出力結果で出力される他のキー名と重複しないようにしてください。重複した場合、パラメタエラーとなります。

型

object

デフォルト値

なし

(*)：必須のパラメタ

terminationオブジェクトのパラメタ

REST実行ジョブの強制終了時に、強制終了リクエストをrequestオブジェクトで指定した接続URLのAPIの処理に送りたい場合は、terminationオブジェクトで以下のパラメタを指定します。

terminationオブジェクトは省略可能です。省略した場合、APIの強制終了リクエストは送りません。

パラメタ

キー名・型・デフォルト値

説明

接続URL (*)

キー名

url

接続先のURLを以下の形式で指定します。

  • httpsを使用する場合

    https://ホスト[:ポート番号]/リソースパス

  • httpを使用する場合

    http://ホスト[:ポート番号]/リソースパス

URLは2083バイト以内で指定します。URL内で利用可能な文字については接続先のクラウドサービスの規約に従ってください。

requestオブジェクトで“監視、強制終了リクエストに引継ぐキー”のパラメタで指定したキーの値を本URLに設定する場合、“<置き換え変数名>”の形式で記載することで、リクエスト時に置き換わります。

型

string

デフォルト値

なし

HTTPメソッド (*)

キー名

method

HTTPメソッドを設定します。

GET/PUT/POST/DELETEのいずれかを指定します。

型

string

デフォルト値

なし

クエリパラメータ

キー名

query

接続先URLにクエリパラメータを指定する場合、“パラメタ名:値”の形式で指定します。以下のようにパラメタ名と値はqueryオブジェクト内で複数指定可能です。

query: {
  パラメタ名1:値1,
  パラメタ名2:値2,
  …
}

クエリパラメータの値にjobschsetauthinfoコマンドで設定した任意のキーの値を設定したい場合は、以下のように値を“@任意のキー名@”の形式で指定することで、設定した値に置きかわります。

query: {
  パラメタ名:@任意のキー名@
}

パラメタ名および値は1024バイト以内で指定してください。

省略した場合、URLにクエリパラメータを追加しません。

型

object

デフォルト値

なし

HTTPリクエストヘッダ

キー名

header

追加のHTTPリクエストヘッダを指定する場合、“ヘッダ名:値”の形式で指定します。以下のようにヘッダ名と値はheaderオブジェクト内で複数指定可能です。

header: {
  ヘッダ名1:値1,
  ヘッダ名2:値2,
  …
}

リクエストヘッダの値にjobschsetauthinfoコマンドで設定した任意のキーの値を設定したい場合は、以下のように値を“@任意のキー名@”の形式で指定することで、設定した値に置きかわります。

header: {
  ヘッダ名:@任意のキー名@
}

ヘッダ名および値は1024バイト以内で指定してください。

省略した場合、リクエストヘッダを追加しません。

型

object

デフォルト値

なし

HTTPリクエストボディ

キー名

body

HTTPリクエストボディとして指定するファイルをフルパスで指定します。

ファイルパスの長さは256バイト以内で指定してください。ファイルパスには、半角英数字、“/”、“: ”、“\”、“. ”、“_”(半角アンダーバー)、“-”(半角ハイフン)のみ指定可能です。

requestオブジェクトで“監視、強制終了リクエストに引継ぐキー”のパラメタで指定したキーの値をリクエストボディに設定する場合、“<置き換え変数名>”の形式で記載することで、リクエスト時に置き換わります。

jobschsetauthinfoコマンドで設定した任意のキーの値をリクエストボディに設定する場合、“@任意のキー名@”の形式で指定することで、リクエスト時に設定した値に置き換わります。

省略した場合、リクエストボディは設定されません。

型

string

デフォルト値

なし

HTTPレスポンスヘッダ

キー名

resHeader

HTTPレスポンスのヘッダ情報を保存するファイルをフルパスで指定します。

ファイルパスの長さは256バイト以内で指定してください。ファイルパスには、半角英数字、“/”、“: ”、“\”、“. ”、“_”(半角アンダーバー)、“-”(半角ハイフン)のみ指定可能です。

指定ファイルが存在していた場合は上書きします。

本パラメタの指定を変更せず一意のファイル名で出力したい場合は、ファイル名に<date>の文字列を含めることで、出力時に<date>がYYYYMMDDhhmmssの日時情報に置換されて出力されます。この場合、置換後のファイルパス長が256バイトを超えないようにしてください。超えた場合、結果は出力されません。

省略した場合、ヘッダ情報のファイル出力は行いません。

型

string

デフォルト値

なし

HTTPレスポンスボディ

キー名

resBody

HTTPレスポンスのボディ情報を保存するファイルをフルパスで指定します。

ファイルパスの長さは256バイト以内で指定してください。ファイルパスには、半角英数字、“/”、“: ”、“\”、“. ”、“_”(半角アンダーバー)、“-”(半角ハイフン)のみ指定可能です。

指定ファイルが存在していた場合は上書きします。

本パラメタの指定を変更せず一意のファイル名で出力したい場合は、ファイル名に<date>の文字列を含めることで、出力時に<date>がYYYYMMDDhhmmssの日時情報に置換されて出力されます。この場合、置換後のファイルパス長が256バイトを超えないようにしてください。超えた場合、結果は出力されません。

省略した場合、ボディ情報のファイル出力は行いません。

型

string

デフォルト値

なし

(*)：必須のパラメタ

抽出するキーの指定方法

takeoverKeys、jobnetValKeys、pollingEndKey、 checkResultKeyで、レスポンス結果から抽出するキーを指定する方法について以下に示します。

なお、抽出するキーは、1024バイト以内で指定してください。

レスポンス結果の例

{
    "id": "id001",
    "info": {
        "hoge": "fuga"
     },
    "properties": [
            {
                "name": "aaa",
                "rc": 2
            },
            {
                "name": "bbb",
                "rc": 0
            }
    ]
}

使用例

AWS Batchサービス(API Version 2016-08-10)のジョブを実行、監視、強制終了する場合
{
  "request": {
    "url": "https://batch.ap-northeast-1.amazonaws.com/v1/submitjob",
    "method": "POST",
    "authName": "Aws_Batch",
    "proxyAuthName": "Proxy1",
    "body": "/paramfiles/aws_batch_main_body.json",
    "resHeader": "/aws_batch_main_header_<date>.json",
    "resBody": "/response/aws_batch_main_body_<date>.txt",
    "takeoverKeys": {
      "JOBID": "jobId"
    },
  "timeout": 60
  },
  "monitoring": {
    "url": "https://batch.ap-northeast-1.amazonaws.com/v1/describejobs",
    "method": "POST",
    "body": "/paramfiles/aws_batch_moni_body.json",
    "resHeader": "/response/aws_batch_moni_header_<date>.json",
    "resBody": "/response/aws_batch_moni_body_<date>.txt",
    "pollingInterval": 60,
    "pollingCount": 5,
    "pollingEndKey": "jobs.[?\"jobId\"==\"<JOBID>\"].status",
    "pollingEndVal": ["SUCCEEDED", "FAILED"],
    "checkResultKey": "jobs.[?\"jobId\"==\"<JOBID>\"].status",
    "checkResultVal": ["SUCCEEDED"]
  },
  "termination": {
    "url": "https://batch.ap-northeast-1.amazonaws.com/v1/terminatejob",
    "method": "POST",
    "body": "/paramfiles/aws_batch_term_body.json",
    "resHeader": "/response/aws_batch_term_header_<date>.json",
    "resBody": "/response/aws_batch_term_body_<date>.txt"
  }
}

上記のrequestオブジェクトで指定するリクエストボディ(aws_batch_main_body.json)の例

{
  "jobName": "testjob1",
  "jobQueue": "testjob-queue",
  "jobDefinition": "testjob-def1"
}

上記のmonitoringオブジェクトで指定するリクエストボディ(aws_batch_moni_body.json)の例

{
  "jobs": [ "<JOBID>" ] 
}

上記のterminationオブジェクトで指定するリクエストボディ(aws_batch_term_body.json)の例

{
  "reason": "Terminating job.",
  "jobId": "<JOBID>"
}
AWS Lambda(API Version 2015-03-31)サービスの関数を実行する場合の例
{
  "request": {
    "url": "https://lambda.ap-northeast-1.amazonaws.com/2015-03-31/functions/関数名
/invocations",
    "method": "POST",
    "authName": "Aws_Lambda",
    "proxyAuthName": "Proxy1",
    "resHeader": "/response/aws_lambda_main_header_<date>.json",
    "resBody": "/response/aws_lambda_main_body_<date>.json",
  "timeout": 60
  }
}
※関数名：ユーザが指定する任意の関数名
Azure Batch(API Version 2020-09-01.12.0)サービスのジョブを実行、監視、強制終了する場合の例
{
  "request": {
    "url": "https://testbatch112233.japaneast.batch.azure.com/jobs/testJob/tasks",
    "method": "POST",
    "authName": "Azure-Batch",
    "proxyAuthName": "Proxy1",
    "query": {
      "api-version": "2020-09-01.12.0"
    },
    "header": {
      "Content-Type": "application/json;odata=minimalmetadata"
    },
    "body": "/paramfiles/azure_batch_main_body.json",
    "resHeader": "/response/azure_batch_main_header_<date>.json",
    "resBody": "/response/azure_batch_main_body_<date>.json",
    "timeout": 60
  },
  "monitoring": {
    "url":
"https://testbatch112233.japaneast.batch.azure.com/jobs/testJob/tasks/testTask",
    "method": "GET",
    "query": {
      "api-version": "2020-09-01.12.0"
    },
    "resHeader": "/response/azure_batch_moni_header_<date>.json",
    "resBody": "/response/azure_batch_moni_body_<date>.json",
    "pollingInterval": 60,
    "pollingCount": 5,
    "pollingEndKey": "state",
    "pollingEndVal": ["completed"],
    "checkResultKey": "executionInfo.result",
    "checkResultVal": ["success"]
  },
  "termination": {
    "url":
"https://testbatch112233.japaneast.batch.azure.com/jobs/testJob/tasks/testTask/terminate",
    "method": "POST",
    "query": {
      "api-version": "2020-09-01.12.0"
    },
    "resHeader": "/resoponse/azure_batch_term_header_<date>.json",
    "resBody": "/response/azure_batch_term_body_<date>.json"
  }
}

上記のrequestオブジェクトで指定するリクエストボディ(azure_batch_main_body.json)の例

{
  "id": "testTask",
  "commandLine": "cmd /c \"set AZ_BATCH & timeout /t 90 > NUL\""
}
Azure functionsサービス(ランタイムバージョン3)の関数を実行する場合の例
{
  "request": {
    "url": "https://testfunc123456.azurewebsites.net/api/HttpTrigger1",
    "method": "GET",
    "authName":  "Azure-Functions",
    "proxyAuthName": "Proxy1",
    "query": {
      "name": "Function"
    },
    "resHeader": "/response/azure_func_main_header_<date>.json",
    "resBody": "/response/azure_func_main_body_<date>.json",
    "timeout": 60
  }
}

注意事項

前次
Copyright 1995-2024 Fujitsu Limited