2.1 管理対象のリソースの指定
- objectsドメイン
-
REST APIの操作対象の個々のオブジェクトに対する操作を定義するドメインです。例えば、LDEVやプールなどのストレージシステムのリソースに対する操作が該当します。次に示す形式でURLを指定します。
＜プロトコル＞://＜ホスト名＞:＜ポート番号＞/ConfigurationManager/＜バージョン＞/objects/storages/＜ストレージデバイスID＞
- viewsドメイン
-
REST APIサーバに保持しているストレージシステムの構成情報に対する操作を定義するドメインです。例えば、情報更新や情報検索などが該当します。次に示す形式でURLを指定します。
＜プロトコル＞://＜ホスト名＞:＜ポート番号＞/ConfigurationManager/＜バージョン＞/views
- servicesドメイン
-
REST APIサーバで提供するサービスを定義するドメインです。サービスとは、複数のオブジェクトに対する一括操作や、REST APIサーバの運用や構成変更についての操作を指します。例えば、リソースグループのロックや通信モードの変更などが該当します。次に示す形式でURLを指定します。
＜プロトコル＞://＜ホスト名＞:＜ポート番号＞/ConfigurationManager/＜バージョン＞/＜ストレージデバイスID＞/services
- configurationドメイン
-
REST APIサーバに関する設定を定義するドメインです。例えば、REST APIのバージョン情報の取得が該当します。次に示す形式でURLを指定します。
＜プロトコル＞://＜ホスト名＞:＜ポート番号＞/ConfigurationManager/configuration
このマニュアルでは、「＜プロトコル＞://＜ホスト名＞:＜ポート番号＞/ConfigurationManager」をベースURLと表記します。
-
プロトコルには、httpsまたはhttpを指定します。セキュリティのため、httpsを指定することを推奨します。
-
ホスト名には、管理サーバのIPアドレスまたは名前解決のできるホスト名を指定します。
-
ポート番号には、REST APIサーバとの通信に使用するポート番号を指定します。デフォルトのポート番号は、SSL通信の場合は23451、非SSL通信の場合は23450です。
-
バージョンにはREST APIのバージョンを指定します。現在指定できる値はv1です。
-
ストレージデバイスIDには、「操作対象のストレージシステムの機種ごとの固定値＋6けたのシリアル番号の合計12けた」を指定します。
シリアル番号が6けた未満の場合は、シリアル番号の前に0を指定します。ストレージシステムの機種ごとの固定値を次に示します。
ストレージシステム
固定値
VSP 5100、VSP 5500、VSP 5100H、VSP 5500H
900000※
VSP E590、VSP E790、VSP E590H、VSP E790H
934000
VSP E990
936000
VSP G370、G700、G900、VSP F370、F700、F900
886000
VSP G150、G350、VSP F350
882000
VSP G130
880000
VSP G800、VSP F800
836000
VSP G400、G600、VSP F400、F600
834000
VSP G100、G200
832000
VSP G1000、VSP G1500、VSP F1500
800000※
Virtual Storage Platform
700000※
HUS VM
730000
注※ ストレージシステムのシリアル番号が6けた未満のため、シリアル番号の前に0を指定して合計が12けたになるようにしてください。
-
各ドメインでサポートするURLの形式を次に示します。
objectsドメインの場合：
URLの形式 （ベースURLを除く）
HTTP
メソッド
操作の内容
/v1/objects/storages
GET
ストレージシステムの一覧取得
POST
REST APIで管理するストレージシステムの登録
/v1/objects/storages/＜ストレージデバイスID＞
GET
単一のストレージシステムの情報取得
PUT
単一のストレージシステムに対する属性変更
DELETE
ストレージシステムの管理対象からの削除
/v1/objects/storages/＜ストレージデバイスID＞/＜オブジェクトタイプ＞
GET
複数オブジェクトの一覧取得
POST
新規オブジェクトの作成
/v1/objects/storages/＜ストレージデバイスID＞/＜オブジェクトタイプ＞/＜オブジェクトID＞
GET
単一のオブジェクトの取得
PUT
単一のオブジェクトの属性変更
DELETE
単一のオブジェクトの削除
/v1/objects/storages/＜ストレージデバイスID＞/＜オブジェクトタイプ＞/＜オブジェクトID＞/actions/＜アクション名＞
GET
単一のオブジェクトに対するActionテンプレートの取得
/v1/objects/storages/＜ストレージデバイスID＞/＜オブジェクトタイプ＞/＜オブジェクトID＞/actions/＜アクション名＞/invoke
PUT
単一のオブジェクトに対するアクションの実行
viewsドメインの場合：
URLの形式 （ベースURLを除く）
HTTP
メソッド
操作の内容
/v1/views/＜ビュー名＞
GET
ストレージシステムの単一または関連する複数のリソース情報の検索
/v1/views/actions/＜アクション名＞/invoke
PUT
REST APIサーバが保持しているストレージシステムの構成情報の更新
servicesドメインの場合：
URLの形式 （ベースURLを除く）
HTTP
メソッド
操作の内容
/v1/＜ストレージデバイスID＞/services/＜サービス名＞/actions/＜アクション名＞/invoke
PUT
サービスの特定のアクションの実行
configurationドメインの場合：
URLの形式 （ベースURLを除く）
HTTP
メソッド
操作の内容
configuration/version
GET
REST API のバージョン情報の取得
URLの例を次に示します。
https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/800000012345/ldevs