Hitachi

JP1 Version 13　JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス

5.16.3　イベント引き継ぎ情報変換

機能

イベント引き継ぎ情報を変換します。

実行権限

  • JP1_Console_Admin

  • JP1_Console_Operator

APIのバージョン

v1

形式
リクエスト行
POST /application/component/apiVersion/responseActions/eventsReplace httpVersion
リクエストのメッセージボディー
{
  "eventSid":"JP1イベントのSID",
  "actionType":"アクション種別",
  "params":{"対処アクションのパラメーター"}
}
レスポンスのメッセージボディー
{
"params":{"対処アクションのパラメーター"},
"results":{"対処アクションのパラメーターの変換結果"}
}

■対処アクションのパラメーター

  • アクション種別が「リモートコマンド（cmd）」の場合

    "params":{
        "host":"実行ホスト名",
        "cmd":"実行コマンド",
        "envFile":"環境変数ファイル"
    }

  • アクション種別が「REST API（restapi）」の場合

    "params":{
        "method":"REST APIのメソッド",
        "url":"REST APIのURL",
        "headers":"REST APIのリクエストヘッダー",
        "body":"REST APIのリクエストのボディー"
    }

  • アクション種別が「イベントの対処状況の更新（eventstatus）」の場合

    "params":{
        "dealt":対処状況,
        "eventSid":"JP1イベントのSID,..."
    }

  • アクション種別が「指定したURLのページを表示・ジャンプ（jump）」の場合

    "params":{
        "url":"ジャンプ先のURL",
        "target":"HTMLのターゲット属性"
    }
パラメーター

メッセージボディーに指定するパラメーターを次に示します。

メンバー名

データ型

省略可否

説明

eventSid

string

不可

詳細情報を取得したいJP1イベントのSIDを指定します。JP1イベントSIDの詳細については，「7.2.1(1)　イベント情報オブジェクト」を参照してください。1〜512バイトの範囲で指定してください。それ以外はエラーになります。

actionType

string

不可

対処アクションの種別を指定します。

次のどれかの値を指定できます。それ以外の値を指定した場合はエラーになります。

  • cmd

    リモートコマンドを実行する

  • restapi

    REST APIを実行する

  • eventstatus

    イベントの対処状況の更新を実行する

  • jump

    指定したURLのページを表示・ジャンプする

params

object

不可

対処アクション内容を指定します。

対処アクションの種別に応じて，指定するパラメーターが異なります。

  • cmdの場合

    下記の「リモートコマンド（cmd）の場合」の表を参照してください。

  • restapiの場合

    下記の「REST API（restapi）の場合」の表を参照してください。

  • eventstatusの場合

    下記の「イベントの対処状況の更新（eventstatus）の場合」の表を参照してください。

  • jumpの場合

    下記の表「指定したURLのページを表示・ジャンプ（jump）の場合」を参照してください。

  • リモートコマンド（cmd）の場合

    メンバー名

    データ型

    省略可否

    説明

    host

    string

    不可

    実行先ホスト名を指定します。1〜255バイトの範囲で指定してください。それ以外はエラーになります。

    cmd

    string

    不可

    実行するOSコマンドと引数を指定します。1〜4,096バイトの範囲で指定してください。それ以外はエラーになります。

    envFile

    string

    可

    コマンド実行時に読み込む環境変数を記載した，実行先ホストにあるファイルのファイルパスを絶対パスで指定します。1〜255バイトの範囲で指定してください。それ以外はエラーになります。

  • REST API（restapi）の場合

    メンバー名

    データ型

    省略可否

    説明

    method

    string

    不可

    実行するREST APIのメソッドを指定します。7バイト以下で指定してください。それ以外はエラーになります。

    url

    string

    不可

    実行するREST APIのURLを指定します。1〜2,046バイトの範囲で指定してください。それ以外はエラーになります。

    headers

    object

    不可

    実行するREST APIのヘッダーを指定します。1〜65,536バイトの範囲で指定してください。それ以外はエラーになります。

    body

    string

    可

    実行するREST APIのボディーを指定します。ボディーが不要な場合は省略します。指定する場合は，1〜10MB未満の範囲で指定してください。それ以外はエラーになります。

  • イベントの対処状況の更新（eventstatus）の場合

    メンバー名

    データ型

    省略可否

    説明

    dealt

    int

    不可

    対処状況の値を指定します。0〜3の範囲で指定してください。それ以外はエラーになります。

    eventSid

    string

    不可

    JP1イベントのSIDを指定します。複数のイベントSIDを指定する場合はイベントSIDを「,」で連結し，2,000件まで指定できます。

    1〜1MB未満の範囲で指定してください。それ以外はエラーになります。

  • 指定したURLのページの表示・ジャンプ（jump）の場合

    メンバー名

    データ型

    省略可否

    説明

    url

    string

    不可

    ジャンプ先のURLを指定します。1〜2,046バイトの範囲で指定してください。それ以外はエラーになります。

    target

    string

    可

    ターゲット属性を指定します。1〜64バイトの範囲で指定してください。それ以外はエラーになります。
ステータスコード

レスポンスで返却するステータスコードを次に示します。メッセージの詳細については，マニュアル「JP1/Integrated Management 3 - Manager メッセージ」を参照してください。

ステータスコード

メッセージ

説明

200

−

−

403

KAJY01000-E

REST APIの実行権限がありません。

400

KAJY63328-E

REST APIのパラメーターの指定が不正です。省略できないパラメーターが省略されていることが要因です。

400

KAJY63329-E

リクエストメッセージボディーのJSONフォーマットが不正です。

400

KAJY63330-E

イベント引き継ぎ情報変換処理を行った結果，指定可能なバイト数の上限を超えました。

500

KAJY63332-E

イベント詳細情報取得APIからのレスポンスでエラーが返却されました。

500

KAJY63333-E

REST API処理で想定外のエラーが発生しました。

500

KAJY00007-E

システムエラーが発生しました（ディスク不足，メモリー不足など）。
戻り値

レスポンスで返却するパラメーターを次に示します。

メンバー名

データ型

説明

params

object

イベント引き継ぎ情報変換処理後のパラメーターを返却します。パラメーターの「params」と同じ形式で返却します。パラメーターの詳細については，パラメーターの表の「params」を参照してください。

results

object

上記の「params」のパラメーターに対応する，イベント引き継ぎ情報変換結果を返却します。省略されたパラメーターについては返却しません。このパラメーターが返却する値は次の通りです。

  • 0

    正常終了です。

  • 1

    変数の変換によって，上限値を超過しました。

  • 2

    変数に該当する属性が存在しません。

  • 3

    変数に該当する属性の属性値が空文字です。

  • 4

    変数に対するエンコーディング指定形式が不正です。

エラー時のレスポンスは，「5.2.6　エラー発生時のレスポンスメッセージ」に記載されているフォーマットですが，「returnCode」は省略されます。拡張情報「extensions」は，レスポンスと同一のパラメーターを付与します。ただし，イベント引き継ぎ情報変換処理前にエラー処理が発生した場合は省略します。

■拡張情報（extensions）のパラメーター
{
  "timestamp":1539923958358,
  "status":400,
  ・・・途中省略・・・
  "extensions":{
    "params":{"対処アクションのパラメーター"},
    "results":{"対処アクションのパラメーターの変換結果"}
  }
}
使用例

コマンドを実行する場合の例を次に示します。

リクエスト：
POST http://hostname:20703/im/api/v1/responseActions/eventsReplace HTTP/1.1
content-type: application/json
・・・省略・・・
{
  "eventSid":"_JP1IM_HOST185/_JP1IMSEQNO_8/_JP1IMEVBSEQNO_401",
  "actionType":"cmd",
  "params":{
    "host":"${event:EVHOST:}",
    "cmd":"dir",
    "envFile":"C:\\tmp\\envFile.txt"
  }
}
レスポンス：
HTTP/1.1 200 OK
content-type: application/json
・・・省略・・・ 
{
  "params": {
    "host": "HOST185",
    "cmd": "dir",
    "envFile": "C:\\tmp\\envFile.txt"
  },
  "results": {
  "host": 0,
  "cmd": 0,
  "envFile": 0
  }
}

ページの先頭へ

Copyright (C) 2023, 2024 Hitachi, Ltd.

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