9.4 管理対象のリソースの指定（URL）
REST APIでは、管理対象のリソースをURLの形式で指定します。
管理対象のリソースを特定するには、次の形式のURLを指定します。
＜プロトコル＞://＜ホスト名＞:＜ポート番号＞/＜アプリケーション＞/＜バージョン＞/＜ドメイン＞
- プロトコル
httpsまたはhttpを指定します。
セキュリティのため、httpsを指定することをお勧めします。
- ホスト名
GUMのIPアドレスまたは名前解決のできるホスト名を指定します。コントローラ1（CTL1）上のGUM、またはコントローラ2（CTL2）上のGUMのどちらかを指定してください。
- ポート番号
接続に使用するポート番号を指定します。
デフォルトのポート番号は、443（SSL通信用）および80（非SSL通信用）です。デフォルトのポート番号で通信する場合は、ポート番号の指定を省略できます。
- アプリケーション
ConfigurationManager/simpleを指定します。
- メモ
-
このドキュメントでは、「＜プロトコル＞://＜ホスト名＞:＜ポート番号＞/ConfigurationManager」をベースURLと表記します。
- バージョン
REST APIのバージョンを指定します。現在指定できる値はv1だけです。
- ドメイン
ドメインを指定します。現在指定できる値はobjectsだけです。
サポートするURLの形式を次に示します。
objectsの配下には、操作対象のオブジェクト種別を指定します。
- command-status
- drives
- health-status
- pools
- ports
- snapshot-groups
- snapshots
- storages
- volumes
オブジェクトタイプcommand-statusのリソース一覧
各オブジェクトタイプでサポートするURLの形式の一覧を次に示します。
|
URLの形式（ベースURLを除く） |
HTTP メソッド |
処理方式 |
操作の内容 |
|---|---|---|---|
/simple/v1/objects/command-status/＜オブジェクトID＞ |
GET |
同期 |
非同期処理のAPIのステータス情報を取得する |
|
DELETE |
同期 |
非同期処理のAPIのステータス情報を削除する |
オブジェクトタイプdrivesのリソース一覧
|
URLの形式（ベースURLを除く） |
HTTP メソッド |
処理方式 |
操作の内容 |
|---|---|---|---|
/simple/v1/objects/drives |
GET |
同期 |
ドライブの情報を取得する |
/simple/v1/objects/drives/actions/set-spare/invoke |
POST |
非同期 |
ドライブをスペアドライブに設定する |
/simple/v1/objects/drives/actions/release-spare/invoke |
POST |
非同期 |
スペアドライブの設定を解除する |
/simple/v1/objects/drives/＜オブジェクトID＞ |
GET |
同期 |
特定のドライブの情報を取得する |
オブジェクトタイプhealth-statusのリソース一覧
|
URLの形式（ベースURLを除く） |
HTTP メソッド |
処理方式 |
操作の内容 |
|---|---|---|---|
/simple/v1/objects/health-status |
GET |
同期 |
ストレージリソースの稼働状態の情報を取得する |
オブジェクトタイプpoolsのリソース一覧
|
URLの形式（ベースURLを除く） |
HTTP メソッド |
処理方式 |
操作の内容 |
|---|---|---|---|
/simple/v1/objects/pools |
GET |
同期 |
プールの情報を取得する |
|
POST |
非同期 |
プールを作成する |
|
/simple/v1/objects/pools/＜オブジェクトID＞ |
GET |
同期 |
特定のプールの情報を取得する |
|
PATCH |
同期 |
プールの設定を変更する |
|
|
DELETE |
非同期 |
プールを削除する |
|
/simple/v1/objects/pools/＜オブジェクトID＞/actions/expand/invoke |
POST |
非同期 |
プールにドライブを追加する |
オブジェクトタイプportsのリソース一覧
|
URLの形式（ベースURLを除く） |
HTTP メソッド |
処理方式 |
操作の内容 |
|---|---|---|---|
/simple/v1/objects/ports |
GET |
同期 |
ポートの情報を取得する |
/simple/v1/objects/ports/＜オブジェクトID＞ |
GET |
同期 |
特定のポートの情報を取得する |
|
PATCH |
同期 |
ポートの設定を変更する |
オブジェクトタイプsnapshot-groupsのリソース一覧
|
URLの形式（ベースURLを除く） |
HTTP メソッド |
処理方式 |
操作の内容 |
|---|---|---|---|
/simple/v1/objects/snapshot-groups |
GET |
同期 |
スナップショットグループ名の一覧を取得する |
/simple/v1/objects/snapshot-groups/＜オブジェクトID＞ |
GET |
同期 |
特定のスナップショットグループの情報を取得する |
|
DELETE |
非同期 |
スナップショットグループを削除する |
オブジェクトタイプsnapshotsのリソース一覧
|
URLの形式（ベースURLを除く） |
HTTP メソッド |
処理方式 |
操作の内容 |
|---|---|---|---|
/simple/v1/objects/snapshots |
GET |
同期 |
スナップショットの情報を取得する |
|
POST |
非同期 |
スナップショットを作成する |
|
/simple/v1/objects/snapshots/＜オブジェクトID＞ |
GET |
同期 |
特定のスナップショットの情報を取得する |
|
DELETE |
非同期 |
スナップショットを削除する |
|
/simple/v1/objects/snapshots/＜オブジェクトID＞/actions/map/invoke |
POST |
非同期 |
スナップショットをマッピングする |
/simple/v1/objects/snapshots/＜オブジェクトID＞/actions/restore/invoke |
POST |
非同期 |
スナップショットをリストアする |
オブジェクトタイプstoragesのリソース一覧
|
URLの形式（ベースURLを除く） |
HTTP メソッド |
処理方式 |
操作の内容 |
|---|---|---|---|
/simple/v1/objects/storages |
GET |
同期 |
ストレージシステムの情報を取得する |
オブジェクトタイプvolumesのリソース一覧
|
URLの形式（ベースURLを除く） |
HTTP メソッド |
処理方式 |
操作の内容 |
|---|---|---|---|
/simple/v1/objects/volumes |
GET |
同期 |
ボリュームの情報を取得する |
|
POST |
非同期 |
ボリュームを作成する |
|
/simple/v1/objects/volumes/＜オブジェクトID＞ |
GET |
同期 |
特定のボリュームの情報を取得する |
|
PATCH |
|
ボリュームの設定を変更する |
|
|
DELETE |
非同期 |
ボリュームを削除する |
|
/simple/v1/objects/volumes/＜オブジェクトID＞/actions/expand/invoke |
POST |
同期 |
ボリュームの容量を拡張する |
REST APIの処理方式には、次に示す2つの処理方式があります。
- 同期処理
処理の実行結果がレスポンスとして返ります。
- 非同期処理
処理を受け付けたことを表すHTTPステータスコード（202）とともにオブジェクトの情報がレスポンスとして返ります。
- メモ
-
複数のリクエストを同時に実行できるのは16個までです。