Hitachi

Hitachi Command Suite Configuration Manager REST API リファレンスガイド


はじめに

このマニュアルは、Hitachi Configuration Manager REST APIの運用方法について説明したものです。

Hitachi Configuration Manager REST APIは、ストレージシステムの情報取得や構成変更を行うための、REST(Representational State Transfer)の原則に従ったWeb APIを提供します。

〈はじめにの構成〉

■ 対象読者

このマニュアルは、次の方を対象読者として記述しています。
  • 日立製のストレージシステムの運用に関する知識がある方

  • REST APIを利用したプログラムを作成するスキルがある方

■ マニュアルの構成

このマニュアルは、次に示す章と付録から構成されています。
第1章 REST APIの環境構築
REST APIを利用してストレージシステムを運用するために必要な環境構築について説明しています。
第2章 REST APIの共通仕様
REST APIでのリソースの指定方法、リクエストとレスポンスの形式および各オブジェクトについて説明しています。
第3章 REST APIで共通の操作
セッションの生成やジョブの情報取得など、REST APIで共通の操作について説明しています。
第4章 ユーザ管理とアクセス制御
REST API から実行するユーザ管理と、ストレージシステムのリソースに対するアクセス制御の操作について説明しています。
第5章 ストレージシステムの情報検索
REST APIで実行するストレージシステムのリソースの情報検索について説明しています。
第6章 パリティグループの操作
REST APIで実行するパリティグループの操作について説明しています。
第7章 ボリュームの割り当て
REST APIで実行するホストへのボリュームの割り当てについて説明しています。
第8章 プールの管理
REST APIで実行するプールの管理について説明しています。
第9章 I/O性能の最適化
REST APIからホストとストレージシステム間のI/O性能を最適化する操作について説明しています。
第10章 ShadowImageペアの管理
REST APIで実行するShadowImageペアの操作について説明しています。
第11章 Thin Imageペアの管理
Thin Imageペアの操作について説明しています。
第12章 リモートコピーの環境構築
REST APIで実行するリモートコピーの環境構築について説明しています。
第13章 TrueCopyペア/Universal Replicatorペアの管理
TrueCopyペア/Universal Replicatorペアの操作について説明しています。
第14章 global-active deviceペアの管理
global-active deviceペアの操作について説明しています。
第15章 Volume Migrationの操作
REST APIで実行するVolume Migrationの操作について説明しています。
第16章 Universal Volume Managerの操作
REST APIで実行するUniversal Volume Managerの操作について説明しています。
第17章 ストレージシステムの初期設定
REST API で実行するストレージシステムのシステム日時の設定方法、監査ログやSNMPの設定方法、およびストレージシステムのプログラムプロダクトのライセンス管理方法について説明しています。
第18章 データの暗号化
REST APIで実行する、Encryption License Keyを利用したデータ暗号化の操作について説明しています。
第19章 ストレージシステムの監視
ストレージシステムの状態を監視する操作について説明しています。
第20章 仮想ストレージマシンによるリソースの管理
REST APIから実行する、仮想ストレージマシンを使用したリソースの管理について説明しています。
第21章 サンプルコード
サンプルコードについて説明しています。
付録A REST APIサーバの通信モードの変更
REST APIサーバとストレージシステム間の接続方法を変更し、REST APIサーバの通信モードを変更することによって、REST APIの処理速度を向上する方法について説明しています。
付録B バックアップとリストア
REST APIのデータベースおよび環境設定ファイルのバックアップ、リストアについて説明しています。
付録C トラブルシューティング
REST APIサーバで障害が発生した場合の対処方法について説明しています。
付録D ストレージシステムの構成変更の通知
ストレージシステムの構成変更を通知する機能の概要と、その機能を利用してREST APIのデータベースを更新する方法について説明しています。
付録E 付加情報を含む構成情報をストレージシステムのキャッシュから取得する
付加情報を含む構成情報をストレージシステムのキャッシュから取得する操作、ストレージシステムのキャッシュデータを最新に更新する操作について説明しています。
付録F VSP E シリーズVSP G150、G350、G370、G700、G900VSP F350、F370、F700、F900でSVPと連携する場合の構成
VSP E シリーズVSP G150、G350、G370、G700、G900VSP F350、F370、F700、F900で、SVPと連携する場合の構成について説明しています。
付録G マイクロコードのバージョンが80-05-2X-XX/XXより前のVSP G1000VSP G1500VSP F1500を使用したSSL通信
マイクロコードのバージョンが80-05-2X-XX/XXより前のVSP G1000VSP G1500VSP F1500を使用してSSL通信をする場合の通信経路やポートについて説明しています。
付録H Configuration Managerのバージョン
対象製品のバージョン、REST APIのバージョン、およびストレージシステムのマイクロコードのバージョンの対応について説明しています。
付録I リトライ処理の組み込み
REST APIを使用したスクリプトにリトライ処理を実装する上で、考慮すべき点について説明しています。
付録J リクエストラインにsimpleを含むREST APIで実行するQoSグループの操作
リクエストラインにsimpleを含むREST APIを使用したQoSグループの操作について説明しています。
付録K メッセージ
REST APIが出力するメッセージについて説明しています。
付録L このマニュアルの参考情報
このマニュアルを読むに当たっての参考情報を説明しています。

■ マイクロソフト製品の表記について

このマニュアルでは、マイクロソフト製品の名称を次のように表記しています。
表記 製品名

Windows

次の製品を区別する必要がない場合の表記です。

  • Windows® 10
  • Microsoft® Windows Server® 2012
  • Microsoft® Windows Server® 2012 R2
  • Microsoft® Windows Server® 2016
  • Microsoft® Windows Server® 2019

■ 図中で使用している記号

このマニュアルの図中で使用している記号を、次のように定義します。
[図データ]

■ このマニュアルで使用している記号

このマニュアルでは、次に示す記号を使用しています。
表記 製品名

< >

可変値であることを示します。