キー管理サービス API を使用したルート・キー・バージョンの表示

概要を確認するには、次のエンドポイントに対して GET 呼び出しを行うことによって、 ルート鍵と関連付けられているバージョンをリストできます。

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/{id}/versions

1. サービス内で鍵の処理を行うために、認証資格情報を取得します。

2. 検査するルート鍵の ID を取得します。

   この ID 値を使用して、鍵に関する詳細情報にアクセスします。 サービス・インスタンス内の鍵の ID は、以下の方法で確認できます。 鍵のリストの取得、または UI へのアクセス。

3. 次の cURL コマンドを実行して、ルート鍵に関連付けられているバージョンの リストを取得します。

   curl -X GET \
     'https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/keys/<key_ID>/versions' \
     -H 'accept: application/vnd.ibm.kms.key.version+json' \
     -H 'authorization: Bearer <IAM_token>' \
     -H 'x-kms-key-ring: <key_ring_ID>' \
     -H 'bluemix-instance: <instance_ID>'
   

   次の表に従って、例の要求内の変数を置き換えてください。

   表 1. API を使用して鍵のバージョンをリストするために必要な変数について説明します。

   変数	説明
   region	必須。 Hyper Protect Crypto Services インスタンスが存在する地理的領域を表す地域の省略形 ( us-south や eu-de など)。 詳細については、リージョナル・サービス・エンドポイントを参照してください。
   key_ID	必須。 検査する鍵の固有 ID。
   IAM_token	必須。 IBM Cloud アクセス・トークン。 Bearer 値を含む、IAM トークンの全コンテンツを cURL 要求に組み込みます。 詳細については、アクセス・トークンのリトリーブを参照してください。
   key_ring_ID	オプション。 鍵が属する鍵リングの固有 ID。 指定しないと、Hyper Protect Crypto Services は、指定されたインスタンスに関連付けられているすべての鍵リングで鍵を検索します。 このため、鍵リング ID を指定して、より最適化された要求を行うことをお勧めします。 注: x-kms-key-ring ヘッダーを指定せずに作成した鍵の鍵リング ID は「default」になります。 詳しくは、鍵リングの管理を参照してください。
   instance_ID	必須。 Hyper Protect Crypto Services インスタンスに割り当てられた固有 ID。 詳細については、インスタンス ID のリトリーブを参照してください。

   GET api/v2/keys/<key_ID>/versions 応答が成功すると、ルート・キーに関連付けられているバージョンのリストが返されます。 以下の JSON オブジェクトは、返された値の例を示しています。

   {
     "metadata": {
       "collectionType": "application/vnd.ibm.kms.key.version+json",
       "collectionTotal": 2
     },
     "resources": [
       {
         "id": "02fd6835-6001-4482-a892-13bd2085f75d",
         "creationDate": "2020-03-05T16:39:25Z"
       },
       {
         "id": "12e8c9c2-a162-472d-b7d6-8b9a86b815a6",
         "creationDate": "2020-03-02T16:28:38Z"
       }
     ]
   }
   

   resources オブジェクトに、各鍵のバージョンの ID と作成日が新しいものから順にリストされます