Hitachi

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

5.6.4　イベント発行

機能

指定したJP1イベントを発行し，イベントをマネージャーホストに登録します。登録したあと，発行したイベントのDB内通し番号を返却します。

実行権限

  • JP1_Console_Admin

  • JP1_Console_Operator

  • JP1_Console_User

APIのバージョン

v1

形式
リクエスト行
POST /application/component/apiVersion/events/send httpVersion
リクエストのメッセージボディー
{
    "eventId":イベントID,
    "message":メッセージ,
    "attrs":{拡張属性名:拡張属性値[, ...]}
}
レスポンスのメッセージボディー

発行したイベントのDB内通し番号

パラメーター
eventId

発行する基本部イベントIDです。

次に示す範囲で指定します。

  • 0〜1FFF

  • 7FFF8000〜7FFFFFFF

指定できる範囲以外の値を指定した場合，KAJY02047-Eを出力します。

このパラメーターの指定を省略した場合は，0が仮定されます。

message

JP1イベントの内容を表すメッセージテキストを，1,023バイト以下の文字列で指定します。1,024バイト以上の文字列を指定した場合，例外が発生し処理を終了します。

なお，登録されるメッセージの文字コードは，マネージャーが配置されているOS環境の文字コードに依存します。

attrs

拡張属性です。

同じ拡張属性名を複数指定した場合，最後に指定された拡張属性の値で上書きされます。

拡張属性名は，英数字またはアンダーライン（英字は大文字，先頭は英字）から成る32バイトまでの文字列で指定します。指定できる文字列以外の拡張属性名を指定した場合，KAJY02047-Eを出力します。また，拡張属性名には接頭辞「E.」を指定しないでください。「E.」を指定した場合，KAJY02047-Eを出力します。

すべての拡張属性値の合計の長さは，10,000バイトまで指定できます。

イベント登録機能で登録されるイベント属性一覧を次に示します。

表5‒13　イベント登録機能で登録されるイベント属性一覧

項番

分類

項目名

属性名

イベント属性値の説明

1

基本属性

イベントDB内通し番号

SEQNO

発行されるJP1イベントのイベントDB内通し番号

2

基本イベントID※1

ID

パラメーターで渡されるイベントID

3

登録要因

REASON

現サーバにイベントが登録された要因

  • 1：現イベントサーバで，自イベントサーバ宛の発行

  • 2：現サーバから他サーバ宛の発行（値取得不可）

  • 3：他サーバから現サーバ宛の発行

  • 4：他サーバから環境設定の指定により転送

4

発行元プロセスID

PROCESSID

発行元APIのプロセスID

5

登録時刻

TIME

発行元イベントサーバでの登録時刻

6

到着時刻

ARRIVEDTIME

自イベントサーバでの登録時刻

7

発行元ユーザーID

USERID

発行元プロセスのユーザーID（固定値：-1）

8

発行元グループID

GROUPID

発行元プロセスのグループID（固定値：-1）

9

発行元ユーザー名

USERNAME

発行元プロセスのユーザー名

Windowsの場合：SYSTEM，Linuxの場合：root

10

発行元グループ名

GROUPNAME

発行元プロセスのグループ名（固定値：空文字）

11

発行元イベントサーバ名

SOURCESERVER

発行元のイベントサーバ名

発行元サーバ名が設定されていない場合，自ホストを設定する。

12

発行元IPアドレス

SOURCEIPADDR

発行元イベントサーバに対応するIPアドレス

13

送信先IPアドレス

DESTIPADDR

発行元APIが他イベントサーバへの転送を明示して指定した場合に，他イベントサーバの名称が入る。

14

発行元イベントDB内通し番号

SOURCESEQNO

発行元ホストでのイベントDB内通し番号

15

コードセット

CODESET

OSに設定されている文字コードが格納されます。

16

メッセージ

MESSAGE

JP1 イベントの内容を表した文字列

17

イベント詳細情報

BASIC

イベント基本属性の詳細情報

18

AOM情報

AOM

イベントのAOM情報

19

拡張属性（共通情報）※2

重大度

SEVERITY

「重大度」を表す以下の文字列など

  • "Emergency"：緊急

  • "Alert"：警戒

  • "Critical"：致命的

  • "Error"：エラー

  • "Warning"：警告

  • "Notice"：通知

  • "Information"：情報

  • "Debug"：デバッグ

20

ユーザー名

USER_NAME

実行しているユーザー名

21

プロダクト名

PRODUCT_NAME

JP1 イベントを発行したプログラム名

次に示すプログラム名などがある。

  • "/HITACHI/JP1/AJS"

  • "/HITACHI/JP1/AOM"

  • "/HITACHI/JP1/IM"

  • "/HITACHI/JP1/NBQ"

  • "/HITACHI/JP1/NETMDM"

  • "/HITACHI/JP1/NPS"

  • "/HITACHI/JP1/NQSEXEC"

22

オブジェクトタイプ

OBJECT_TYPE

「オブジェクトタイプ」を表す以下の文字列など

  • "JOB"

  • "JOBNET"

  • "ACTION"

  • "ACTIONFLOW"

  • "PRINTJOB"

  • "PRINTQUEUE"

  • "PRINTER"

  • "BATCHQUEUE"

  • "PIPEQUEUE"

  • "JOBBOX"

  • "LOGFILE"

  • "LINK"

  • "SERVICE"

  • "PRODUCT"

  • "CONFIGRATION"

  • "SERVER"

23

オブジェクト名

OBJECT_NAME

ジョブ，ジョブネットなどのオブジェクトの名称。ジョブネットなど階層のあるオブジェクトの場合，最下層の要素。

24

登録名タイプ

ROOT_OBJECT_TYPE

オブジェクトの種別

25

登録名

ROOT_OBJECT_NAME

ユーザーの操作時に実行を指示する単位になる名称

26

オブジェクトID

OBJECT_ID

オブジェクトID

PRODUCT_NAMEとの組み合わせによりオブジェクトのインスタンスを統合システム内で一意に意識できる文字列

27

事象種別

OCCURRENCE

OBJECT_NAMEに対して発生した事象を表す以下の文字列など

  • "ACTIVE"アクティブ

  • "INACTIVE"非アクティブ

  • "START"開始

  • "END"終了

  • "NOTSTART"開始できなかった

  • "CANCEL"キャンセル

  • "LATESTART"開始予定時刻を過ぎた

  • "LATEEND"終了予定時刻を過ぎた

  • "SUBMIT"サブミットされた

  • "ENQUEU"キューに登録された

  • "DEQUEU"キューから取り除かれた

  • "PAUSE"一時停止(保留）

  • "RELEASE"一時停止（保留解除）

  • "RESTART"再実行の開始

  • "CREATE"作成された

  • "DELETE"削除された

  • "MODIFY"更新された

  • "RETRY"リトライ開始した

  • "STOP"停止中

  • "MOVE"移動した

  • "COPY"コピーした

  • "NOTICE"通知した

  • "REPLY"応答された

  • "CONNECT"接続した

  • "DISCONNECT"切り離した

  • "EXCEPTION"その他のエラー

28

開始時刻

START_TIME

実行開始または再実行開始の時刻

29

終了時刻

END_TIME

実行終了または再実行終了の時刻

30

終了コード

RESULT_CODE

終了コード

31

発生元ホスト名

JP1_SOURCEHOST

発生元ホスト名を指定しない場合SOURCESERVERが設定される

32

個別拡張属性数

個別拡張属性の数

拡張属性の数
注※1

データベースに出力される形式を次に示します。

（指定例）ID:IDEXT 0000000A:00000000

注※2

共通属性は配列に格納されています。指定しない場合は登録されません。

このREST APIで登録されるイベントの属性の値を，次に示します。

--このパラメーターで実行した場合

{
   "eventId":"10000",
   "message":"クラウドサービスで障害が発生しました",
   "attrs":{"SEVERITY":"Error"}
}
SQ 18840099
ID 00010000:00000000
KN 0
HD 0
PI 0
RT 1559790829
AT 1559790829
RR 1
UI -1
GI -1
HQ 18840099
UN jp1admin
GN 
SN HOSTA
SI %0Aﾜﾄ(
CS MS932
MS クラウドサービスで障害が発生しました
UP %00%00%00%00%00%00%00%00
XN 1
XV SEVERITY= Error
ステータスコード

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

ステータスコード

メッセージ

説明

200

なし

JP1イベントを発行しました。

400

KAJY02047-E

リクエストのパラメーター指定形式が不正です。

403

KAJY01000-E

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

500

KAJY02048-E

JP1イベントが発行できませんでした

メッセージの詳細については，マニュアル「JP1/Integrated Management 3 - Manager メッセージ」を参照してください。

戻り値

ステータスコードが200の場合に，レスポンスボディーに次の情報を返却します。

データ型

説明

数値

発行したイベントのDB内通し番号
使用例

イベントAPIの使用例を次に示します。

リクエスト：
POST http://hostname:20703/im/api/v1/events/send
{
  "eventId":"1FFF",
  "message":"サービスAで障害が発生しました",
  "attrs":{"SEVERITY":"Error","JP1_SOURCEHOST":"HOSTA"}
}
レスポンス：
18839936

ページの先頭へ

Copyright (C) 2023, 2024 Hitachi, Ltd.

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