5.11.4　トレンドデータ削除

機能

指定したホストのPrometheusおよびFluentd（ユーザー独自のPrometheusおよびユーザー独自のFluentdを含む）がトレンドデータ管理DBに保存したトレンドデータを削除します。トレンドデータを削除したあと，トレンドデータ管理サービスを自動で再起動します。

ログインしたJP1ユーザーに参照・操作権限がないホストは削除できません。なお，トレンドデータの削除対象に指定した統合エージェント，ユーザー独自のPrometheus，ユーザー独自のFluentdのホストのIM管理ノードに対して，参照・操作権限がある場合に，そのホストのPrometheusとFluentdが保存したトレンドデータをすべて削除します。

削除したあと，JP1/IM - Manager（インテリジェント統合管理基盤）のツリー情報には削除した情報は反映されません。反映する場合は、統合オペレーション・ビューアーからのツリー情報の生成および反映，またはjddcreatetreeコマンドおよびjddupdatetreeコマンド（構成変更モード（-cオプション）を指定）を実行してください。

実行権限

JP1_Console_Admin

APIのバージョン

形式

リクエスト行

POST /im/api/v1/trendData/delete HTTP/1.1

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

{
  "deletelist": [
    {
    "managerhost": マネージャーホスト名,
    "deleteinfolist": [
      {
        "agenthost": 統合エージェント、ユーザー独自のPrometheus、ユーザー独自のFluentdのホスト名
      }, ・・・
    }, ・・・
  ]
}

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

ステータスコードが200で，正常終了の場合，レスポンスはありません。

ステータスコードが200で，警告終了の場合，次のレスポンスを返却します。

{
    "errdeletelist":[
        {
            "managerhost": マネージャーホスト名,
            "deleteinfolist": [
                {
                    "agenthost": 統合エージェント、ユーザー独自のPrometheus、ユーザー独自のFluentdのホスト名
                },・・・
            ]
        },・・・
    ],
    "errrestartlist":[
        {
            "managerhost": マネージャーホスト名,
            "deleteinfolist": [
                {
                    "agenthost": 統合エージェント、ユーザー独自のPrometheus、ユーザー独自のFluentdのホスト名
                },・・・
            ]
        },・・・
    ],
    "messageList":[
        {
            "messageId": メッセージID,
            "message": メッセージ
        },・・・
    ]
}

パラメーター

リクエストのメッセージボディーに指定するパラメーターを次に示します。

項番	パラメーター			データ型	省略可否	説明
1	deletelist			object[]	不可	削除対象の情報を指定します。削除対象は200個^※まで指定できます。空配列は指定できません。注※ deletelist内の全deleteinfoの要素を合計200個まで指定できます。
2		managerhost		string	不可	削除するトレンドデータを保存しているトレンドデータ管理DBが管理されているマネージャーホスト名^※を1〜255バイトで指定します。指定できる文字は，制御文字以外の文字です。大文字・小文字を区別します。注※ 項番4で指定するホストの接続先マネージャーホスト名を指定します。
3		deleteinfolist		object[]	不可	マネージャーホストごとの削除対象の情報を指定します。削除対象は200個^※まで指定できます。空配列は指定できません。注※ deletelist内の全deleteinfoの要素を合計200個まで指定できます。
4			agenthost	string	不可	統合エージェント，ユーザー独自のPrometheus，ユーザー独自のFluentdのホスト名を1〜255バイトで指定します。指定できる文字は，制御文字以外の文字です。このパラメーターで指定したPrometheusおよびFluentd（ユーザー独自のPrometheusおよびユーザー独自のFluentdを含む）が保存したトレンドデータ管理DBのトレンドデータを削除します。大文字・小文字を区別します。

レスポンス

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

リクエストに指定したマネージャーが統合マネージャーおよび下位マネージャーに関わらず，APIの処理がすべて成功したときは，レスポンスのメッセージボディーなしとなります。

リクエストに指定した下位マネージャーの処理でエラーもしくは警告が発生したとき，または統合マネージャーの処理で警告が発生したときは，レスポンスのメッセージボディーに，次の表に示す情報を返却します。

項番	パラメーター			データ型	省略可否	説明
1	errdeletelist			object[]	可	トレンドデータを削除できなかった削除対象の配列が設定されます。失敗した削除対象がない場合は省略されます。
2		managerhost		string	不可	トレンドデータを削除できなかったマネージャーホスト名^※が設定されます。注※ 項番4で設定されるホストの接続先マネージャーホスト名が設定されます。
3		deleteinfolist		string	不可	トレンドデータを削除できなかったマネージャーホストごとの削除対象の情報の配列が設定されます。失敗した削除対象がない場合は省略されます。
4			agenthost	string	不可	トレンドデータを削除できなかった統合エージェント，ユーザー独自のPrometheus，ユーザー独自のFluentdのホスト名が設定されます。
5	errrestartlist			object[]	可	トレンドデータの削除に成功して，トレンドデータ管理サービスの再起動に失敗した削除対象の情報の配列が設定されます。失敗した削除対象がない場合は省略されます。
6		managerhost		string	不可	トレンドデータの削除に成功して，トレンドデータ管理サービスの再起動に失敗したマネージャーホスト名^※が設定されます。注※ 項番8で設定されるホストの接続先マネージャーホスト名が設定されます。
7		deleteinfolist		string	不可	トレンドデータの削除に成功して，トレンドデータ管理サービスの再起動に失敗したマネージャーホストごとの削除対象の情報の配列が設定されます。失敗した削除対象がない場合は省略されます。
8			agenthost	string	不可	トレンドデータの削除に成功して，トレンドデータ管理サービスの再起動に失敗した統合エージェント，ユーザー独自のPrometheus，ユーザー独自のFluentdのホスト名が設定されます。
9	messageList			object[]	可	メッセージオブジェクトの配列が設定されます。メッセージが存在しない場合は省略されます。
10		messageId		string	不可	メッセージIDが設定されます。
11		message		string	不可	メッセージの本文が設定されます。使用される言語は，HTTPリクエストヘッダーのAccept-Languageプロパティの指定内容によって決まります。

ステータスコードが200以外のエラーが発生した場合

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

ステータスコード

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

ステータスコード	出力されるメッセージ	説明
200	なし	APIの処理が成功しました。
	KAJY62011-W	ログインユーザーにリクエストに指定した統合エージェント，ユーザー独自のPrometheus，ユーザー独自のFluentdのホストの参照・操作権限がない。リクエストに指定したマネージャーホストが下位マネージャーで，［下位マネージャー一覧］画面で下位マネージャーに追加していない。
	KAJY62012-W	リクエストに指定したマネージャーホストにあるトレンドデータ管理DBのトレンドデータの削除に失敗しました。
	KAJY62013-W	リクエストに指定したマネージャーホストのトレンドデータ管理サービスの再起動に失敗しました。
	KAJY62014-W	リクエストに指定したマネージャーホストの統合エージェント管理DBに接続できません。
	KAJY62015-W	トレンドデータ削除または統合エージェント情報削除を連続で実行したため，トレンドデータ削除の処理が同一ホストのトレンドデータ管理DBに対して連続で実行されました。
400	KAJY62010-E	APIのリクエストが不正です。リクエスト不正が一個所見つかった時点で処理を中断します。
403	KAJY01000-E	認証に使用したユーザーの権限が不足しています。
500	KAJY00007-E	システムエラーが発生しました（ディスク不足，メモリー不足など）。

戻り値

なし

注意事項

マニュアル「JP1/Integrated Management 3 - Manager 導入設計ガイド」の「2.7.2(3)(g) トレンドデータの手動削除（統合エージェント，ユーザー独自のPrometheus，ユーザー独自のFluentdのホスト名を指定して削除）」の「■トレンドデータの削除時の注意事項」を参照してください。

使用例

リクエスト：

POST http://immhost01:20703/im/api/v1/trendData/delete

マネージャーホスト名：immhost01

{
    "deletelist": [
      {
        "managerhost":"hostB"
        "deleteinfolist": [
          {
            "agenthost":"hostA"
          }
        ]
      },
      {
        "managerhost":"hostD"
        "deleteinfolist": [
          {
            "agenthost":"hostC"
          }
        ]
      }
    ]
}

レスポンス（正常の場合）：

< HTTP/1.1 200 OK
< Content-Type: application/json

レスポンス（警告の場合）：

< HTTP/1.1 200 OK
< Content-Type: application/json
{
    "errdeletelist":[
        {
            "managerhost":"hostB",
            "deleteinfolist": [
                {
                    "agenthost":"hostA"
                }
            ]
        }
    ],
    "errrestartlist":[
        {
            "managerhost":"hostD",
            "deleteinfolist": [
                {
                    "agenthost":"hostC"
                }
            ]
        }
    ],
    "messageList":[
        {
            "messageId":"KAJY62011-W",
            "message":"トレンドデータを削除できないホストが指定されています。(JP1/IM-Managerホスト名 : hostB, 削除対象ホスト名 : hostA)"
        },
        {
            "messageId":"KAJY62013-W",
            "message":"トレンドデータを削除したあとトレンドデータ管理サービスの再起動に失敗しました。(JP1/IM-Managerホスト名 : hostD, 削除対象ホスト名 : hostC)"
        }
    ]
}

ページの先頭へ

5.11.4 トレンドデータ削除

5.11.4　トレンドデータ削除