Tuning Manager APIリファレンスガイド

6.4 htmrest

形式
htmrest         <HTTPメソッド> <実行するTuning Manager APIのURI>
                -u | --user <ユーザーID>
                -p | --password <パスワード>
                [ -b | --body <リクエストファイルのパス> ]
                [ --connect-timeout <Tuning Manager APIへ接続する処理のタイムアウト値> ]
                [ --read-timeout <Tuning Manager APIから取得したデータの読み取り処理のタイムアウト値> ]
機能

Device Managerをインストールしているホストから，Tuning Manager APIを使用してアラート機能の運用やパフォーマンスデータの取得などを実行します。実行結果は，標準出力に出力します。

実行権限

権限は必要ありません。

格納先ディレクトリ

Windowsの場合

<Hitachi Command Suiteのインストール先フォルダ>\DeviceManager\HiCommandServer\tools\htmrest\

Linuxの場合

<Hitachi Command Suiteのインストール先ディレクトリ>/HiCommandServer/tools/htmrest/

オプション

htmrestコマンド引数のオプションを次の表に示します。

表6-2 htmrestコマンド引数のオプション

オプション必須
任意
説明

<HTTPメソッド> 必須 HTTPメソッド（GET, POST, PUTまたはDELETE）をどれか1つ指定します。

<実行するTuning Manager APIのURI> 必須実行するAPIのURLを指定します。

-u | --user <ユーザーID> 必須 Hitachi Command SuiteにログインするためのユーザーIDを指定します。

-p | --password <パスワード> 必須 Hitachi Command Suiteにログインするためのパスワードを指定します。

-b | --body <リクエストファイルのパス> POSTおよびPUTメソッドの場合，必須 Tuning Manager APIのリクエストボディに指定したい内容を記載したファイルのパスを指定します。

注意

ファイルの記載内容はJSON形式である必要があります。

ファイルで使用できる文字コードはUTF-8です。

ファイルで使用できる改行コードは次のとおりです。
Windowsの場合：CR+LF
Linuxの場合：LF

絶対パスまたは，コマンドを実行するディレクトリからの相対パスで指定します。

--connect-timeout <Tuning Manager APIへ接続する処理のタイムアウト値> 任意 Tuning Manager APIへ接続する処理のタイムアウト値を秒単位で指定します。指定できる範囲は，0～1000000です。

省略した場合：300秒

0を入力した場合：タイムアウトされない

--read-timeout <Tuning Manager APIから取得したデータの読み取り処理のタイムアウト値> 任意 Tuning Manager APIから取得したデータの読み取り処理のタイムアウト値を秒単位で指定します。指定できる範囲は，0～1000000です。

省略した場合：3,600秒

0を入力した場合：タイムアウトされない

注意事項

このコマンドは，絶対パスでは実行されません。コマンドの格納先まで移動したあと，相対パスで実行してください。

このコマンドは多重実行できます。

コマンドから実行したTuning Manager APIのエラーについては，APIのレスポンスで確認してください。

戻り値

表6-3 htmrestコマンドの戻り値

戻り値意味

0 Tuning Manager API実行時のステータスコードが200～299である

1 オプションで指定した値が不正である

2 オプションで指定したファイルにアクセスできない

3 オプションで指定したファイルが変換できない

4 Tuning Manager APIにアクセスできない

5 メモリーが不足している

50 Tuning Manager API実行時のステータスコードが200～299以外である

99 予期しないエラーが発生した

実行例（アラート定義情報を参照する場合）
htmrest.bat GET http://server_1:22015/DeviceManagerWebService/analytics/v1/objects/alert-defs -u system -p manager
出力例（アラート定義情報を参照する場合）
200
{"data":[{"alertDefName":"AlertVSPG1000_01"},{"alertDefName":"AlertVSPG1000_02"},{"alertDefName":"AlertVSPG1000_03"},{"alertDefName":"AlertUSPV_01"}]}
コマンドの出力結果の1行目にはAPIのステータスコードが，2行目にはAPIのレスポンスボディが出力されます。

オプション	必須任意	説明
`<HTTPメソッド>`	必須	HTTPメソッド（`GET, POST, PUTまたはDELETE`）をどれか1つ指定します。
`<実行するTuning Manager APIのURI>`	必須	実行するAPIのURLを指定します。
`-u \| --user` `<ユーザーID>`	必須	Hitachi Command SuiteにログインするためのユーザーIDを指定します。
`-p \| --password` `<パスワード>`	必須	Hitachi Command Suiteにログインするためのパスワードを指定します。
`-b \| --body` `<リクエストファイルのパス>`	POSTおよびPUTメソッドの場合，必須	Tuning Manager APIのリクエストボディに指定したい内容を記載したファイルのパスを指定します。注意ファイルの記載内容はJSON形式である必要があります。ファイルで使用できる文字コードは`UTF-8`です。ファイルで使用できる改行コードは次のとおりです。 Windowsの場合：`CR+LF` Linuxの場合：`LF` 絶対パスまたは，コマンドを実行するディレクトリからの相対パスで指定します。
`--connect-timeout` `<Tuning Manager APIへ接続する処理のタイムアウト値>`	任意	Tuning Manager APIへ接続する処理のタイムアウト値を秒単位で指定します。指定できる範囲は，`0`～`1000000`です。省略した場合：300秒 `0`を入力した場合：タイムアウトされない
`--read-timeout` `<Tuning Manager APIから取得したデータの読み取り処理のタイムアウト値>`	任意	Tuning Manager APIから取得したデータの読み取り処理のタイムアウト値を秒単位で指定します。指定できる範囲は，`0`～`1000000`です。省略した場合：3,600秒 `0`を入力した場合：タイムアウトされない

戻り値	意味
0	Tuning Manager API実行時のステータスコードが200～299である
1	オプションで指定した値が不正である
2	オプションで指定したファイルにアクセスできない
3	オプションで指定したファイルが変換できない
4	Tuning Manager APIにアクセスできない
5	メモリーが不足している
50	Tuning Manager API実行時のステータスコードが200～299以外である
99	予期しないエラーが発生した

[目次] [前へ] [次へ]

[マニュアル発行元]