Hitachi Command Suite

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

3021-9-042-E0


目次

前書き

はじめに
対象読者
マニュアルの構成
マイクロソフト製品の表記について
読書手順
このマニュアルで使用している記号
ストレージシステムのサポート終了について
OS,仮想化ソフトウェア,ブラウザーなどのサポートについて

1. Tuning Manager APIの概要
1.1 Tuning Manager APIの概要
1.2 http(s)経由で取得できる情報
1.3 http(s)経由で更新できる情報
1.4 APIで監視対象のしきい値情報にアクセスできる条件
1.5 APIでパフォーマンスデータにアクセスできる条件
1.6 Tuning Manager APIの最大リクエスト数
1.7 Tuning Manager APIを利用するために必要なインストールとセットアップの流れ
1.7.1 インストールとセットアップの流れ(非クラスタシステムでHTM - Agentsを運用する場合)
1.7.2 インストールとセットアップの流れ(クラスタシステムでHTM - Agentsを運用する場合)

2. Tuning Manager APIの仕様
2.1 Tuning Manager APIの共通仕様
2.2 サポートしているHTTPメソッド
2.3 リクエストメッセージ
2.3.1 リクエストライン
2.3.2 ヘッダー
2.4 セキュリティと認証
2.5 圧縮転送
2.6 Tuning Manager APIのバージョン
2.7 共通オブジェクト
2.7.1 Collectionオブジェクト
2.7.2 Errorオブジェクト
2.7.3 Actionオブジェクト
2.7.4 PrimitiveValueオブジェクト
2.8 ステータスコード

3. アラート機能のAPI
3.1 Tuning Manager APIのリソース一覧
3.2 アラート定義情報の追加
3.3 アラート定義情報の削除
3.4 アラート定義情報の参照
3.5 アラート定義情報の同期実行時のパラメータの取得
3.6 アラート定義情報の同期
3.7 HTM - Agents情報更新時のパラメーターの取得
3.8 HTM - Agents情報の更新
3.9 HTM - Agents情報取得時のパラメーターの取得
3.10 HTM - Agents情報の取得
3.11 アラート定義情報設定時のオブジェクト
3.11.1 アラート定義情報設定時の注意事項
3.11.2 アラート定義型
3.11.3 target型
3.11.4 notice型
3.11.5 trigger型
3.11.6 definition型

4. パフォーマンスデータを取得するためのAPI
4.1 Tuning Manager APIのリソース一覧
4.2 HTM - Agents一覧の手動リフレッシュ処理実行時のパラメーターの取得
4.3 HTM - Agents一覧の手動リフレッシュ処理の実行
4.4 HTM - Agentsのインスタンス一覧の取得
4.5 HTM - Agent for RAIDのインスタンス一覧の取得
4.6 パフォーマンスデータの取得

5. その他のTuning Manager API
5.1 Tuning Manager APIのリソース一覧
5.2 アラート定義情報の設定および運用のアクション一覧取得
5.3 HTM - Agents管理のアクション一覧の取得(アラート機能の場合)
5.4 HTM - Agents管理のアクション一覧の取得(パフォーマンスデータの取得の場合)
5.5 APIの詳細バージョンの情報取得(アラート機能の場合)
5.6 APIの詳細バージョンの情報取得(パフォーマンスデータの取得の場合)
5.7 メタ情報取得(パフォーマンスデータの取得の場合)

6. Tuning Manager APIを実行するコマンド
6.1 コマンドの使用法
6.2 コマンド実行に必要な設定
6.2.1 Java環境の設定
6.2.2 SSLの設定
6.3 コマンド実行の前提条件
6.4 htmrest

7. APIのメッセージ
7.1 メッセージの形式
7.1.1 メッセージの出力形式
7.1.2 メッセージの記載形式
7.2 メッセージの出力先一覧
7.3 メッセージ一覧

付録A. Tuning Manager APIの使用方法
A.1 アラート機能を設定・運用する流れ
A.2 アラート定義情報の作成手順
A.3 LDEV性能のTop5のチャートを作成する手順

付録B. アラート定義情報のサンプル
B.1 監視対象がストレージシステムの場合
B.2 監視対象がNAS Platformの場合

付録C. Performanceデータベースによる仕様差異(パフォーマンスデータを取得する場合)
C.1 使用するPerformanceデータベースによる仕様差異(HTM - Agent for RAIDの場合)

付録D. このマニュアルの参考情報
D.1 関連マニュアル
D.2 このマニュアルでの表記
D.3 このマニュアルで使用している略語

索引

[マニュアル発行元]

All Rights Reserved. Copyright© 2014, 2020, Hitachi, Ltd.