18.6　暗号化鍵の一覧を取得する

実行権限

セキュリティ管理者（参照）

リクエストライン

GET ＜ベースURL＞/v1/objects/storages/＜ストレージデバイスID＞/encryption-keys

リクエストメッセージ

オブジェクトID

なし。

クエリパラメータ

パラメータ	型	フィルタ条件
keyType	string	（必須）取得する鍵の種別 DEK CEK KEK FREE DEKANDFREE（DEKとFREE） このパラメータにDEK、FREEまたはDEKANDFREEを指定した場合、ほかのパラメータと組み合わせて指定できます。
startKeyId	int	（任意）取得を開始する鍵のID 0～4095の値を指定します。 このパラメータは、keyTypeパラメータにDEK、FREEまたはDEKANDFREEを指定した場合だけ有効です。 省略した場合、0が指定されたと見なされます。
count	int	（任意）取得する鍵の個数 1～1024の値を指定します。 このパラメータは、keyTypeパラメータにDEK、FREEまたはDEKANDFREEを指定した場合だけ有効です。 省略した場合、1024が指定されたと見なされます。
startCreatedTime	ISO8601string	（任意）指定した日時以降に作成された鍵を取得します。 YYYY-MM-DDThh:mm:ssZ形式で指定します。 endCreatedTimeパラメータと同時に指定する場合は、endCreatedTimeより小さい値または同じ値を指定してください。 このパラメータは、keyTypeパラメータにDEK、FREEまたはDEKANDFREEを指定した場合だけ有効です。
endCreatedTime	ISO8601string	（任意）指定した日時以前の鍵を取得 YYYY-MM-DDThh:mm:ssZ形式で指定します。 startCreatedTimeパラメータと同時に指定する場合は、startCreatedTimeより大きい値または同じ値を指定してください。 このパラメータは、keyTypeパラメータにDEK、FREEまたはDEKANDFREEを指定した場合だけ有効です。

ボディ

なし。

レスポンスメッセージ

ボディ

{
    "data": [
        {
            "keyId": "6",
            "createdTime": "2018-10-29T04:32:26Z",
            "keyType": "DEK",
            "uuid": "-",
            "targetDeviceLocation": "HDD00-08",
            "keyGeneratedLocation": "DKC",
            "numOfBackups": 4
        },
        {
            "keyId": "7",
            "createdTime": "2018-10-29T04:32:26Z",
            "keyType": "DEK",
            "uuid": "-",
            "targetDeviceLocation": "HDD00-09",
            "keyGeneratedLocation": "DKC",
            "numOfBackups": 4
        }
    ]
}

属性	型	説明
keyId	string	鍵のID keyType属性がCEKまたはKEKの場合は、-（ハイフン）が出力されます。
createdTime	ISO8601string	鍵の作成日時 keyType属性がKEK、かつkeyGeneratedLocation属性がDKCの場合は、-（ハイフン）が出力されます。
keyType	string	鍵の種別 DEK：暗号化鍵 格納したデータを暗号化するための鍵です。 CEK：認証用鍵 証明書を暗号化するための鍵です。DEKがDKBに格納される際にも使われます。 KEK：鍵暗号化鍵 CEK、DEK、およびFREEを暗号化するための鍵です。ストレージシステムに1つだけ存在します。 FREE：暗号化鍵の割り当て前の未使用の鍵
uuid	string	鍵のUUID keyType属性がKEK以外の場合、またはkeyType属性がKEK、かつ鍵管理サーバと連携していない場合は、-（ハイフン）が出力されます。
targetDeviceLocation	string	鍵の割り当て先 ドライブのロケーション番号（DEKの場合） コントローラのロケーション番号（CEKの場合） -（ハイフン）（KEKまたはFREEの場合）
keyGeneratedLocation	string	鍵の作成場所 DKC：ストレージシステム KMS：鍵管理サーバ
numOfBackups	int	鍵のバックアップ回数 keyType属性がKEKの場合は、無効な値を示す-1が出力されます。

ステータスコード

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

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/886000123457/encryption-keys?keyType=DEK