Hitachi

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

5.16.2　対処アクションの手動実行

機能

対処アクションの手動実行の操作を行います。

次に示すアクション種別のコマンドを実行できます。

  • コマンドの実行

  • REST APIの実行

  • 対処状況の更新

実行権限

  • JP1_Console_Admin

  • JP1_Console_Operator

APIのバージョン

v1

形式
リクエスト行
POST /application/component/apiVersion/responseActions/manualExec httpVersion
リクエストのメッセージボディー
{
    "actionType":"アクション種別",
    "actionName":"対処アクションの名称",
    "params":{"対処アクションのパラメーター"}
}

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

  • アクション種別が「リモートコマンド（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,・・・"
    }
レスポンスのメッセージボディー
{
  "actionSid":"対処アクションSID",
  "warning":[
    {
      "messageId":"ワーニング発生時のメッセージID",
      "message":"ワーニング発生時のメッセージ"
    },
　：
  ]
}
パラメーター

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

メンバー名

データ型

省略

説明

actionType

string

不可

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

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

  • cmd

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

  • restapi

    REST APIを実行する

  • eventstatus

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

actionName

string

可

対処アクション名称を指定します。

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

  • 1〜50バイト

  • 制御文字「アスキーコードで0x00〜0x1F，0x7F〜0x9F」を除くすべての文字

params

object

不可

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

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

  • cmdの場合

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

  • restapiの場合

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

  • eventstatusの場合

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

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

    メンバー名

    データ型

    省略可否

    説明

    host

    string

    不可

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

    cmd

    string

    不可

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

    envFile

    string

    可

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

  • REST API（restapi）の場合

    メンバー名

    データ型

    省略可否

    説明

    method

    string

    不可

    実行するREST APIのメソッドを指定します。下記のメソッドを指定できます。それ以外はエラーになります。

    • GET

    • HEAD

    • POST

    • PUT

    • PATCH

    • DELETE

    • OPTIONS

    • TRACE

    url

    string

    不可

    実行するREST APIのURLを指定します。指定できる値は次のとおりです。それ以外はエラーになります。

    • 2,046バイト以下で指定してください。

    • 使用できる文字は，RFC2396に準拠した半角英数字と次の記号です。

      「;」，「/」，「?」，「:」，「@」，「&」，「=」，「+」，「$」，「,」，「-」，「_」，「.」，「!」，「~」，「*」，「'」，「(」，「)」，「%」

    • 先頭には「http://」または「https://」を指定してください。

    headers

    object

    不可

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

    body

    string

    可

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

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

    メンバー名

    データ型

    省略可否

    説明

    dealt

    string

    不可

    対処状況の値を指定します。下記の値を指定できます。それ以外はエラーになります。

    • 0：未対処

    • 1：対処済

    • 2：処理中

    • 3：保留

    eventSid

    string

    不可

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

    件数は2,000件まで指定できます。それ以上はエラーになります。

    バイト数は1MB未満で指定してください。それ以上はエラーになります。
ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを，次の表に示します。

ステータスコード

メッセージ

説明

200

−

−

400

KAJY64004-E

対処アクションの実行要求の内容が不正です。

＜要因＞

  • 設定できない値を設定しています

  • 文字数制限オーバーです

  • 省略できないパラメーターが省略されています

400

KAJY63321-E

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

403

KAJY01000-E

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

500

KAJY63333-E

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

500

KAJY64003-E

送信先の対処アクション実行制御からエラーが返却されました。

＜要因＞

対処アクションの実行に失敗した

500

KAJY64001-E

システム構成情報から実行先が取得できません（システム構成上に実行要求先ホストの管理ノードがありません）。

システム構成情報から実行先が取得できません（実行要求先ホストを管理している統合エージェント管理基盤が取得できませんでした）。

500

KAJY64000-E

システム構成情報にアクセスできません。

500

KAJY64002-E

送信先の対処アクション実行制御との通信ができない。

＜要因＞

  • 対処アクション実行制御との通信に失敗した

500

KAJY00007-E

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

■ワーニングについて

実行不可アクションデータテーブルから情報の取得に失敗した場合，次のメッセージIDを出力します。出力先は，正常時はレスポンスのwarningオブジェクト，エラー時は拡張情報（extensions）のwarningオブジェクトです。

メッセージID

説明

KAJY63309-W

対処アクション結果管理DBとの通信ができない。

＜要因＞

  • DBへの接続に失敗した

KAJY63310-W

対処アクション結果管理DBで書き込みエラーが発生した。

＜要因＞

  • DBの読み込みの操作に失敗した
戻り値

  • ステータスコードが200の場合

    対処アクションの実行要求APIから返却されたレスポンスにワーニング情報が付与されていた場合，次の表に示すワーニング情報をこのREST APIのレスポンスに付与してリクエスト元に返却します。

    返却する情報については，上記の「■ワーニングについて」を参照してください。

    メンバー名

    データ型

    説明

    actionSid

    string

    対処アクション結果管理DB内で一意の対処アクションSIDを返却します。

    warning

    object[]

    ワーニングメッセージのオブジェクトです。

    messageId

    string

    発生したワーニングのメッセージIDを返却します。

    message

    string

    発生したワーニングのメッセージを返却します。

  • ステータスコードが200以外の場合

    レスポンスのメッセージボディーに，「5.2.6 エラー発生時のレスポンスメッセージ」に記載されているレスポンス形式の例外オブジェクトが返却されます。ただし，「returnCode」の項目は省略されます。

    対処アクションの実行要求APIから返却されたレスポンスにワーニング情報が付与されていた場合は，次の表に示すワーニング情報をエラー時のレスポンスのメッセージボディの「extensions」（拡張情報）の項目に付与して，リクエスト元に返却されます。

    メンバー名

    データ型

    説明

    extensions

    object[]

    拡張情報のオブジェクトです。発生したワーニング情報を設定します。

    messageId

    string

    発生したワーニングのメッセージIDを返却します。

    message

    string

    発生したワーニングのメッセージを返却します。
使用例
リクエスト：

  • コマンドを実行をする場合のAPIの使用例を，次に示します。

POST http://hostname:20703/im/api/v1/responseActions/manualExec HTTP/1.1
content-type: application/json
・・・省略・・・
{
  "actionType":"cmd",
  "actionName":"act001",
  "params":{
    "host":"HOST185",
    "cmd":"dir"
  }
}

  • JP1イベントの情報を使用してREST APIを実行をする場合のAPIの使用例を，次に示します。

POST http://hostname:20703/im/api/v1/responseActions/manualExec HTTP/1.1
content-type: application/json
・・・省略・・・
{
  "actionType":"restapi",
  "actionName":"act001",
  "params":{
    "method":"GET",
    "url":"http://hostname:20703/im/api/version",
    "headers":"{}"
  }
}

  • イベントの対処状況を「対処済」に変更する場合のAPIの使用例を，次に示します。

POST http://hostname:20703/im/api/v1/responseActions/manualExec HTTP/1.1
content-type: application/json
・・・省略・・・
{
  "actionType":"eventstatus",
  "actionName":"act001",
  "params": {
    "dealt":1,
    "eventSid":"_JP1IM_HOST185/_JP1IMSEQNO_8/_JP1IMEVBSEQNO_401"
  }
}
レスポンス：
HTTP/1.1 200 OK
content-type: application/json
・・・省略・・・ 
{
  "actionSid": "_JP1IMACTID_cb82bd6d-6409/_JP1IMMHOST_HOST185//"
}

ページの先頭へ

Copyright (C) 2023, 2024 Hitachi, Ltd.

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