5.16.1　対処アクションの実行結果取得

機能

対処アクションの実行結果を取得します。

検索条件をパラメーターに設定した場合は，検索条件に一致した対処アクションの実行結果を取得します。

実行権限

次の権限が必要です。

filterにkey「execDetailEventSid」1件のみを指定する場合

JP1権限レベル：JP1_Console_Admin，JP1_Console_Operator，JP1_Console_User

その他の場合

JP1資源グループ：*
JP1権限レベル：JP1_Console_Admin，JP1_Console_Operator，JP1_Console_User

APIのバージョン

形式

リクエスト行

POST  /application/component/apiVersion/responseActions/results httpVersion

リクエストのメッセージボディー

{
  "type":"処理内容",
  "direction":"対処アクション実行結果取得方向",
  "searchType":検索種別,
  "count":対処アクション実行結果の取得件数,
  "since":"検索開始位置の対処アクションSID",
  "lastDirection":"前回の検索処理で指定した対処アクション実行結果の検索方向"
  "dbInfo":[
    {"beginData":"検索開始位置の対処アクションSID",
      "endData":"検索終了位置の対処アクションSID",
      "since":"前回の検索処理で指定した検索開始位置の対処アクションSID"
    }
  ]
  "filter":[    //対処アクション結果検索フィルタ
    {"key":"検索キー","ope":"比較キーワード","val":["オペランド1",…]},
    …
  ]
}

レスポンスのメッセージボディー

{
  "actionResult":[  //対処アクション結果
    {
      "actionSid":"対処アクションSID",
      "executionHost":"実行先ホスト名",
      "actionName":"アクション名",
      "executionCommand":"実行コマンド",
      "actionStatus":"アクション状態",
      "targetSid":"実行対象SID",
      "executionDeal":"実行契機",
      "executionDetailInfo":"実行契機詳細情報",
      "actionType":"アクション種別",
      "actionAcceptTime":"対処アクション受付時刻",
      "actionSendTime":"対処アクション投入時刻",
      "actionEndTime":"対処アクション終了時刻",
      "executionResult":["実行結果"],
      "returnValue":"戻り値",
      "message":["メッセージ"]
    },
    …
  ],
  "beginData":"対処アクション実行結果検索開始位置の対処アクション結果情報",
  "endData":"対処アクション実行結果の検索終了位置の対処アクション結果情報",
  "dbInfo":"分散DB用対処アクション実行結果の次回検索情報",
  "messageList":[
    {
      "messageId":"メッセージID",
      "message":"メッセージ"
    },
    …
  ]
}

パラメーター

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

メンバー名		データ型	省略可否	説明
`type`		string	不可	取得する対処アクションの実行結果を指定します。 list 対処アクションの結果一覧の情報を取得する detail 対処アクションの結果詳細の情報を取得する上記以外の値を指定した場合はエラーとなります。
`direction`		string	可	対処アクション実行結果の検索方向を指定します。 past 過去方向に検索する future 未来方向に検索する省略時は「past」を仮定します。上記以外の値を指定した場合はエラーとなります。
`searchType`		int	不可	検索種別を指定します。 0：対処アクションSID指定 sinceに対象のSID，countに1を指定します。 1：最新ページ 2：新しいページ 3：更新 4：古いページ 5：最古ページ上記以外を指定した場合はエラーとなります。
`count`		int	可	対処アクション実行結果の最大取得件数を1〜2000の範囲で指定します。省略時は100を仮定します。上記以外を指定した場合はエラーとなります。
`since`		string	可	対処アクション実行結果の検索開始位置を対処アクションSIDで指定します。 1,024バイト未満の文字列で指定し，それ以外は，エラーとなります。指定した対処アクションSIDより未来または過去の対処アクション実行結果を検索します（指定した対処アクションSIDの対処アクション実行結果は検索対象に含みません。ただし，countが1の場合は，指定した対処アクションSIDを検索対象とします）。省略時は，directionの指定に従い，対処アクション結果管理DBの先頭または末尾から検索を開始します。設定方法については，下記の「■取得対象に対するsinceとdirectionの設定方法について」を参照してください。
`lastDirection`		string	可	前回の検索処理で指定した対処アクション実行結果の検索方向を指定します。過去方向の場合は「past」，未来方向の場合は「future」を指定します。 searchTypeが2または4の場合は必須で指定します。上記以外を設定した場合はエラーとなります。
`dbInfo`		object[]	可	対処アクションの実行制御にある対処アクション結果管理DBの対処アクション結果の検索開始位置，終了位置を指定するオブジェクトです。初回，先頭（最新）からの検索の場合，省略できます。次回以降は，前回の「戻り値」で返却された「dbInfo」の内容をそのまま指定します。設定方法については，下記の「■取得対象に対するsinceとdirectionの設定方法について」を参照してください。
	`beginData`	string	可	対処アクション実行結果の検索開始位置の対処アクションSIDを指定します。 1,024バイト未満の文字列で指定し，それ以外は，エラーとなります。
	`endData`	string	可	対処アクション実行結果の検索終了位置の対処アクションSIDです。 1,024バイト未満の文字列で指定し，それ以外は，エラーとなります。
	`since`	string	可	前回の検索種別に1，2，4，5を指定したときの検索開始位置の対処アクションSIDです。 1,024バイト未満の文字列で設定し，それ以外はエラーとなります。
`filter`		object[]	可	対処アクションの実行結果取得のフィルターを指定するオブジェクトです。詳細については，下記の「■対処アクション結果検索フィルターについて」を参照してください。

■取得対象に対するsinceとdirectionの設定方法について

取得対象	searchType	since	direction	その他の設定
最新ページ（初回）	1	空文字（省略可）	past	なし
最古ページ	5	空文字（省略可）	future	なし
1つ新しいページに遷移する場合	2	前回検索時のレスポンスのactionResultデータから最も新しい（配列の並びで最後）actionSidを設定します。	future	dbInfo，lastDirectionは必須です。
1つ古いページに遷移する場合	4	前回検索時のレスポンスのactionResultデータから最も古い（配列の並びで最初）actionSidを設定します。	past	dbInfo，lastDirectionは必須です。
更新（再表示）	3	前回検索時のパラメーターのsinceと同じ値を設定します。	前回検索時のパラメーターのdirectionと同じ値を設定します。	dbInfoは必須です。 lastDirectionは省略可です。
対処アクションSID指定で詳細情報取得	0	取得したい対処アクションSIDを設定します。	past/future	countに1， typeにdetailを設定します。 lastDirectionは省略可です。

注　上記の設定内容が不正な場合は，正しい結果が取得できないことがあります。その場合は，最新ページ（初回）の取得から再度実行します。

■対処アクション結果検索フィルターについて

パラメーターの指定方法について以下に示します。

{
"key":"検索キー","ope":"比較キーワード","val":["オペランド1","オペランド2",…]
}

表5‒14　指定できる属性名と比較キーワードの組み合わせ
検索キー（設定する値）		データ型	比較キーワード	オペランド
対処アクションSID （actionSid）		string	完全一致（MATCH）正規表現（REGEX）	対処アクションSIDを指定します。 1〜4,096バイトの範囲で，最大100件まで指定できます。それ以外はエラーとなります。また，正規表現を指定した場合，複数指定できません。複数指定したときはエラーとなります。
実行先ホスト名（executionHost）		string	完全一致（MATCH）正規表現（REGEX）	対処アクションを実行するホスト名を指定します。 1〜4,096バイトの範囲で，最大100件まで指定できます。それ以外はエラーとなります。また，正規表現を指定した場合，複数指定できません。複数指定した場合はエラーとなります。
アクション状態（actionStatus）		string	完全一致（MATCH）	対処アクションの状態を指定します。複数指定できます。指定できる値を次に示します。 send（実行先送信中） queue（キューイング） running（実行中） ended（終了） unknown（状態不明） none（なし） fail（実行不可） senderror（通信失敗） error（実行失敗）上記以外の値を指定した場合はエラーとなります。
アクション名（actionName）		string	完全一致（MATCH）正規表現（REGEX）	対処アクションのアクション名を指定します。 1〜4,096バイトの範囲で，最大100件まで指定できます。それ以外はエラーとなります。制御文字（0x00〜0x1F，0x7F〜0x9F）以外の文字を指定できます。また，正規表現を指定した場合，複数指定できません。複数指定した場合はエラーとなります。
実行契機詳細情報		−	−	対処アクションの実行契機を指定します。自動対処アクションの場合は，JP1イベントのSID，手動対処アクションの場合は，手動実行要求を行ったJP1ユーザー名を指定します。
	JP1イベントのSID（execDetailEventSid）	string	完全一致（MATCH）	JP1イベントのSIDを指定します。 1〜4096バイトの範囲で，最大100件まで指定できます。それ以外はエラーとなります。
	JP1ユーザー名（execDetailUserName）	string	完全一致（MATCH）正規表現（REGEX）	JP1ユーザー名を指定します。 1〜4,096バイトの範囲で，最大100件まで指定できます。それ以外はエラーとします。また，正規表現を指定した場合，複数指定できません。複数指定した場合はエラーとなります。
対処アクション受付時刻（actionAcceptTime）		string	日時指定（TRANGE）	対処アクション実行制御が対処アクションの実行要求を受け付けた時刻を指定します。入力形式は，ISO 8601の拡張形式（YYYY-MM-DDThh:mm:ssTZD）とし，それ以外はエラーとなります。開始日時，終了日時の順に指定します。開始日時を入力しなかった場合は，終了日時より前の日時の情報をすべて取得します。終了日時を入力しなかった場合は，開始日時から後の日時の情報をすべて取得します。
戻り値（returnValue）		string	完全一致（MATCH）正規表現（REGEX）	実行結果の戻り値を指定します。 1〜4,096バイトの範囲で，最大100件まで指定できます。それ以外はエラーとなります。また，正規表現を指定した場合，複数指定できません。複数指定した場合はエラーとなります。

■正規表現ついて

対処アクション結果検索フィルターで使用する正規表現を次に示します。

Windowsの場合：拡張正規表現（XPG4準拠）
Linuxの場合：拡張正規表現（POSIX1003.2）

ステータスコード

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

ステータスコード	メッセージID	説明
200	−	−
200	KAJY63041-W	対処アクション実行結果取得先の対処アクション実行制御との通信ができないため，一部の実行結果が取得できません。
200	KAJY63042-W	対処アクション実行結果取得先の対処アクション実行制御からエラーが返却され，一部の実行結果が取得できません。
400	KAJY63302-E	REST APIのパラメーターの指定が不正です。＜要因＞省略できないパラメーターが省略されています設定できない値を設定しています文字数制限オーバーです指定できる件数の最大数をオーバーしています検索キーが重複しています
400	KAJY63303-E	リクエストメッセージボディーのJSONフォーマットが不正です。
403	KAJY01000-E	REST APIの実行権限がありません。
500	KAJY63040-E	システム構成情報から実行先が取得できません（システム構成上に実行要求先ホストの管理ノードがありません）。
500	KAJY63040-E	システム構成情報から実行先が取得できません（実行要求先ホストを管理している統合エージェント管理基盤が取得できませんでした）。
500	KAJY63039-E	システム構成情報にアクセスできません。
500	KAJY63333-E	REST API処理で想定外のエラーが発生しました。
500	KAJY00007-E	システムエラーが発生しました（ディスク不足，メモリー不足など）。

戻り値

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

レスポンスのメッセージボディーに，次の表に示す情報を返却します。

リクエストパラメーターのtypeに指定した値によって返却される情報が異なります。

メンバー名		データ型	typeの値		説明
メンバー名		データ型	list	detail	説明
`actionResult`		object[]	○	○	対処アクション結果のオブジェクトです。リクエストパラメーターのtypeで指定した値によって返却されるメンバーが異なります。
	`actionSid`	string	○	○	対処アクションSIDを返却します。
	`executionHost`	string	○	○	実行先ホストを返却します。アクション種別がcmdの場合実行先の統合エージェント制御基盤のホスト名アクション種別がcmd以外の場合対処アクション実行制御のホスト名
	`actionName`	string	○	○	アクション名を返却します。
	`executionCommand`	object	○	○	実行コマンドを返却します。返却するオブジェクトはアクション種別によって異なります。アクション種別がcmdの場合下記の「■アクション種別がcmdの場合」の表を参照してください。アクション種別がrestapiの場合下記の「■アクション種別がrestapiの場合」の表を参照してください。アクション種別がeventstatusの場合下記の「■アクション種別がeventstatusの場合」の表を参照してください。
	`actionStatus`	string	○	○	対処アクションの状態を返却します。
	`targetSid`	string	○	○	対処アクションを実行するシステム（統合エージェント制御基盤，またはJP1/IM - Manager）の構成情報のSIDを返却します。
	`executionDeal`	string	○	○	対処アクションが実行された契機を返却します。
	`executionDetailInfo`	string	○	○	対処アクションが実行された契機の詳細情報を返却します。自動対処アクション（JP1イベント契機）の場合 JP1イベントのSID 手動対処アクションの場合実行要求を行ったJP1ユーザー名
	`actionType`	string	○	○	実行される対処アクションの種別を返却します。返却する値を次に示します。 cmd restapi eventstatus
	`actionAcceptTime`	string	○	○	対処アクション実行制御が対処アクションの実行要求を受け付けた時刻を返却します。
	`actionSendTime`	string	○	○	対処アクション実行制御が対処アクションの実行要求を送信した時刻を返却します。
	`actionEndTime`	string	○	○	対処アクションの実行が完了した時刻を返却します。
	`executionResult`	string[]	×	○	実行結果を返却します。アクション種別がcmdの場合コマンドの標準出力，標準エラー出力アクション種別がrestapiの場合 REST APIのレスポンスボディーアクション種別がeventstatusの場合イベント対処状況変更メソッドのリターンオブジェクト
	`returnValue`	string	○	○	実行結果の戻り値を返却します。アクション種別がcmdの場合コマンドの戻り値アクション種別がrestapiの場合 REST APIのステータスコードアクション種別がeventstatusの場合イベント対処状況変更が成功した場合0，失敗した場合1
	`message`	string[]	×	○	対処アクション実行制御が出力したメッセージです。
`beginData`		string	○	○	対処アクション実行結果の検索開始位置の次の対処アクションSIDを返却します。検索開始位置の次の対処アクションSIDが存在しない場合は省略します。
`endData`		string	○	○	対処アクション実行結果の検索終了位置の次の対処アクションSIDを返却します。検索終了位置の次の対処アクションSIDが存在しない場合は省略します。
`dbInfo`		object[]	○	○	分散DBの対処アクション結果の検索開始位置，終了位置を返却するオブジェクトです。
	`beginData`	string	○	○	対処アクション実行結果の検索開始位置の対処アクションSIDを返却します。検索対象となる対処アクション実行結果が一つも存在しない場合は省略します。
	`endData`	string	○	○	対処アクション実行結果の検索終了位置の対処アクションSIDを返却します。検索対象となる対処アクション実行結果が一つも存在しない場合は省略します。
	`since`	string	○	○	前回検索種別に1，2，4，5を指定した時の検索開始位置の対処アクションSIDを返却します。
`messageList`		object[]	○	○	処理中に発生した続行可能なワーニングのメッセージがある場合にのみ返却します。
	`messsageId`	string	○	○	メッセージIDを返却します。
	`message`	string	○	○	メッセージを返却します。

（凡例）

○：該当するメンバーの情報が返却される

×：該当するメンバーの情報が返却されない

■アクション種別がcmdの場合

メンバー名	データ型	説明
`cmd`	string	コマンド名を返却します。
`envFile`	string	環境変数ファイル名とパスを返却します。

■アクション種別がrestapiの場合

メンバー名	データ型	説明
`method`	string	REST APIのメソッドを返却します。
`url`	string	REST APIのURLを返却します。
`headers`	object	REST APIのリクエストヘッダーを返却します。
`body`	string	REST APIのリクエストボディーを返却します。リクエストボディーが不要な場合は省略します。

■アクション種別がeventstatusの場合

メンバー名	データ型	説明
`dealt`	string	対処状況を返却します。
`eventSid`	string	JP1イベントのSIDを返却します。

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

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

ワーニングが発生していたときは，「extensions」（拡張情報）の項目に，ステータスコードが200の場合と同様のワーニング情報を付与したものが，リクエスト元に返却されます。

使用例

リクエスト：

検索条件をパラメーターとして設定して，対処アクション結果一覧の情報を取得する場合のAPIの使用例を次に示します。

POST http://hostname:20703/im/api/v1/responseActions/results HTTP/1.1
content-type: application/json
・・・（省略）・・・
{
  "type":"list",
  "direction":"past",
  "searchType":1,
  "count":100,
  "filter":[
    {"key":"actionStatus","ope":"MATCH","val":["running","ended"]},
    {"key":"executionHost","ope":"MATCH","val":["HOST185"]},
    {"key":"actionAcceptTime","ope":"TRANGE","val":["2023-10-25T12:00:00+09:00", "2023-10-30T12:00:00+09:00"]}
  ]
}

レスポンス：

HTTP/1.1 200
content-type: application/json
・・・（省略）・・・
{
  "actionResult": [
    {
      "actionSid":"_JP1IMACTID_20f916e2-10d7/_JP1IMMHOST_ HOST185//",
      "executionHost": "HOST185",
      "actionName": "act002",
      "actionType": "eventstatus",
      "executionCommand": {
        "dealt": 3,
        "eventSid":"_JP1IM_HOST185/_JP1IMSEQNO_8/_JP1IMEVBSEQNO_401"
      },
      "actionStatus": "ended",
      "targetSid": "_JP1IM_HOST185/_HOST_HOST185",
      "executionDeal": "manual",
      "executionDetailInfo": "jp1admin",
      "actionAcceptTime": "2023-10-27T15:26:50+09:00",
      "actionSendTime": "2023-10-27T15:26:50+09:00",
      "actionEndTime": "2023-10-27T15:26:50+09:00",
      "returnValue": "0",
      "executionResult": null,
      "message": null
    },
    ・・・（省略）・・・
  ],
  "beginData":"",
  "endData":"_JP1IMACTID_25e566fa-c54a/_JP1IMMHOST_ HOST185//",
  "dbInfo":[
    {"beginData":"_JP1IMACTID_d9947fe1-23a5/_JP1IMMHOST_ HOST185//",
     "endData":"_JP1IMACTID_20f916e2-10d7/_JP1IMMHOST_ HOST185//",
     "since":"",
    },
    ・・・（省略）・・・
  ]
}

ページの先頭へ

検索キー（設定する値）		データ型	比較キーワード	オペランド
対処アクションSID （actionSid）		string	完全一致（MATCH）正規表現（REGEX）	対処アクションSIDを指定します。 1〜4,096バイトの範囲で，最大100件まで指定できます。それ以外はエラーとなります。また，正規表現を指定した場合，複数指定できません。複数指定したときはエラーとなります。
実行先ホスト名（executionHost）		string	完全一致（MATCH）正規表現（REGEX）	対処アクションを実行するホスト名を指定します。 1〜4,096バイトの範囲で，最大100件まで指定できます。それ以外はエラーとなります。また，正規表現を指定した場合，複数指定できません。複数指定した場合はエラーとなります。
アクション状態（actionStatus）		string	完全一致（MATCH）	対処アクションの状態を指定します。複数指定できます。指定できる値を次に示します。 send（実行先送信中） queue（キューイング） running（実行中） ended（終了） unknown（状態不明） none（なし） fail（実行不可） senderror（通信失敗） error（実行失敗）上記以外の値を指定した場合はエラーとなります。
アクション名（actionName）		string	完全一致（MATCH）正規表現（REGEX）	対処アクションのアクション名を指定します。 1〜4,096バイトの範囲で，最大100件まで指定できます。それ以外はエラーとなります。制御文字（0x00〜0x1F，0x7F〜0x9F）以外の文字を指定できます。また，正規表現を指定した場合，複数指定できません。複数指定した場合はエラーとなります。
実行契機詳細情報		−	−	対処アクションの実行契機を指定します。自動対処アクションの場合は，JP1イベントのSID，手動対処アクションの場合は，手動実行要求を行ったJP1ユーザー名を指定します。
	JP1イベントのSID（execDetailEventSid）	string	完全一致（MATCH）	JP1イベントのSIDを指定します。 1〜4096バイトの範囲で，最大100件まで指定できます。それ以外はエラーとなります。
	JP1ユーザー名（execDetailUserName）	string	完全一致（MATCH）正規表現（REGEX）	JP1ユーザー名を指定します。 1〜4,096バイトの範囲で，最大100件まで指定できます。それ以外はエラーとします。また，正規表現を指定した場合，複数指定できません。複数指定した場合はエラーとなります。
対処アクション受付時刻（actionAcceptTime）		string	日時指定（TRANGE）	対処アクション実行制御が対処アクションの実行要求を受け付けた時刻を指定します。入力形式は，ISO 8601の拡張形式（YYYY-MM-DDThh:mm:ssTZD）とし，それ以外はエラーとなります。開始日時，終了日時の順に指定します。開始日時を入力しなかった場合は，終了日時より前の日時の情報をすべて取得します。終了日時を入力しなかった場合は，開始日時から後の日時の情報をすべて取得します。
戻り値（returnValue）		string	完全一致（MATCH）正規表現（REGEX）	実行結果の戻り値を指定します。 1〜4,096バイトの範囲で，最大100件まで指定できます。それ以外はエラーとなります。また，正規表現を指定した場合，複数指定できません。複数指定した場合はエラーとなります。

5.16.1 対処アクションの実行結果取得

5.16.1　対処アクションの実行結果取得