2.3 サポートするHTTPメソッド
HTTPでは、リソースに対して実行できる操作をメソッドとして定義しています。
REST APIでは、次に示すHTTPメソッドをサポートしています。
|
HTTP メソッド |
説明 |
処理方式 |
|---|---|---|
|
GET |
オブジェクトの情報を取得する。またはオブジェクトのリストを取得する。 例：プールの一覧を取得する。 |
同期 |
|
POST |
オブジェクトを新規に作成する。 例：プールを作成する。 |
非同期 ただし、次のAPIは同期処理で実行されます。
|
|
PUT |
オブジェクトの属性や状態を変更する。 例：プールのしきい値を変更する。 |
非同期 ただし、次のAPIは同期処理で実行されます。
|
|
DELETE |
オブジェクトを削除する。 例：プールを削除する。 |
非同期 ただし、次のAPIは同期処理で実行されます。
|
- ヒント
-
HTTPメソッドがPUTのAPIは、次のメソッドでも実行できます。
- PATCH：オブジェクトの属性や状態を変更する操作（例：プールの設定を変更する。）
- POST：オブジェクトに対して特定のアクションを実行する操作（例：プールを拡張する。）
ストレージシステムのマイクロコードのバージョンが80-05-2X-XX/XX以降のVSP G1000、VSP G1500、VSP F1500で、REST APIサーバとストレージシステム間でSSL通信を利用している場合は、PATCHやPOSTでAPIを実行しても、ジョブオブジェクトやエラーメッセージにはPUTとして実行したものとして結果が返ります。
REST APIの処理方式（同期処理と非同期処理）について説明します。
- 同期処理の場合、処理の実行結果がレスポンスとして返ります。
- 非同期処理の場合、リソースに対する操作はジョブとして登録され、処理を受け付けたことを表すHTTPステータスコード（202）とともにジョブの情報がレスポンスとして返ります。登録されたジョブは、その後、非同期に実行されます。ジョブの登録に失敗した場合はHTTPステータスコード（500）が返ります。
- ヒント
-
- 非同期処理の操作の場合でも、リクエストヘッダでResponse-Job-StatusにCompletedを指定すると、ジョブの実行が完了するまで待ってからレスポンスが返ります。
- ペアの操作では、リクエストヘッダのJob-Mode-Wait-Configuration-Changeを使って、ジョブのステータスがCompletedになるタイミングを指定できます。NoWaitを指定すると、データコピーが完了するまで待たないでジョブのステータスをCompletedにします。