JavaScript is required to for searching.
ナビゲーションリンクをスキップ
印刷ビューの終了
Oracle® ZFS Storage Appliance RESTful API ガイド、Release 2013.1.3.0
Oracle Technology Network
ライブラリ
PDF
印刷ビュー
フィードバック
search filter icon
search icon

ドキュメント情報

Oracle ZFS Storage Appliance RESTful API の概要

RESTful API の操作

RESTful API 警告サービス

Analytics サービス

ハードウェアサービス

ログのコマンド

ネットワークのコマンド

RESTful API 問題サービス

RESTful API ロールサービス

RESTful API SAN サービス

サービスコマンド

RESTful API ストレージサービス

ストレージプールの操作

プールの一覧表示

プールの取得

プールの構成

プールへのストレージの追加

プールのスクラブ

プールの構成解除

プロジェクトの操作

プロジェクトの一覧表示

プロジェクトのプロパティーの取得

プロジェクトの作成

プロジェクトの変更

プロジェクトの削除

プロジェクトの使用状況

ファイルシステムの操作

ファイルシステムの一覧表示

ファイルシステムの取得

ファイルシステムの作成

ファイルシステムの変更

ファイルシステムの削除

ファイルシステムの割り当て制限および使用状況

LUN 操作

LUN を一覧表示します

LUN の取得

新しい LUN の作成

LUN の変更

LUN の削除

スナップショットおよびクローンの操作

スナップショットの一覧表示

スナップショットの取得

スナップショットの作成

スナップショットの名前変更

スナップショットのクローン作成

スナップショットのロールバック

スナップショットの削除

スナップショット依存の一覧表示

スキーマ

プロパティーの一覧表示

プロパティーの取得

プロパティーの作成

プロパティーの変更

プロパティーの削除

レプリケーション

レプリケーションサービスの取得

レプリケーションサービスの状態の変更

レプリケーションターゲット

レプリケーションターゲットの一覧表示

レプリケーションターゲットの取得

レプリケーションターゲットの作成

レプリケーションターゲットの削除

レプリケーションアクション

レプリケーションアクションの一覧表示

レプリケーションアクションの取得

レプリケーションアクションの作成

レプリケーションアクションの変更

更新の取り消し

更新の送信

レプリケーションアクションの削除

レプリケーションパッケージ

レプリケーションソースの一覧表示

レプリケーションパッケージの一覧表示

パッケージの変更

パッケージの削除

更新の取り消し

パッケージのクローン作成

パッケージの切断

パッケージの逆方向化

システムコマンド

RESTful API ユーザーサービス

ワークフローコマンド

RESTful クライアント

スナップショットおよびクローンの操作

スナップショットの操作はすべて、指定されたプールまたはプロジェクトにスコープ指定されます。スナップショット操作は、ファイルシステムまたは LUN レベルにもスコープ指定できます。

表 12-24  スナップショットおよびクローンのコマンド
リクエスト
パス /api/storage/v1
説明
GET
/snapshots
すべてのローカルスナップショットを一覧表示します
GET
/pools/<pool>/projects /<project>/snapshots
すべてのプロジェクトスナップショットを一覧表示します
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/snapshots
すべてのファイルシステムスナップショットを一覧表示します
GET
/pools/<pool>/projects /<project>/luns/<lun> /snapshots
すべての LUN スナップショットを一覧表示します
GET
/pools/<pool>/projects /<project>/snapshots/<snapshot>
プロジェクトスナップショットの詳細を取得します
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/snapshots /<snapshot>
ファイルシステムスナップショットの詳細を取得します
GET
/pools/<pool>/projects /<project>/luns/<lun> /snapshots/<snapshot>
LUN スナップショットの詳細を取得します
POST
/pools/<pool>/projects /<project>/snapshots
プロジェクトスナップショットを作成します
POST
/pools/<pool>/projects /<project>/filesystems /<filesystem>/snapshots
ファイルシステムスナップショットを作成します
POST
/pools/<pool>/projects /<project>/luns/<lun> /snapshots
LUN スナップショットを作成します
PUT
/pools/<pool>/projects /<project>/snapshots/<snapshot>
プロジェクトスナップショットを変更します
PUT
/pools/<pool>/projects /<project>/filesystems /<filesystem>/snapshots /<snapshot>
ファイルシステムスナップショットを変更します
PUT
/pools/<pool>/projects /<project>/luns/<lun> /snapshots/<snapshot>
LUN スナップショットを変更します
PUT
/pools/<pool>/projects /<project>/filesystems /<filesystem>/snapshots /<snapshot>/clone
ファイルシステムスナップショットをクローン作成します
PUT
/pools/<pool>/projects /<project>/luns/<lun> /snapshots/<snapshot>/clone
LUN スナップショットをクローン作成します
PUT
/pools/<pool>/projects /<project>/filesystems /<filesystem>/snapshots /<snapshot>/rollback
データを指定されたファイルシステムスナップショットにロールバックします
PUT
/pools/<pool>/projects /<project>/lun/<lun> /snapshots/<snapshot>/rollback
データを指定された LUN スナップショットにロールバックします
DELETE
/pools/<pool>/projects /<project>/snapshots/<snapshot>
プロジェクトスナップショットを破棄します
DELETE
/pools/<pool>/projects /<project>/filesystems /<filesystem>/snapshots /<snapshot>
ファイルシステムスナップショットを破棄します
DELETE
/pools/<pool>/projects /<project>/luns/<lun> /snapshots/<snapshot>
LUN スナップショットを破棄します
GET
/pools/<pool>/projects /<project>/snapshots/<snapshot> /dependents
プロジェクトスナップショットの依存を一覧表示します
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/snapshots /<snapshot>/dependents
ファイルシステムスナップショットの依存を一覧表示します
GET
/pools/<pool>/projects /<project>/lun/<lun> /snapshots/<snapshot> /dependents
LUN スナップショットの依存を一覧表示します
POST
/pools/<pool>/projects /<project>/automatic
新しいプロジェクトの自動スナップショットを作成します
GET
/pools/<pool>/projects /<project>/automatic /<automatic>
指定されたプロジェクトの自動スナップショットプロパティーを取得します
GET
/pools/<pool>/projects /<project>/automatic
すべてのプロジェクト自動スナップショットオブジェクトを一覧表示します
PUT
/pools/<pool>/projects /<project>/automatic /<automatic>
指定されたプロジェクトの自動スナップショットオブジェクトを変更します
DELETE
/pools/<pool>/projects /<project>/automatic /<automatic>
指定された自動オブジェクトを破棄します
POST
/pools/<pool>/projects /<project>/filesystems /<filesystem>/automatic
新しいファイルシステムの自動スナップショットを作成します
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/automatic /<automatic>
指定されたファイルシステムの自動スナップショットプロパティーを取得します
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/automatic
すべてのファイルシステムの自動スナップショットオブジェクトを一覧表示します
PUT
/pools/<pool>/projects /<project>/filesystems /<filesystem>/automatic /<automatic>
指定されたファイルシステムの自動スナップショットオブジェクトを変更します
DELETE
/pools/<pool>/projects /<project>/filesystems /<filesystem>/automatic /<automatic>
指定された自動オブジェクトを破棄します
POST
/pools/<pool>/projects /<project>/luns/<lun>/automatic
新しい LUN の自動スナップショットを作成します
GET
/pools/<pool>/projects /<project>/luns/<lun>/automatic /<automatic>
指定された LUN の自動スナップショットプロパティーを取得します
GET
/pools/<pool>/projects /<project>/luns/<lun>/automatic
すべての LUN の自動スナップショットオブジェクトを一覧表示します
PUT
/pools/<pool>/projects /<project>/luns/<lun>/automatic /<automatic>
指定された LUN の自動スナップショットオブジェクトを変更します
DELETE
/pools/<pool>/projects /<project>/luns/<lun>/automatic /<automatic>
指定された自動オブジェクトを破棄します

スナップショットの一覧表示

アプライアンス上の使用可能なスナップショットを一覧表示します。リクエスト URI に応じて、リストにはプロジェクト、ファイルシステム、または LUN のスナップショットが含まれます。

表 12-25  スナップショットの一覧表示コマンドの形式
コマンド
/api/storage/v1/pools/{pool}/projects/{project}
プロジェクトスナップショットの一覧表示
/snapshots
ファイルシステムスナップショットの一覧表示
/filesystems/{share}/snapshots
LUN スナップショットの一覧表示
/lun/{share}/snapshots

リクエストの例:

GET /api/storage/v1/pools/gold/projects/default/snapshots
Accept: application/json

レスポンスの例:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "snapshots": [{
        "id": "3fbbcccf-d058-4502-8844-6feeffdf4cb5",
        "display_name": "snap-001",
        “display_description": "Daily backup",
        "volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
        "status": "available",
        "size": 30,
        "created_at": "2012-02-29T03:50:07Z"
    }, {
        "id": "e479997c-650b-40a4-9dfe-77655818b0d2",
        "display_name": "snap-002",
        "display_description": "Weekly backup",
        "volume_id": "76b8950a-8594-4e5b-8dce-0dfa9c696358",
        "status": "available",
        "size": 25,
        "created_at": "2012-03-19T01:52:47Z"
    }]
}

スナップショットの取得

単一のスナップショットに関するすべての情報を表示します。成功すると、HTTP ステータス 200 (OK) が返されます。

リクエストの例:

GET /api/storage/v1/pools/gold/projects/default/snapshots/snap-001
Accept: application/json

レスポンスの例:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "snapshot": {
        "id": "3fbbcccf-d058-4502-8844-6feeffdf4cb5",
        "display_name": "snap-001",
        "display_description": "Daily backup",
        "volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
        "status": "available",
        "size": 30,
        "created_at": "2012-02-29T03:50:07Z"
    }
}

スナップショットの作成

スナップショットの作成コマンドを実行すると、プロジェクト、ファイルシステム、または LUN のスナップショットが作成されます。

リクエストの例:

POST /api/storage/v1/pools/gold/projects/default/snapshots
Content-Type: application/json

{"name": "initial-backup"}

レスポンスの例:

HTTP/1.1 201 Created
Content-Type: application/json
Location: /pools/gold/projects/default/
snapshot/initial-backup

{
    "snapshot": {
        "name": "initial-backup",
        "numclones": 0,
        "creation": "20130610T21:00:49",
        "collection": "local",
        "project": "default",
        "canonical_name": "gold/local/default@initial-backup",
        "usage": {
            "unique": 0.0,
            "loading": false,
            "data": 145408.0
        },
        "type": "snapshot",
        "id": "a26abd24-e22b-62b2-0000-000000000000",
        "pool": "gold"
    }
}

スナップショットの名前変更

既存のスナップショットの名前を変更します。

リクエストの例:

PUT /api/storage/v1/pools/gold/projects/default/snapshots/initial-snapshot
Content-Type: application/json
Accept: application/json

{“name”:”old-snapshot”}

レスポンスの例:

HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /pools/gold/projects/default/snapshot/initial-backup

スナップショットのクローン作成

既存のスナップショットから新しいファイルシステムまたは LUN を作成します。

ファイルシステムのクローン作成のリクエスト URI:

PUT /pools/{pool}/projects/{project}/filesystems/{share}/snapshots/{snap}/clone

クローンボリューム:

PUT  /pools/{pool}/projects/{project}/luns/{lun}/snapshots/{snapshot}/clone
表 12-26  URI パラメータ
パラメータ
説明
pool
ソースプール名
project
ソースプロジェクト名
filesystem
ソースシェア名 (ファイルシステムスナップショットの場合)
lun
ソースシェア名 (LUN スナップショットの場合)
snapshot
ソーススナップショット名

リクエストの本文には、次のプロパティーを持つ JSON オブジェクトが含まれます。

表 12-27  スナップショットのクローン作成のプロパティー
名前
説明
string
pool
宛先クローンプール名
string
project
宛先クローンプロジェクト名
string
lun
宛先 LUN 名 (LUN スナップショットの場合)

リクエストの例:

PUT /api/storage/v1/pools/gold/projects/default/filesystems/fs01/
    snapshots/snap01/clone

{"project":"rest", "share":"snap01clone01", "compression": "gzip-9"}

レスポンスの例:

HTTP/1.1 201 Created
Content-Length: 2035
X-Zfssa-Storage-Api: 1.0
Location: /api/storage/v1/pools/gold/projects/rest/filesystem/snap01clone01
Content-Type: application/json; charset=utf-8

{
    "filesystem": {
        "origin": {
            "project": "default",
            "share": "fs01",
            "snapshot": "snap01",
            "pool": "gold",
            "collection": "local"
        },
        "href": "/api/storage/v1/pools/gold/projects/rest/filesystems/snap01clone01",
        "mountpoint": "/export/snap01clone01",
        "compression": "gzip-9",
        "source": {
            "compression": "local",
            ...
        },
        ...
       "canonical_name": "gold/local/rest/snap01clone01"
   }
} 

スナップショットのロールバック

スナップショットのロールバックでは、ソースのファイルシステムまたは LUN が、スナップショットが作成されたときの状態に戻されます。応答に成功すると、HTTP ステータス 202 (Accepted) が JSON 形式のスナップショットプロパティーとともに返されます。

ファイルシステムスナップショットのロールバック:

PUT /pools/{pool}/projects/{project}/filesystems/{share}/snapshots/{snap}/rollback

LUN スナップショットのロールバック:

PUT  /pools/{pool}/projects/{project}/luns/{lun}/snapshots/{snapshot}/rollback
表 12-28  URI パラメータ
パラメータ
説明
pool
ソースプール名
project
ソースプロジェクト名
filesystem
ソースファイルシステム名 (ファイルシステムスナップショットの場合)
lun
ソース LUN 名 (LUN スナップショットの場合)
snapshot
ソーススナップショット名

リクエストの例:

PUT /api/storage/v1/pools/gold/projects/default/filesystems/fs-01
    /snapshots/initial-backup/rollback

レスポンスの例:

HTTP/1.1 202 Accepted
Location: /pools/gold/projects/default/filesystems/fs-01/snapshot/fs-01-initial-clone
Content-Type: application/json

{
    "snapshot": {
        "name": "fs-01-initial-clone",
        "numclones": 0,
        "creation": "20130610T21:00:49",
        "filesystem": "fs-01",
        "collection": "local",
        "project": "default",
        "canonical_name": "gold/local/default/
               fs-01@fs-01-initial-clone",
        "usage": {
            "unique": 0.0,
            "loading": false,
            "data": 31744.0
        },
        "type": "snapshot",
        "id": "5c9bda07-21c1-2238-0000-000000000000",
        "pool": "gold"
    }
}

スナップショットの削除

スナップショットの削除コマンドを実行すると、システムからプロジェクト、ファイルシステム、または LUN のスナップショットが削除されます。

リクエストの例:

PUT /pools/gold/projects/default/filesystems/fs-01/
    snapshots/initial-backup HTTP/1.1

削除に成功すると、HTTP ステータス 204 (No Content) が返されます。

HTTP/1.1 204 No-Content

スナップショット依存の一覧表示

ファイルシステムまたはボリュームの依存を一覧表示します。

表 12-29  スナップショット依存の一覧表示コマンドの形式
コマンド
/api/storage/v1/pools/{pool}/projects/{project}
ファイルシステムの依存の一覧表示
/filesystems/{share}/snapshots/{snapshot}/dependents
ボリューム依存の一覧表示
lun/{lun}/snapshots/{snapshot}/dependents
表 12-30  URI パラメータ
パラメータ
説明
pool
システムのストレージプールの名前
project
プロジェクト名
filesystem
ファイルシステム名
lun
LUN の名前

リクエストの例:

GET /apistorage/v1/pools/gold/projects/default/filesystems/fs01/
    snapshots/snap01/dependents
Accept: application/json

レスポンスの例:

HTTP/1.1 200 OK
X-Zfssa-Storage-Api: 1.0
Content-Type: application/json; charset=utf-8
X-Zfssa-Api-Version: 1.0

{
    "dependents": [
        {
            "project": "rest",
            "href": "/api/storage/v1/pools/gold/projects/rest/filesystems/snap01clone01",
            "share": "snap01clone01"
        },
        {
            "project": "rest",
            "href": "/api/storage/v1/pools/gold/projects/rest/filesystems/snap01clone02",
            "share": "snap01clone02"
        },
        {
            "project": "rest",
            "href": "/api/storage/v1/pools/gold/projects/rest/filesystems/snap01clone03",
            "share": "snap01clone03"
        }
    ]
}