Hitachi

Hitachi Command Suite Configuration Manager REST API リファレンスガイド


18.10 暗号化鍵をバックアップする

暗号化鍵をREST APIクライアント上のファイルにバックアップします。このAPIのリクエストヘッダのAcceptにはapplication/octet-streamを指定してください。
メモ
  • 暗号化鍵を作成したら、必ずバックアップしてください。また、暗号化鍵は定期的にバックアップすることをお勧めします。
  • REST API を実行するユーザが、対象ストレージシステムのリソースをREST API でロックしている場合、このAPIは実行できません。その場合は、ロックを解除してから実行してください。

実行権限

セキュリティ管理者(参照・編集)

リクエストヘッダ

このAPIでは、REST APIクライアント上に暗号化鍵のファイルをダウンロードします。リクエストヘッダのAcceptにはapplication/octet-streamを指定してください。

リクエストライン

PUT <ベースURL>/v1/objects/storages/<ストレージデバイスID>/encryption-keys/file/actions/backup/invoke

このAPIはPOSTメソッドでも実行できます。

リクエストメッセージ

オブジェクトID

fileを指定します。

fileは、暗号化鍵をファイルにバックアップしたりリストアしたりする場合に、オブジェクトIDとして指定する固定の値です。

クエリパラメータ

なし。

ボディ
{
    "parameters": {
        "password": "backuppassword"
    }
}

属性

説明

password

string

(必須)パスワード

6~255文字の文字列を指定します。

次の文字が使用できます。

  • 半角英数字
  • ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

このパスワードは暗号化鍵をリストアするときに必要です。

レスポンスヘッダ

次のレスポンスヘッダを返します。

ヘッダ

説明

Content-Disposition

attachment

Content-Length

バックアップデータのサイズ(単位:バイト)

Content-type

application/octet-stream

レスポンスメッセージ

ボディ
なし。

Actionテンプレート

なし。

ステータスコード

この操作のリクエストに対するステータスコードの意味を次に示します。そのほかのステータスコードについては、HTTPステータスコードの説明を参照してください。

ステータスコード

メッセージ

説明

412

Precondition Failed

ストレージシステムのマイクロコードのバージョンは、この操作をサポートしていません。

コード例

curl -v -H "Accept:application/octet-stream" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X PUT --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/886000123457/encryption-keys/file/actions/backup/invoke -o "backupfile.ekf"