GETメソッド

〈このページの構成〉

説明

次の表のリクエストを受け付けるとスナップショットログを収集し，レスポンスとして出力します。

表23‒1　スナップショットログ収集REST APIが収集処理を実行するリクエスト
項目	値
Method	GET
URL	/api/v1/snapshot
パラメタ	「表23-2　スナップショットログ収集REST APIのパラメタ」に示すパラメタと値

http://<IPアドレス>:<ポート番号>/api/v1/snapshot

<IPアドレス>にはプロセスモニタを起動させているマシンのIPアドレスを指定してください。<ポート番号>には，プロセスモニタのHTTP機能の受付ポート番号（monitor.rest.portの値の指定値）と同じ値を指定してください。

monitor.rest.portについては，「18.2.4(2)　プロセスモニタに関するプロパティ」を参照してください。

スナップショットログ収集REST APIのパラメタを次の表に示します。

表23‒2　スナップショットログ収集REST APIのパラメタ
パラメタ	指定できる値	省略の可否	デフォルト値	説明
threaddumpnum	0〜60	省略可	<snapshot.rest.default.threaddumpnum^※の指定値>	スレッドダンプ情報を取得する回数を指定します。取得するとモニタ対象プロセスに負荷が掛かります。スレッドダンプ情報については，「17.3.2(1)(b)　スレッドダンプ情報」を参照してください。
watchcommand	次のどちらかを指定します。 true false	省略可	<snapshot.rest.default.watchcommand.enabled^※の指定値>	モニタリング情報を取得するかどうかを指定します。取得すると所要時間が長くなります。モニタリング情報については，「17.3.2(1)(a)　モニタリング情報」を参照してください。

注※: config.properties（本製品の設定ファイル）のプロパティです。詳細は，「18.2.4(4)　スナップショットログ収集機能に関するプロパティ」を参照してください。

リクエストの例を次に示します。ただし，「http://<IPアドレス>:<ポート番号>」部分は省略して記載します。

オプションを指定して収集

/api/v1/snapshot?threaddumpnum=3&watchcommand=true

スナップショットログの収集に成功した場合，レスポンスボディに出力されるスナップショットログ（zip形式）を次の表に示します。

スナップショットログの収集に失敗した場合に出力されるエラーメッセージ（JSON形式）を次の表に示します。