StartBulkVolumeRead
「 artBulkVolumeRead 」メソッドを使用すると、指定したボリュームの一括ボリューム読み取りセッションを開始できます。
1 つのボリュームで同時に実行できる一括ボリュームプロセスは 2 つだけです。セッションを初期化すると、 SolidFire ストレージボリュームからデータが読み取られ、外部のバックアップソースに保存されます。外部データは、 Element ストレージノードで実行されている Web サーバからアクセスされます。外部データアクセスに関するサーバ操作の情報は、ストレージシステムで実行中のスクリプトによって渡されます。
ボリュームの一括読み取り処理の開始時にボリュームの Snapshot が作成され、読み取りが完了すると削除されます。また、 Snapshot の ID をパラメータとして入力し、ボリュームの Snapshot を読み取ることもできます。以前の Snapshot を読み取った場合、ボリュームの新しい Snapshot は作成されず、読み取りが完了したときに以前の Snapshot も削除されません。
既存の Snapshot の ID を指定しない場合、新しい Snapshot が作成されます。Snapshot を作成できるのは、クラスタフルが「ステージ 2 」または「ステージ 3 」の場合です。クラスタフルが「ステージ 4 」または「ステージ 5 」の場合、 Snapshot は作成されません。 |
パラメータ
このメソッドの入力パラメータは次のとおりです。
名前 | 説明 | を入力します | デフォルト値 | 必須 |
---|---|---|---|---|
の形式で入力し |
ボリュームデータの形式。次のいずれかです。
|
文字列 |
なし |
はい。 |
ボリューム ID |
読み取るボリュームの ID 。 |
整数 |
なし |
はい。 |
Snapshot ID |
ボリュームの一括読み取りで使用する、以前に作成された Snapshot の ID 。ID を入力しない場合は、現在のアクティブボリュームイメージの Snapshot が作成されます。 |
整数 |
なし |
いいえ |
スクリプト |
実行可能スクリプトの名前。スクリプト名を指定しない場合は、 Element ストレージノードにアクセスするためにキーと URL が必要です。スクリプトはプライマリノードに対して実行され、キーと URL がスクリプトに返されます。これにより、ローカル Web サーバにアクセスできるようになります。 |
文字列 |
なし |
いいえ |
scriptParameters |
スクリプトに渡す JSON パラメータ。 |
JSON オブジェクト |
なし |
いいえ |
属性( Attributes ) |
JSONオブジェクト形式の名前と値のペアのリスト。 "詳細はこちら。"。 |
JSON オブジェクト |
なし |
いいえ |
戻り値
このメソッドの戻り値は次のとおりです。
名前 |
説明 |
を入力します |
asyncHandle |
完了を確認する非同期プロセスの ID 。 |
整数 |
キーを押します |
セッションを一意に識別する判読不明なキー。 |
文字列 |
URL |
ノードの Web サーバにアクセスするための URL 。 |
文字列 |
要求例
このメソッドの要求例を次に示します。
{ "method": "StartBulkVolumeRead", "params": { "volumeID" : 5, "format" : "native", "snapshotID" : 2 }, "id": 1 }
応答例
このメソッドの応答例を次に示します。
{ "id" : 1, "result" : { "asyncHandle" : 1, "key" : "11eed8f086539205beeaadd981aad130", "url" : "https://127.0.0.1:44000/" } }
新規導入バージョン
9.6